Tools forAppStream を使用した PowerShell2.0 の例 - AWS SDKコードの例
アクション

Doc AWS SDK ExamplesWord リポジトリには、さらに多くの GitHub の例があります。 AWS SDK

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Tools forAppStream を使用した PowerShell2.0 の例

次のコード例は、 AppStream 2.0 AWS Tools for PowerShell で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には、完全なソースコードへのリンクが含まれています。このリンクでは、コンテキストでコードを設定および実行する手順を確認できます。

トピック

アクション

次のコード例は、Add-APSResourceTag を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルでは、リソースタグを AppStream リソースに追加します。

Add-APSResourceTag -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest -Tag @{StackState='Test'} -Select ^Tag

出力:

Name                           Value
----                           -----
StackState                     Test

  • API の詳細については、「コマンドレットリファレンス」のTagResource」を参照してください。 AWS Tools for PowerShell

次のコード例は、Copy-APSImage を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルは、イメージを他のリージョンにコピーします。

Copy-APSImage -DestinationImageName TestImageCopy -DestinationRegion us-west-2 -SourceImageName Powershell

出力:

TestImageCopy

  • APIの詳細については、「コマンドレットリファレンス」のCopyImage」を参照してください。 AWS Tools for PowerShell

次の例は、Disable-APSUSer を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは USERPOOL のユーザーを無効にします

Disable-APSUser -AuthenticationType USERPOOL -UserName TestUser@lab.com

  • APIの詳細については、AWS Tools for PowerShell 「コマンドレットリファレンス」のDisableUser」を参照してください。

次のコード例は、Enable-APSUser を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルでは、USERPOOL で無効なユーザーを有効にします

Enable-APSUser -AuthenticationType USERPOOL -UserName TestUser@lab.com

  • APIの詳細については、AWS Tools for PowerShell 「コマンドレットリファレンス」のEnableUser」を参照してください。

次のコード例は、Get-APSAssociatedFleetList を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルは、スタックに関連付けられたフリートを表示します。

Get-APSAssociatedFleetList -StackName PowershellStack

出力:

PowershellFleet

  • APIの詳細については、AWS Tools for PowerShell 「コマンドレットリファレンス」のListAssociatedFleets」を参照してください。

次の例は、Get-APSAssociatedStackList を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは、フリートに関連付けられたスタックを表示します。

Get-APSAssociatedStackList -FleetName PowershellFleet

出力:

PowershellStack

  • APIの詳細については、「コマンドレットリファレンス」のListAssociatedStacks」を参照してください。 AWS Tools for PowerShell

次のコード例は、Get-APSDirectoryConfigList を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルは、 AppStream で作成されたディレクトリ設定を表示します

Get-APSDirectoryConfigList | Select DirectoryName, OrganizationalUnitDistinguishedNames, CreatedTime

出力:

DirectoryName OrganizationalUnitDistinguishedNames CreatedTime
------------- ------------------------------------ -----------
Test.com      {OU=AppStream,DC=Test,DC=com}    9/6/2019 10:56:40 AM
contoso.com   {OU=AppStream,OU=contoso,DC=contoso,DC=com}  8/9/2019 9:08:50 AM

  • APIの詳細については、「コマンドレットリファレンス」のDescribeDirectoryConfigs」を参照してください。 AWS Tools for PowerShell

次の例は、Get-APSFleetList を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルはフリートの詳細を表示します

Get-APSFleetList -Name Test

出力:

