AppStream Tools for を使用した 2.0 の例 PowerShell - AWS SDK コード例

Doc AWS SDK Examples リポジトリには、他にも SDK の例があります。 AWS GitHub

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

AppStream Tools for を使用した 2.0 の例 PowerShell

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

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

「シナリオ」は、同じサービス内で複数の関数を呼び出して、特定のタスクを実行する方法を示すコード例です。

各例には、 へのリンクが含まれています。このリンクには GitHub、コンテキスト内でコードをセットアップして実行する方法の手順が記載されています。

トピック

アクション

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

のツール 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 の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスTagResource」の「」を参照してください。

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

のツール PowerShell

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

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

出力:

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

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

のツール PowerShell

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

Disable-APSUser -AuthenticationType USERPOOL -UserName TestUser@lab.com
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスDisableUser」の「」を参照してください。

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

のツール PowerShell

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

Enable-APSUser -AuthenticationType USERPOOL -UserName TestUser@lab.com
  • API の詳細については、「 コマンドレットリファレンスEnableUser」の「」を参照してください。 AWS Tools for PowerShell

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

のツール PowerShell

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

Get-APSAssociatedFleetList -StackName PowershellStack

出力:

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

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

のツール PowerShell

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

Get-APSAssociatedStackList -FleetName PowershellFleet

出力:

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

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

のツール 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 を使用する方法を説明しています。

のツール 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 を使用する方法を説明しています。

のツール 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 を使用する方法を説明しています。

のツール PowerShell

例 1: このサンプルでは、プライベート 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 を使用する方法を説明しています。

のツール 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 の詳細については、「 コマンドレットリファレンスDescribeImagePermissions」の「」を参照してください。 AWS Tools for PowerShell

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

のツール 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 を使用する方法を説明しています。

のツール 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 の詳細については、「 コマンドレットリファレンスDescribeStacks」の「」を参照してください。 AWS Tools for PowerShell

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

のツール PowerShell

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

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

出力:

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

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

のツール 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 の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスDescribeUsageReportSubscriptions」の「」を参照してください。

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

のツール 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 の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスDescribeUsers」の「」を参照してください。

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

のツール PowerShell

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

Get-APSUserStackAssociation -StackName PowershellStack

出力:

AuthenticationType SendEmailNotification StackName UserName ------------------ --------------------- --------- -------- USERPOOL False PowershellStack TestUser1@lab.com USERPOOL False PowershellStack TestUser2@lab.com
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスDescribeUserStackAssociations」の「」を参照してください。

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

のツール 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 を使用する方法を説明しています。

のツール 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 の詳細については、「 コマンドレットリファレンスCreateFleet」の「」を参照してください。 AWS Tools for PowerShell

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

のツール PowerShell

例 1: このサンプルでは、 で Image Builder を作成します。 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 を使用する方法を説明しています。

のツール 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 を使用する方法を説明しています。

のツール 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 を使用する方法を説明しています。

のツール PowerShell

例 1: このサンプルでは、 スタックのストリーミング URL を作成します。

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 の詳細については、「 コマンドレットリファレンス」の「CreateStreamingURL」を参照してください。 AWS Tools for PowerShell

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

のツール PowerShell

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

New-APSUsageReportSubscription

出力:

S3BucketName Schedule ------------ -------- appstream-logs-us-east-1-123456789012-sik2hnxe DAILY
  • API の詳細については、「 コマンドレットリファレンスCreateUsageReportSubscription」の「」を参照してください。 AWS Tools for PowerShell

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

のツール PowerShell

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

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

出力:

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

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

のツール PowerShell

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

Register-APSFleet -StackName TestStack -FleetName TestFleet -Region us-west-2
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスAssociateFleet」の「」を参照してください。

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

のツール PowerShell

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

Register-APSUserStackBatch -UserStackAssociation @{AuthenticationType="USERPOOL";SendEmailNotification=$False;StackName="PowershellStack";UserName="TestUser1@lab.com"}
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスBatchAssociateUserStack」の「」を参照してください。

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

のツール PowerShell

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

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 を使用する方法を説明しています。

のツール 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 の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスDeleteFleet」の「」を参照してください。

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

のツール 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 を使用する方法を説明しています。

のツール PowerShell

例 1: このサンプルでは、 を削除します。 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 の詳細については、「 コマンドレットリファレンスDeleteImageBuilder」の「」を参照してください。 AWS Tools for PowerShell

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

のツール 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 の詳細については、「 コマンドレットリファレンスDeleteImagePermissions」の「」を参照してください。 AWS Tools for PowerShell

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

のツール 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 を使用する方法を説明しています。

のツール 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 を使用する方法を説明しています。

のツール 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 を使用する方法を説明しています。

のツール 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 を使用する方法を説明しています。

のツール PowerShell

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

Revoke-APSSession -SessionId 6cd2f9a3-f948-4aa1-8014-8a7dcde14877
  • API の詳細については、「 コマンドレットリファレンスExpireSession」の「」を参照してください。 AWS Tools for PowerShell

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

のツール PowerShell

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

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

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

のツール 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 を使用する方法を説明しています。

のツール PowerShell

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

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

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

のツール PowerShell

例 1: このサンプルは を停止します。 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 を使用する方法を説明しています。

のツール PowerShell

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

Unregister-APSFleet -StackName TestStack -FleetName TestFleet -Region us-west-2
  • API の詳細については、「 コマンドレットリファレンスDisassociateFleet」の「」を参照してください。 AWS Tools for PowerShell

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

のツール PowerShell

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

Unregister-APSUserStackBatch -UserStackAssociation @{AuthenticationType="USERPOOL";SendEmailNotification=$False;StackName="PowershellStack";UserName="TestUser1@lab.com"}
  • API の詳細については、「 コマンドレットリファレンスBatchDisassociateUserStack」の「」を参照してください。 AWS Tools for PowerShell

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

のツール PowerShell

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

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 を使用する方法を説明しています。

のツール 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 の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスUpdateFleet」の「」を参照してください。

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

のツール PowerShell

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

Update-APSImagePermission -Name Powershell -SharedAccountId 123456789012 -ImagePermissions_AllowFleet $True -ImagePermissions_AllowImageBuilder $True
  • API の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスUpdateImagePermissions」の「」を参照してください。

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

のツール 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 の詳細については、AWS Tools for PowerShell 「 コマンドレットリファレンスUpdateStack」の「」を参照してください。