Arn                            : arn:aws:appstream:us-east-1:1234567890:fleet/Test
ComputeCapacityStatus          : Amazon.AppStream.Model.ComputeCapacityStatus
CreatedTime                    : 9/12/2019 5:00:45 PM
Description                    : Test
DisconnectTimeoutInSeconds     : 900
DisplayName                    : Test
DomainJoinInfo                 :
EnableDefaultInternetAccess    : False
FleetErrors                    : {}
FleetType                      : ON_DEMAND
IamRoleArn                     :
IdleDisconnectTimeoutInSeconds : 900
ImageArn                       : arn:aws:appstream:us-east-1:1234567890:image/Test
ImageName                      : Test
InstanceType                   : stream.standard.medium
MaxUserDurationInSeconds       : 57600
Name                           : Test
State                          : STOPPED
VpcConfig                      : Amazon.AppStream.Model.VpcConfig

  • API の詳細については、AWS Tools for PowerShell 「コマンドレットリファレンス」のDescribeFleets」を参照してください。

次のコード例は、Get-APSImageBuilderList を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルは、 ImageBuilder の詳細を表示します。

Get-APSImageBuilderList -Name TestImage

出力:

AccessEndpoints             : {}
AppstreamAgentVersion       : 06-19-2019
Arn                         : arn:aws:appstream:us-east-1:1234567890:image-builder/TestImage
CreatedTime                 : 1/14/2019 4:33:05 AM
Description                 :
DisplayName                 : TestImage
DomainJoinInfo              :
EnableDefaultInternetAccess : False
IamRoleArn                  :
ImageArn                    : arn:aws:appstream:us-east-1::image/Base-Image-Builder-05-02-2018
ImageBuilderErrors          : {}
InstanceType                : stream.standard.large
Name                        : TestImage
NetworkAccessConfiguration  : Amazon.AppStream.Model.NetworkAccessConfiguration
Platform                    : WINDOWS
State                       : STOPPED
StateChangeReason           :
VpcConfig                   : Amazon.AppStream.Model.VpcConfig

  • API の詳細については、「コマンドレットリファレンス」のDescribeImageBuilders」を参照してください。 AWS Tools for PowerShell

次のコード例は、Get-APSImageList を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルは private AppStream イメージを表示します

Get-APSImageList -Type PRIVATE | select DisplayName, ImageBuilderName, Visibility, arn

出力:

DisplayName          ImageBuilderName      Visibility Arn
-----------          ----------------      ---------- ---
OfficeApps           OfficeApps            PRIVATE    arn:aws:appstream:us-east-1:123456789012:image/OfficeApps
SessionScriptV2      SessionScriptTest     PRIVATE    arn:aws:appstream:us-east-1:123456789012:image/SessionScriptV2

  • APIの詳細については、「コマンドレットリファレンス」のDescribeImages」を参照してください。 AWS Tools for PowerShell

次の例は、Get-APSImagePermission を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは、共有 AppStream イメージに対するイメージアクセス許可を表示します。

Get-APSImagePermission -Name Powershell  | select SharedAccountId, @{n="AllowFleet";e={$_.ImagePermissions.AllowFleet}}, @{n="AllowImageBuilder";e={$_.ImagePermissions.AllowImageBuilder}}

出力:

SharedAccountId AllowFleet AllowImageBuilder
--------------- ---------- -----------------
123456789012          True              True

  • API の詳細については、AWS Tools for PowerShell 「コマンドレットリファレンス」のDescribeImagePermissions」を参照してください。

次の例は、Get-APSSessionList を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは、フリートへのセッションのリストを表示します。

Get-APSSessionList -FleetName PowershellFleet -StackName PowershellStack

出力:

AuthenticationType         : API
ConnectionState            : CONNECTED
FleetName                  : PowershellFleet
Id                         : d8987c70-4394-4324-a396-2d485c26f2a2
MaxExpirationTime          : 12/27/2019 4:54:07 AM
NetworkAccessConfiguration : Amazon.AppStream.Model.NetworkAccessConfiguration
StackName                  : PowershellStack
StartTime                  : 12/26/2019 12:54:12 PM
State                      : ACTIVE
UserId                     : Test

  • API の詳細については、「コマンドレットリファレンス」のDescribeSessions」を参照してください。 AWS Tools for PowerShell

次の例は、Get-APSStackList を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは AppStream スタックのリストを表示します

Get-APSStackList | Select DisplayName, Arn, CreatedTime

出力:

DisplayName                   Arn                                                                          CreatedTime
-----------                   ---                                                                          -----------
PowershellStack               arn:aws:appstream:us-east-1:123456789012:stack/PowershellStack               4/24/2019 8:49:29 AM
SessionScriptTest             arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest             9/12/2019 3:23:12 PM

  • API の詳細については、AWS Tools for PowerShell 「コマンドレットリファレンス」のDescribeStacks」を参照してください。

次のコード例は、Get-APSTagsForResourceList を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルは、 AppStream リソースのタグを表示します

Get-APSTagsForResourceList -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest

出力:

Key        Value
---        -----
StackState Test

  • API の詳細については、「コマンドレットリファレンス」のListTagsForResource」を参照してください。 AWS Tools for PowerShell

次の例は、Get-APSUsageReportSubscription を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは、 AppStreamUsageReport 設定の詳細を表示します

Get-APSUsageReportSubscription

出力:

LastGeneratedReportDate S3BucketName                                   Schedule SubscriptionErrors
----------------------- ------------                                   -------- ------------------
1/1/0001 12:00:00 AM    appstream-logs-us-east-1-123456789012-sik1hnxe DAILY    {}

  • API の詳細については、「コマンドレットリファレンス」のDescribeUsageReportSubscriptions」を参照してください。 AWS Tools for PowerShell

次の例は、Get-APSUser を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは、ステータスが有効なユーザーのリストを表示します。

Get-APSUser -AuthenticationType USERPOOL | Select-Object UserName, AuthenticationType, Enabled

出力:

UserName                   AuthenticationType Enabled
--------                   ------------------ -------
foo1@contoso.com USERPOOL              True
foo2@contoso.com        USERPOOL              True
foo3@contoso.com    USERPOOL              True
foo4@contoso.com   USERPOOL              True
foo5@contoso.com         USERPOOL              True

  • API の詳細については、「コマンドレットリファレンス」のDescribeUsers」を参照してください。 AWS Tools for PowerShell

次のコード例は、Get-APSUserStackAssociation を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルは、スタックに割り当てられたユーザーのリストを表示します。

Get-APSUserStackAssociation -StackName PowershellStack

出力:

AuthenticationType SendEmailNotification StackName       UserName
------------------ --------------------- ---------       --------
USERPOOL           False                 PowershellStack TestUser1@lab.com
USERPOOL           False                 PowershellStack TestUser2@lab.com

  • API の詳細については、「コマンドレットリファレンス」のDescribeUserStackAssociations」を参照してください。 AWS Tools for PowerShell

次のコード例は、New-APSDirectoryConfig を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルは、 AppStream でディレクトリ設定を作成します

New-APSDirectoryConfig -ServiceAccountCredentials_AccountName contoso\ServiceAccount -ServiceAccountCredentials_AccountPassword MyPass -DirectoryName contoso.com -OrganizationalUnitDistinguishedName "OU=AppStream,OU=Contoso,DC=Contoso,DC=com"

出力:

CreatedTime            DirectoryName OrganizationalUnitDistinguishedNames        ServiceAccountCredentials
-----------            ------------- ------------------------------------        -------------------------
12/27/2019 11:00:30 AM contoso.com   {OU=AppStream,OU=Contoso,DC=Contoso,DC=com} Amazon.AppStream.Model.ServiceAccountCredentials

  • APIの詳細については、「コマンドレットリファレンス」のCreateDirectoryConfig」を参照してください。 AWS Tools for PowerShell

次の例は、New-APSFleet を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは新しい AppStream フリートを作成します

New-APSFleet -ComputeCapacity_DesiredInstance 1 -InstanceType stream.standard.medium -Name TestFleet -DisplayName TestFleet -FleetType ON_DEMAND -EnableDefaultInternetAccess $True -VpcConfig_SubnetIds "subnet-123ce32","subnet-a1234cfd" -VpcConfig_SecurityGroupIds sg-4d012a34 -ImageName SessionScriptTest -Region us-west-2

出力:

Arn                            : arn:aws:appstream:us-west-2:123456789012:fleet/TestFleet
ComputeCapacityStatus          : Amazon.AppStream.Model.ComputeCapacityStatus
CreatedTime                    : 12/27/2019 11:24:42 AM
Description                    :
DisconnectTimeoutInSeconds     : 900
DisplayName                    : TestFleet
DomainJoinInfo                 :
EnableDefaultInternetAccess    : True
FleetErrors                    : {}
FleetType                      : ON_DEMAND
IamRoleArn                     :
IdleDisconnectTimeoutInSeconds : 0
ImageArn                       : arn:aws:appstream:us-west-2:123456789012:image/SessionScriptTest
ImageName                      : SessionScriptTest
InstanceType                   : stream.standard.medium
MaxUserDurationInSeconds       : 57600
Name                           : TestFleet
State                          : STOPPED
VpcConfig                      : Amazon.AppStream.Model.VpcConfig

  • API の詳細については、AWS Tools for PowerShell 「コマンドレットリファレンス」のCreateFleet」を参照してください。

次のコード例は、New-APSImageBuilder を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルは Image Builder in AppStream を作成します

New-APSImageBuilder -InstanceType stream.standard.medium -Name TestIB -DisplayName TestIB -ImageName AppStream-WinServer2012R2-12-12-2019 -EnableDefaultInternetAccess $True -VpcConfig_SubnetId subnet-a1234cfd -VpcConfig_SecurityGroupIds sg-2d012a34 -Region us-west-2

出力:

AccessEndpoints             : {}
AppstreamAgentVersion       : 12-16-2019
Arn                         : arn:aws:appstream:us-west-2:123456789012:image-builder/TestIB
CreatedTime                 : 12/27/2019 11:39:24 AM
Description                 :
DisplayName                 : TestIB
DomainJoinInfo              :
EnableDefaultInternetAccess : True
IamRoleArn                  :
ImageArn                    : arn:aws:appstream:us-west-2::image/AppStream-WinServer2012R2-12-12-2019
ImageBuilderErrors          : {}
InstanceType                : stream.standard.medium
Name                        : TestIB
NetworkAccessConfiguration  :
Platform                    : WINDOWS
State                       : PENDING
StateChangeReason           :
VpcConfig                   : Amazon.AppStream.Model.VpcConfig

  • APIの詳細については、「コマンドレットリファレンス」のCreateImageBuilder」を参照してください。 AWS Tools for PowerShell

次のコード例は、New-APSImageBuilderStreamingURL を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルは、有効期間 2 時間の ImageBuilder ストリーミング URL を作成します。

New-APSImageBuilderStreamingURL -Name TestIB -Validity 7200 -Region us-west-2

出力:

Expires               StreamingURL
-------               ------------
12/27/2019 1:49:13 PM https://appstream2.us-west-2.aws.amazon.com/authenticate?parameters=eyJ0eXBlIjoiQURNSU4iLCJleHBpcmVzIjoiMTU3NzQ1NDU1MyIsImF3c0FjY291bnRJZCI6IjM5MzQwMzgxMTQwNyIsInVzZXJJZCI6ImFkbWluIiwiY2F

  • API の詳細については、「コマンドレットリファレンス」のCreateImageBuilderStreamingURL」を参照してください。 AWS Tools for PowerShell

次の例は、New-APSStack を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは新しい AppStream スタックを作成します

New-APSStack -Name TestStack -DisplayName TestStack -ApplicationSettings_Enabled $True -ApplicationSettings_SettingsGroup TestStack -Region us-west-2

出力:

AccessEndpoints     : {}
ApplicationSettings : Amazon.AppStream.Model.ApplicationSettingsResponse
Arn                 : arn:aws:appstream:us-west-2:123456789012:stack/TestStack
CreatedTime         : 12/27/2019 12:34:19 PM
Description         :
DisplayName         : TestStack
EmbedHostDomains    : {}
FeedbackURL         :
Name                : TestStack
RedirectURL         :
StackErrors         : {}
StorageConnectors   : {}
UserSettings        : {Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting}

  • API の詳細については、「コマンドレットリファレンス」のCreateStack」を参照してください。 AWS Tools for PowerShell

次の例は、New-APSStreamingURL を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは URL of Stack のストリーミングを作成します

New-APSStreamingURL -StackName SessionScriptTest -FleetName SessionScriptNew -UserId TestUser

出力:

Expires                StreamingURL
-------                ------------
12/27/2019 12:43:37 PM https://appstream2.us-east-1.aws.amazon.com/authenticate?parameters=eyJ0eXBlIjoiRU5EX1VTRVIiLCJleHBpcmVzIjoiMTU3NzQ1MDYxNyIsImF3c0FjY291bnRJZCI6IjM5MzQwMzgxMTQwNyIsInVzZXJJZCI6IlRlc3RVc2

  • API の詳細については、AWS Tools for PowerShell 「Cmdlet リファレンス」のCreateStreamingURL」を参照してください。

次のコード例は、New-APSUsageReportSubscription を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルは AppStream 使用状況レポートを有効にします

New-APSUsageReportSubscription

出力:

S3BucketName                                   Schedule
------------                                   --------
appstream-logs-us-east-1-123456789012-sik2hnxe DAILY

  • API の詳細については、AWS Tools for PowerShell 「コマンドレットリファレンス」のCreateUsageReportSubscription」を参照してください。

次のコード例は、New-APSUser を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルは USERPOOL でユーザーを作成します

New-APSUser -UserName Test@lab.com -AuthenticationType USERPOOL -FirstName 'kt' -LastName 'aws' -Select ^UserName

出力:

Test@lab.com

  • API の詳細については、AWS Tools for PowerShell 「コマンドレットリファレンス」のCreateUser」を参照してください。

次のコード例は、Register-APSFleet を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルは、フリートをスタックに登録します

Register-APSFleet -StackName TestStack -FleetName TestFleet -Region us-west-2

  • API の詳細については、「コマンドレットリファレンス」のAssociateFleet」を参照してください。 AWS Tools for PowerShell

次の例は、Register-APSUserStackBatch を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは USERPOOL のユーザーにスタックを割り当てます

Register-APSUserStackBatch -UserStackAssociation @{AuthenticationType="USERPOOL";SendEmailNotification=$False;StackName="PowershellStack";UserName="TestUser1@lab.com"}

  • API の詳細については、「コマンドレットリファレンス」のBatchAssociateUserStack」を参照してください。 AWS Tools for PowerShell

次の例は、Remove-APSDirectoryConfig を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは AppStream Directory 設定を削除します

Remove-APSDirectoryConfig -DirectoryName contoso.com

出力:

Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSDirectoryConfig (DeleteDirectoryConfig)" on target "contoso.com".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): A

  • API の詳細については、「コマンドレットリファレンス」のDeleteDirectoryConfig」を参照してください。 AWS Tools for PowerShell

次の例は、Remove-APSFleet を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは AppStream フリートを削除します

Remove-APSFleet -Name TestFleet -Region us-west-2

出力:

Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSFleet (DeleteFleet)" on target "TestFleet".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): A

  • API の詳細については、「コマンドレットリファレンス」のDeleteFleet」を参照してください。 AWS Tools for PowerShell

次の例は、Remove-APSImage を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルはイメージを削除します

Remove-APSImage -Name TestImage -Region us-west-2

出力:

Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSImage (DeleteImage)" on target "TestImage".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): A

Applications                : {}
AppstreamAgentVersion       : LATEST
Arn                         : arn:aws:appstream:us-west-2:123456789012:image/TestImage
BaseImageArn                :
CreatedTime                 : 12/27/2019 1:34:10 PM
Description                 :
DisplayName                 : TestImage
ImageBuilderName            :
ImageBuilderSupported       : True
ImagePermissions            :
Name                        : TestImage
Platform                    : WINDOWS
PublicBaseImageReleasedDate : 6/12/2018 12:00:00 AM
State                       : AVAILABLE
StateChangeReason           :
Visibility                  : PRIVATE

  • APIの詳細については、「コマンドレットリファレンス」のDeleteImage」を参照してください。 AWS Tools for PowerShell

次の例は、Remove-APSImageBuilder を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは an ImageBuilder を削除します

Remove-APSImageBuilder -Name TestIB -Region us-west-2

出力:

Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSImageBuilder (DeleteImageBuilder)" on target "TestIB".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): A

AccessEndpoints             : {}
AppstreamAgentVersion       : 12-16-2019
Arn                         : arn:aws:appstream:us-west-2:123456789012:image-builder/TestIB
CreatedTime                 : 12/27/2019 11:39:24 AM
Description                 :
DisplayName                 : TestIB
DomainJoinInfo              :
EnableDefaultInternetAccess : True
IamRoleArn                  :
ImageArn                    : arn:aws:appstream:us-west-2::image/AppStream-WinServer2012R2-12-12-2019
ImageBuilderErrors          : {}
InstanceType                : stream.standard.medium
Name                        : TestIB
NetworkAccessConfiguration  : Amazon.AppStream.Model.NetworkAccessConfiguration
Platform                    : WINDOWS
State                       : DELETING
StateChangeReason           :
VpcConfig                   : Amazon.AppStream.Model.VpcConfig

  • API の詳細については、AWS Tools for PowerShell 「コマンドレットリファレンス」のDeleteImageBuilder」を参照してください。

次の例は、Remove-APSImagePermission を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは、イメージのアクセス許可を削除します。

Remove-APSImagePermission -Name Powershell -SharedAccountId 123456789012

出力:

Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSImagePermission (DeleteImagePermissions)" on target "Powershell".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): A

  • API の詳細については、AWS Tools for PowerShell 「コマンドレットリファレンス」のDeleteImagePermissions」を参照してください。

次の例は、Remove-APSResourceTag を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは、 AppStream リソースからリソースタグを削除します

Remove-APSResourceTag -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest -TagKey StackState

出力:

Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSResourceTag (UntagResource)" on target "arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): A

  • APIの詳細については、「コマンドレットリファレンス」のUntagResource」を参照してください。 AWS Tools for PowerShell

次のコード例は、Remove-APSStack を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルはスタックを削除します

Remove-APSStack -Name TestStack -Region us-west-2

出力:

Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSStack (DeleteStack)" on target "TestStack".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): A

  • APIの詳細については、「コマンドレットリファレンス」のDeleteStack」を参照してください。 AWS Tools for PowerShell

次のコード例は、Remove-APSUsageReportSubscription を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルは、 AppStream 使用状況レポートのサブスクリプションを無効にします。

Remove-APSUsageReportSubscription

出力:

Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSUsageReportSubscription (DeleteUsageReportSubscription)" on target "".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): A

  • APIの詳細については、「コマンドレットリファレンス」のDeleteUsageReportSubscription」を参照してください。 AWS Tools for PowerShell

次の例は、Remove-APSUser を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは USERPOOL からユーザーを削除します

Remove-APSUser -UserName TestUser@lab.com -AuthenticationType USERPOOL

出力:

Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-APSUser (DeleteUser)" on target "TestUser@lab.com".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): A

  • API の詳細については、「コマンドレットリファレンス」のDeleteUser」を参照してください。 AWS Tools for PowerShell

次のコード例は、Revoke-APSSession を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルは、 AppStream フリートへのセッションを取り消します

Revoke-APSSession -SessionId 6cd2f9a3-f948-4aa1-8014-8a7dcde14877

  • API の詳細については、「コマンドレットリファレンス」のExpireSession」を参照してください。 AWS Tools for PowerShell

次のコード例は、Start-APSFleet を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルはフリートを開始します

Start-APSFleet -Name PowershellFleet

  • API の詳細については、「コマンドレットリファレンス」のStartFleet」を参照してください。 AWS Tools for PowerShell

次の例は、Start-APSImageBuilder を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは ImageBuilder を起動します

Start-APSImageBuilder -Name TestImage

出力:

AccessEndpoints             : {}
AppstreamAgentVersion       : 06-19-2019
Arn                         : arn:aws:appstream:us-east-1:123456789012:image-builder/TestImage
CreatedTime                 : 1/14/2019 4:33:05 AM
Description                 :
DisplayName                 : TestImage
DomainJoinInfo              :
EnableDefaultInternetAccess : False
IamRoleArn                  :
ImageArn                    : arn:aws:appstream:us-east-1::image/Base-Image-Builder-05-02-2018
ImageBuilderErrors          : {}
InstanceType                : stream.standard.large
Name                        : TestImage
NetworkAccessConfiguration  : Amazon.AppStream.Model.NetworkAccessConfiguration
Platform                    : WINDOWS
State                       : PENDING
StateChangeReason           :
VpcConfig                   : Amazon.AppStream.Model.VpcConfig

  • APIの詳細については、「コマンドレットリファレンス」のStartImageBuilder」を参照してください。 AWS Tools for PowerShell

次のコード例は、Stop-APSFleet を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルはフリートを停止する

Stop-APSFleet -Name PowershellFleet

  • API の詳細については、「コマンドレットリファレンス」のStopFleet」を参照してください。 AWS Tools for PowerShell

次の例は、Stop-APSImageBuilder を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは an ImageBuilder を停止する

Stop-APSImageBuilder -Name TestImage

出力:

AccessEndpoints             : {}
AppstreamAgentVersion       : 06-19-2019
Arn                         : arn:aws:appstream:us-east-1:123456789012:image-builder/TestImage
CreatedTime                 : 1/14/2019 4:33:05 AM
Description                 :
DisplayName                 : TestImage
DomainJoinInfo              :
EnableDefaultInternetAccess : False
IamRoleArn                  :
ImageArn                    : arn:aws:appstream:us-east-1::image/Base-Image-Builder-05-02-2018
ImageBuilderErrors          : {}
InstanceType                : stream.standard.large
Name                        : TestImage
NetworkAccessConfiguration  : Amazon.AppStream.Model.NetworkAccessConfiguration
Platform                    : WINDOWS
State                       : STOPPING
StateChangeReason           :
VpcConfig                   : Amazon.AppStream.Model.VpcConfig

  • APIの詳細については、「コマンドレットリファレンス」のStopImageBuilder」を参照してください。 AWS Tools for PowerShell

次のコード例は、Unregister-APSFleet を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルは、スタックからフリートを登録解除します

Unregister-APSFleet -StackName TestStack -FleetName TestFleet -Region us-west-2

  • APIの詳細については、「コマンドレットリファレンス」のDisassociateFleet」を参照してください。 AWS Tools for PowerShell

次の例は、Unregister-APSUserStackBatch を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは、割り当てられたスタックからユーザーを削除します

Unregister-APSUserStackBatch -UserStackAssociation @{AuthenticationType="USERPOOL";SendEmailNotification=$False;StackName="PowershellStack";UserName="TestUser1@lab.com"}

  • API の詳細については、AWS Tools for PowerShell 「コマンドレットリファレンス」のBatchDisassociateUserStack」を参照してください。

次の例は、Update-APSDirectoryConfig を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは、 AppStream で作成された Directory 設定を更新します。

Update-APSDirectoryConfig -ServiceAccountCredentials_AccountName contoso\ServiceAccount -ServiceAccountCredentials_AccountPassword MyPass@1$@# -DirectoryName contoso.com -OrganizationalUnitDistinguishedName "OU=AppStreamNew,OU=Contoso,DC=Contoso,DC=com"

出力:

CreatedTime           DirectoryName OrganizationalUnitDistinguishedNames           ServiceAccountCredentials
-----------           ------------- ------------------------------------           -------------------------
12/27/2019 3:50:02 PM contoso.com   {OU=AppStreamNew,OU=Contoso,DC=Contoso,DC=com} Amazon.AppStream.Model.ServiceAccountCredentials

  • API の詳細については、AWS Tools for PowerShell 「コマンドレットリファレンス」のUpdateDirectoryConfig」を参照してください。

次の例は、Update-APSFleet を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルはフリートのプロパティを更新します

Update-APSFleet -Name PowershellFleet -EnableDefaultInternetAccess $True -DisconnectTimeoutInSecond 950

出力:

Arn                            : arn:aws:appstream:us-east-1:123456789012:fleet/PowershellFleet
ComputeCapacityStatus          : Amazon.AppStream.Model.ComputeCapacityStatus
CreatedTime                    : 4/24/2019 8:39:41 AM
Description                    : PowershellFleet
DisconnectTimeoutInSeconds     : 950
DisplayName                    : PowershellFleet
DomainJoinInfo                 :
EnableDefaultInternetAccess    : True
FleetErrors                    : {}
FleetType                      : ON_DEMAND
IamRoleArn                     :
IdleDisconnectTimeoutInSeconds : 900
ImageArn                       : arn:aws:appstream:us-east-1:123456789012:image/Powershell
ImageName                      : Powershell
InstanceType                   : stream.standard.medium
MaxUserDurationInSeconds       : 57600
Name                           : PowershellFleet
State                          : STOPPED
VpcConfig                      : Amazon.AppStream.Model.VpcConfig

  • APIの詳細については、「コマンドレットリファレンス」のUpdateFleet」を参照してください。 AWS Tools for PowerShell

次のコード例は、Update-APSImagePermission を使用する方法を示しています。

ツール for PowerShell

例 1: このサンプルは AppStream イメージを他のアカウントと共有します。

Update-APSImagePermission -Name Powershell -SharedAccountId 123456789012 -ImagePermissions_AllowFleet $True -ImagePermissions_AllowImageBuilder $True

  • APIの詳細については、「コマンドレットリファレンス」のUpdateImagePermissions」を参照してください。 AWS Tools for PowerShell

次の例は、Update-APSStack を使用する方法を説明しています。

ツール for PowerShell

例 1: このサンプルは、スタック上のアプリケーション設定の永続化とホームフォルダを更新 (有効化) します。 

Update-APSStack -Name PowershellStack -ApplicationSettings_Enabled $True -ApplicationSettings_SettingsGroup PowershellStack -StorageConnector @{ConnectorType="HOMEFOLDERS"}

出力:

AccessEndpoints     : {}
ApplicationSettings : Amazon.AppStream.Model.ApplicationSettingsResponse
Arn                 : arn:aws:appstream:us-east-1:123456789012:stack/PowershellStack
CreatedTime         : 4/24/2019 8:49:29 AM
Description         : PowershellStack
DisplayName         : PowershellStack
EmbedHostDomains    : {}
FeedbackURL         :
Name                : PowershellStack
RedirectURL         :
StackErrors         : {}
StorageConnectors   : {Amazon.AppStream.Model.StorageConnector, Amazon.AppStream.Model.StorageConnector}
UserSettings        : {Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting, Amazon.AppStream.Model.UserSetting}

  • API の詳細については、「コマンドレットリファレンス」のUpdateStack」を参照してください。 AWS Tools for PowerShell