Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 [AWS](https://github.com/awsdocs/aws-doc-sdk-examples)
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# Tools for PowerShell V5 のコード例
次のコード例は、 で AWS Tools for PowerShell V5 を使用する方法を示しています AWS。
*基本* は、重要なオペレーションをサービス内で実行する方法を示すコード例です。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
*シナリオ*は、1 つのサービス内から、または他の AWS のサービスと組み合わせて複数の関数を呼び出し、特定のタスクを実行する方法を示すコード例です。
一部のサービスには、サービス固有のライブラリや関数の活用方法を示す追加のカテゴリ例が含まれています。
**その他のリソース**
+ ** [ Tools for PowerShell V5 デベロッパーガイド ](https://docs.aws.amazon.com/powershell/v5/userguide/pstools-welcome.html) ** – で PowerShell を使用する方法の詳細 AWS。
+ **[AWS デベロッパーセンター](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-programming-language=programming-language%23)** — カテゴリまたは全文検索でフィルタリングできるコード例。
+ **[AWS SDK の例](https://github.com/awsdocs/aws-doc-sdk-examples)** — 推奨言語の完全なコードを含む GitHub リポジトリ。コードの設定と実行に関する説明が記載されています。
**Topics**
+ [ACM](powershell_5_acm_code_examples.md)
+ [Application Auto Scaling](powershell_5_application-auto-scaling_code_examples.md)
+ [WorkSpaces Applications](powershell_5_appstream_code_examples.md)
+ [Aurora](powershell_5_aurora_code_examples.md)
+ [Auto Scaling](powershell_5_auto-scaling_code_examples.md)
+ [AWS Budgets](powershell_5_budgets_code_examples.md)
+ [AWS Cloud9](powershell_5_cloud9_code_examples.md)
+ [CloudFormation](powershell_5_cloudformation_code_examples.md)
+ [CloudFront](powershell_5_cloudfront_code_examples.md)
+ [CloudTrail](powershell_5_cloudtrail_code_examples.md)
+ [CloudWatch](powershell_5_cloudwatch_code_examples.md)
+ [CodeCommit](powershell_5_codecommit_code_examples.md)
+ [CodeDeploy](powershell_5_codedeploy_code_examples.md)
+ [CodePipeline](powershell_5_codepipeline_code_examples.md)
+ [Amazon Cognito ID](powershell_5_cognito-identity_code_examples.md)
+ [AWS Config](powershell_5_config-service_code_examples.md)
+ [Device Farm](powershell_5_device-farm_code_examples.md)
+ [Directory Service](powershell_5_directory-service_code_examples.md)
+ [AWS DMS](powershell_5_database-migration-service_code_examples.md)
+ [DynamoDB](powershell_5_dynamodb_code_examples.md)
+ [Amazon EC2](powershell_5_ec2_code_examples.md)
+ [Amazon ECR](powershell_5_ecr_code_examples.md)
+ [Amazon ECS](powershell_5_ecs_code_examples.md)
+ [Amazon EFS](powershell_5_efs_code_examples.md)
+ [Amazon EKS](powershell_5_eks_code_examples.md)
+ [Elastic Load Balancing - バージョン 1](powershell_5_elastic-load-balancing_code_examples.md)
+ [Elastic Load Balancing - バージョン 2](powershell_5_elastic-load-balancing-v2_code_examples.md)
+ [Amazon FSx](powershell_5_fsx_code_examples.md)
+ [Amazon Glacier](powershell_5_glacier_code_examples.md)
+ [AWS Glue](powershell_5_glue_code_examples.md)
+ [AWS Health](powershell_5_health_code_examples.md)
+ [IAM](powershell_5_iam_code_examples.md)
+ [Kinesis](powershell_5_kinesis_code_examples.md)
+ [Lambda](powershell_5_lambda_code_examples.md)
+ [Amazon ML](powershell_5_machine-learning_code_examples.md)
+ [Macie](powershell_5_macie2_code_examples.md)
+ [AWS の料金表](powershell_5_pricing_code_examples.md)
+ [リソースグループ](powershell_5_resource-groups_code_examples.md)
+ [リソースグループタグ付け API](powershell_5_resource-groups-tagging-api_code_examples.md)
+ [Route 53](powershell_5_route-53_code_examples.md)
+ [Amazon S3](powershell_5_s3_code_examples.md)
+ [Security Hub CSPM](powershell_5_securityhub_code_examples.md)
+ [Amazon SES](powershell_5_ses_code_examples.md)
+ [Amazon SES API v2](powershell_5_sesv2_code_examples.md)
+ [Amazon SNS](powershell_5_sns_code_examples.md)
+ [Amazon SQS](powershell_5_sqs_code_examples.md)
+ [AWS STS](powershell_5_sts_code_examples.md)
+ [サポート](powershell_5_support_code_examples.md)
+ [Systems Manager](powershell_5_ssm_code_examples.md)
+ [Amazon Translate](powershell_5_translate_code_examples.md)
+ [AWS WAFV2](powershell_5_wafv2_code_examples.md)
+ [WorkSpaces](powershell_5_workspaces_code_examples.md)
# Tools for PowerShell V5 を使用した ACM の例
次のコード例は、ACM で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Get-ACMCertificate`
次のコード例は、`Get-ACMCertificate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、証明書の ARN を使用して証明書とそのチェーンを返す方法を示します。**
```
Get-ACMCertificate -CertificateArn "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetCertificate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ACMCertificateDetail`
次のコード例は、`Get-ACMCertificateDetail` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定した証明書の詳細を返します。**
```
Get-ACMCertificateDetail -CertificateArn "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
```
**出力:**
```
CertificateArn : arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
CreatedAt : 1/21/2016 5:55:59 PM
DomainName : www.example.com
DomainValidationOptions : {www.example.com}
InUseBy : {}
IssuedAt : 1/1/0001 12:00:00 AM
Issuer :
KeyAlgorithm : RSA-2048
NotAfter : 1/1/0001 12:00:00 AM
NotBefore : 1/1/0001 12:00:00 AM
RevocationReason :
RevokedAt : 1/1/0001 12:00:00 AM
Serial :
SignatureAlgorithm : SHA256WITHRSA
Status : PENDING_VALIDATION
Subject : CN=www.example.com
SubjectAlternativeNames : {www.example.net}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeCertificate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ACMCertificateList`
次のコード例は、`Get-ACMCertificateList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 証明書の ARN のリストと各 ARN のドメイン名を取得します。コマンドレットは自動的にページ分割され、すべての ARN を取得します。ページ分割を手動で制御するには、-MaxItem パラメータを使用して各サービス呼び出しに対して返される証明書 ARN の数を制御し、-NextToken パラメータを使用して各呼び出しの開始点を示します。**
```
Get-ACMCertificateList
```
**出力:**
```
CertificateArn DomainName
-------------- ----------
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 www.example.com
```
**例 2: 指定された状態に証明書の状態が一致するすべての証明書 ARN のリストを取得します。**
```
Get-ACMCertificateList -CertificateStatus "VALIDATION_TIMED_OUT","FAILED"
```
**例 3: この例では、キータイプが RSA\$12048、拡張キーの使用法または目的が CODE\$1SIGNING である、us-east-1 リージョン内のすべての証明書のリストを返します。これらのフィルタリングパラメータの値については、API リファレンスの「ListCertificates Filters」トピック: https://docs.aws.amazon.com/acm/latest/APIReference/API\$1Filters.html を参照してください。**
```
Get-ACMCertificateList -Region us-east-1 -Includes_KeyType RSA_2048 -Includes_ExtendedKeyUsage CODE_SIGNING
```
**出力:**
```
CertificateArn DomainName
-------------- ----------
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-d7c0-48c1-af8d-2133d8f30zzz *.route53docs.com
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-98a5-443d-a734-800430c80zzz nerdzizm.net
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-2be6-4376-8fa7-bad559525zzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-e7ca-44c5-803e-24d9f2f36zzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-1241-4b71-80b1-090305a62zzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-8709-4568-8c64-f94617c99zzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-a8fa-4a61-98cf-e08ccc0eezzz
arn:aws:acm:us-east-1:8xxxxxxxxxxx:certificate/xxxxxxxx-fa47-40fe-a714-2d277d3eezzz *.route53docs.com
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListCertificates](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-ACMCertificate`
次のコード例は、`New-ACMCertificate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 新しい証明書を作成します。サービスは新しい証明書の ARN を返します。**
```
New-ACMCertificate -DomainName "www.example.com"
```
**出力:**
```
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
```
**例 2: 新しい証明書を作成します。サービスは新しい証明書の ARN を返します。**
```
New-ACMCertificate -DomainName "www.example.com" -SubjectAlternativeName "example.com","www.example.net"
```
**出力:**
```
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の[RequestCertificate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-ACMCertificate`
次のコード例は、`Remove-ACMCertificate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定された ARN で識別される証明書および関連するプライベートキーを削除します。コマンドレットは、操作を続行する前に確認を求めます。確認を表示しないようにするには、-Force スイッチを追加します。**
```
Remove-ACMCertificate -CertificateArn "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteCertificate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Send-ACMValidationEmail`
次のコード例は、`Send-ACMValidationEmail` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 「www.example.com」のドメイン所有権を検証する E メールの送信をリクエストします。シェルの \$1ConfirmPreference が「Medium」以下に設定されている場合、コマンドレットは続行する前に確認を求めます。-Force スイッチを追加すると、確認メッセージが表示されなくなります。**
```
$params = @{
CertificateArn="arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012"
Domain="www.example.com"
ValidationDomain="example.com"
}
Send-ACMValidationEmail @params
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ResendValidationEmail](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した Application Auto Scaling の例
次のコード例は、Application Auto Scaling で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-AASScalableTarget`
次のコード例は、`Add-AASScalableTarget` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、スケーラブルなターゲットを登録または更新します。スケーラブルターゲットとは、Application Auto Scaling がスケールアウトおよびスケールインできるリソースです。**
```
Add-AASScalableTarget -ServiceNamespace AppStream -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity -MinCapacity 2 -MaxCapacity 10
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RegisterScalableTarget](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-AASScalableTarget`
次のコード例は、`Get-AASScalableTarget` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された名前空間内の Application Autoscaling Scalable ターゲットに関する情報を提供します。**
```
Get-AASScalableTarget -ServiceNamespace "AppStream"
```
**出力:**
```
CreationTime : 11/7/2019 2:30:03 AM
MaxCapacity : 5
MinCapacity : 1
ResourceId : fleet/Test
RoleARN : arn:aws:iam::012345678912:role/aws-service-role/appstream.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_AppStreamFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ServiceNamespace : appstream
SuspendedState : Amazon.ApplicationAutoScaling.Model.SuspendedState
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeScalableTargets](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-AASScalingActivity`
次のコード例は、`Get-AASScalingActivity` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定された名前空間における過去 6 週間のスケーリングアクティビティに関する詳細情報を提供します。**
```
Get-AASScalingActivity -ServiceNamespace AppStream
```
**出力:**
```
ActivityId : 2827409f-b639-4cdb-a957-8055d5d07434
Cause : monitor alarm Appstream2-MyFleet-default-scale-in-Alarm in state ALARM triggered policy default-scale-in
Description : Setting desired capacity to 2.
Details :
EndTime : 12/14/2019 11:32:49 AM
ResourceId : fleet/MyFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ServiceNamespace : appstream
StartTime : 12/14/2019 11:32:14 AM
StatusCode : Successful
StatusMessage : Successfully set desired capacity to 2. Change successfully fulfilled by appstream.
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeScalingActivities](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-AASScalingPolicy`
次のコード例は、`Get-AASScalingPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、指定されたサービス名前空間の Application Auto Scaling スケーリングポリシーを記述します。**
```
Get-AASScalingPolicy -ServiceNamespace AppStream
```
**出力:**
```
Alarms : {Appstream2-LabFleet-default-scale-out-Alarm}
CreationTime : 9/3/2019 2:48:15 AM
PolicyARN : arn:aws:autoscaling:us-west-2:012345678912:scalingPolicy:5659b069-b5cd-4af1-9f7f-3e956d36233e:resource/appstream/fleet/LabFleet:
policyName/default-scale-out
PolicyName : default-scale-out
PolicyType : StepScaling
ResourceId : fleet/LabFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ServiceNamespace : appstream
StepScalingPolicyConfiguration : Amazon.ApplicationAutoScaling.Model.StepScalingPolicyConfiguration
TargetTrackingScalingPolicyConfiguration :
Alarms : {Appstream2-LabFleet-default-scale-in-Alarm}
CreationTime : 9/3/2019 2:48:15 AM
PolicyARN : arn:aws:autoscaling:us-west-2:012345678912:scalingPolicy:5659b069-b5cd-4af1-9f7f-3e956d36233e:resource/appstream/fleet/LabFleet:
policyName/default-scale-in
PolicyName : default-scale-in
PolicyType : StepScaling
ResourceId : fleet/LabFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ServiceNamespace : appstream
StepScalingPolicyConfiguration : Amazon.ApplicationAutoScaling.Model.StepScalingPolicyConfiguration
TargetTrackingScalingPolicyConfiguration :
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeScalingPolicies](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-AASScheduledAction`
次のコード例は、`Get-AASScheduledAction` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットには、Auto Scaling グループにスケジュールされた、実行されていないか終了時刻に達していないアクションが一覧表示されます。 **
```
Get-AASScheduledAction -ServiceNamespace AppStream
```
**出力:**
```
CreationTime : 12/22/2019 9:25:52 AM
EndTime : 1/1/0001 12:00:00 AM
ResourceId : fleet/MyFleet
ScalableDimension : appstream:fleet:DesiredCapacity
ScalableTargetAction : Amazon.ApplicationAutoScaling.Model.ScalableTargetAction
Schedule : cron(0 0 8 ? * MON-FRI *)
ScheduledActionARN : arn:aws:autoscaling:us-west-2:012345678912:scheduledAction:4897ca24-3caa-4bf1-8484-851a089b243c:resource/appstream/fleet/MyFleet:scheduledActionName
/WeekDaysFleetScaling
ScheduledActionName : WeekDaysFleetScaling
ServiceNamespace : appstream
StartTime : 1/1/0001 12:00:00 AM
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeScheduledActions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-AASScalableTarget`
次のコード例は、`Remove-AASScalableTarget` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、Application Auto Scaling のスケーラブルターゲットを登録解除します。スケーラブルターゲットの登録を解除すると、それに関連付けられているスケーリングポリシーが削除されます。**
```
Remove-AASScalableTarget -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity -ServiceNamespace AppStream
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-AASScalableTarget (DeregisterScalableTarget)" on target "fleet/MyFleet".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeregisterScalableTarget](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-AASScalingPolicy`
次のコード例は、`Remove-AASScalingPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、Application Auto Scaling スケーラブルターゲットの指定されたスケーリングポリシーを削除します。**
```
Remove-AASScalingPolicy -ServiceNamespace AppStream -PolicyName "default-scale-out" -ResourceId fleet/Test -ScalableDimension appstream:fleet:DesiredCapacity
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteScalingPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-AASScheduledAction`
次のコード例は、`Remove-AASScheduledAction` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、Application Auto Scaling スケーラブルターゲットの指定されたスケジュールされたアクションを削除します。**
```
Remove-AASScheduledAction -ServiceNamespace AppStream -ScheduledActionName WeekDaysFleetScaling -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-AASScheduledAction (DeleteScheduledAction)" on target "WeekDaysFleetScaling".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteScheduledAction](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Set-AASScalingPolicy`
次のコード例は、`Set-AASScalingPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、Application Auto Scaling のスケーラブルターゲットのポリシーを作成または更新します。各スケーラブルターゲットは、サービス名前空間、リソース ID、スケーラブルなディメンションによって識別されます。**
```
Set-AASScalingPolicy -ServiceNamespace AppStream -PolicyName ASFleetScaleInPolicy -PolicyType StepScaling -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity -StepScalingPolicyConfiguration_AdjustmentType ChangeInCapacity -StepScalingPolicyConfiguration_Cooldown 360 -StepScalingPolicyConfiguration_MetricAggregationType Average -StepScalingPolicyConfiguration_StepAdjustments @{ScalingAdjustment = -1; MetricIntervalUpperBound = 0}
```
**出力:**
```
Alarms PolicyARN
------ ---------
{} arn:aws:autoscaling:us-west-2:012345678912:scalingPolicy:4897ca24-3caa-4bf1-8484-851a089b243c:resource/appstream/fleet/MyFleet:policyName/ASFleetScaleInPolicy
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[PutScalingPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Set-AASScheduledAction`
次のコード例は、`Set-AASScheduledAction` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、Application Auto Scaling のスケーラブルターゲットのスケジュールされたアクションを作成または更新します。各スケーラブルターゲットは、サービス名前空間、リソース ID、スケーラブルなディメンションによって識別されます。**
```
Set-AASScheduledAction -ServiceNamespace AppStream -ResourceId fleet/MyFleet -Schedule "cron(0 0 8 ? * MON-FRI *)" -ScalableDimension appstream:fleet:DesiredCapacity -ScheduledActionName WeekDaysFleetScaling -ScalableTargetAction_MinCapacity 5 -ScalableTargetAction_MaxCapacity 10
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[PutScheduledAction](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した WorkSpaces アプリケーションの例
次のコード例は、WorkSpaces アプリケーションで AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-APSResourceTag`
次のコード例は、`Add-APSResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 コマンドレットリファレンス (V5) の「[TagResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Copy-APSImage`
次のコード例は、`Copy-APSImage` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、画像を他のリージョンにコピーします**
```
Copy-APSImage -DestinationImageName TestImageCopy -DestinationRegion us-west-2 -SourceImageName Powershell
```
**出力:**
```
TestImageCopy
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CopyImage](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Disable-APSUSer`
次のコード例は、`Disable-APSUSer` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、USERPOOL のユーザーを無効にします**
```
Disable-APSUser -AuthenticationType USERPOOL -UserName TestUser@lab.com
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DisableUser](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Enable-APSUser`
次のコード例は、`Enable-APSUser` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、USERPOOL で無効になっているユーザーを有効にします**
```
Enable-APSUser -AuthenticationType USERPOOL -UserName TestUser@lab.com
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[EnableUser](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-APSAssociatedFleetList`
次のコード例は、`Get-APSAssociatedFleetList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、スタックに関連付けられたフリートを表示します**
```
Get-APSAssociatedFleetList -StackName PowershellStack
```
**出力:**
```
PowershellFleet
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListAssociatedFleets](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-APSAssociatedStackList`
次のコード例は、`Get-APSAssociatedStackList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、フリートに関連付けられたスタックを表示します**
```
Get-APSAssociatedStackList -FleetName PowershellFleet
```
**出力:**
```
PowershellStack
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListAssociatedStacks](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-APSDirectoryConfigList`
次のコード例は、`Get-APSDirectoryConfigList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeDirectoryConfigs](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-APSFleetList`
次のコード例は、`Get-APSFleetList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 コマンドレットリファレンス (V5)* の「[DescribeFleets](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-APSImageBuilderList`
次のコード例は、`Get-APSImageBuilderList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeImageBuilders](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-APSImageList`
次のコード例は、`Get-APSImageList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeImages](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-APSImagePermission`
次のコード例は、`Get-APSImagePermission` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 コマンドレットリファレンス (V5)* の「[DescribeImagePermissions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-APSSessionList`
次のコード例は、`Get-APSSessionList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeSessions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-APSStackList`
次のコード例は、`Get-APSStackList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 Cmdlet Reference (V5)*」の「[DescribeStacks](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-APSTagsForResourceList`
次のコード例は、`Get-APSTagsForResourceList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、AppStream リソースのタグを表示します**
```
Get-APSTagsForResourceList -ResourceArn arn:aws:appstream:us-east-1:123456789012:stack/SessionScriptTest
```
**出力:**
```
Key Value
--- -----
StackState Test
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-APSUsageReportSubscription`
次のコード例は、`Get-APSUsageReportSubscription` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 コマンドレットリファレンス (V5)* の「[DescribeUsageReportSubscriptions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-APSUser`
次のコード例は、`Get-APSUser` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 コマンドレットリファレンス (V5)* の「[DescribeUsers](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-APSUserStackAssociation`
次のコード例は、`Get-APSUserStackAssociation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 コマンドレットリファレンス (V5)* の「[DescribeUserStackAssociations](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-APSDirectoryConfig`
次のコード例は、`New-APSDirectoryConfig` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateDirectoryConfig](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-APSFleet`
次のコード例は、`New-APSFleet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 コマンドレットリファレンス (V5)* の「[CreateFleet](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-APSImageBuilder`
次のコード例は、`New-APSImageBuilder` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、AppStream に Image Builder を作成します**
```
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 の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateImageBuilder](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-APSImageBuilderStreamingURL`
次のコード例は、`New-APSImageBuilderStreamingURL` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateImageBuilderStreamingURL](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-APSStack`
次のコード例は、`New-APSStack` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[CreateStack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-APSStreamingURL`
次のコード例は、`New-APSStreamingURL` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateStreamingURL](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-APSUsageReportSubscription`
次のコード例は、`New-APSUsageReportSubscription` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、AppStream 使用状況レポートを有効にします**
```
New-APSUsageReportSubscription
```
**出力:**
```
S3BucketName Schedule
------------ --------
appstream-logs-us-east-1-123456789012-sik2hnxe DAILY
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateUsageReportSubscription](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-APSUser`
次のコード例は、`New-APSUser` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、USERPOOL にユーザーを作成します**
```
New-APSUser -UserName Test@lab.com -AuthenticationType USERPOOL -FirstName 'kt' -LastName 'aws' -Select ^UserName
```
**出力:**
```
Test@lab.com
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateUser](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Register-APSFleet`
次のコード例は、`Register-APSFleet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、フリートをスタックに登録します**
```
Register-APSFleet -StackName TestStack -FleetName TestFleet -Region us-west-2
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AssociateFleet](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Register-APSUserStackBatch`
次のコード例は、`Register-APSUserStackBatch` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、USERPOOL のユーザーにスタックを割り当てます**
```
Register-APSUserStackBatch -UserStackAssociation @{AuthenticationType="USERPOOL";SendEmailNotification=$False;StackName="PowershellStack";UserName="TestUser1@lab.com"}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[BatchAssociateUserStack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-APSDirectoryConfig`
次のコード例は、`Remove-APSDirectoryConfig` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteDirectoryConfig](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-APSFleet`
次のコード例は、`Remove-APSFleet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 コマンドレットリファレンス (V5)* の「[DeleteFleet](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-APSImage`
次のコード例は、`Remove-APSImage` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteImage](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-APSImageBuilder`
次のコード例は、`Remove-APSImageBuilder` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteImageBuilder](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-APSImagePermission`
次のコード例は、`Remove-APSImagePermission` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 コマンドレットリファレンス (V5)* の「[DeleteImagePermissions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-APSResourceTag`
次のコード例は、`Remove-APSResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UntagResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-APSStack`
次のコード例は、`Remove-APSStack` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[DeleteStack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-APSUsageReportSubscription`
次のコード例は、`Remove-APSUsageReportSubscription` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteUsageReportSubscription](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-APSUser`
次のコード例は、`Remove-APSUser` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteUser](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Revoke-APSSession`
次のコード例は、`Revoke-APSSession` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、AppStream フリートへのセッションを取り消します**
```
Revoke-APSSession -SessionId 6cd2f9a3-f948-4aa1-8014-8a7dcde14877
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ExpireSession](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Start-APSFleet`
次のコード例は、`Start-APSFleet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、フリートを開始します**
```
Start-APSFleet -Name PowershellFleet
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[StartFleet](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Start-APSImageBuilder`
次のコード例は、`Start-APSImageBuilder` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[StartImageBuilder](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Stop-APSFleet`
次のコード例は、`Stop-APSFleet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、フリートを停止します**
```
Stop-APSFleet -Name PowershellFleet
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[StopFleet](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Stop-APSImageBuilder`
次のコード例は、`Stop-APSImageBuilder` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[StopImageBuilder](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Unregister-APSFleet`
次のコード例は、`Unregister-APSFleet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、スタックからフリートを登録解除します**
```
Unregister-APSFleet -StackName TestStack -FleetName TestFleet -Region us-west-2
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DisassociateFleet](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Unregister-APSUserStackBatch`
次のコード例は、`Unregister-APSUserStackBatch` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、割り当てられたスタックからユーザーを削除します**
```
Unregister-APSUserStackBatch -UserStackAssociation @{AuthenticationType="USERPOOL";SendEmailNotification=$False;StackName="PowershellStack";UserName="TestUser1@lab.com"}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[BatchDisassociateUserStack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-APSDirectoryConfig`
次のコード例は、`Update-APSDirectoryConfig` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 コマンドレットリファレンス (V5)* の「[UpdateDirectoryConfig](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-APSFleet`
次のコード例は、`Update-APSFleet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 コマンドレットリファレンス (V5)* の「[UpdateFleet](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-APSImagePermission`
次のコード例は、`Update-APSImagePermission` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、AppStream イメージを他のアカウントと共有します**
```
Update-APSImagePermission -Name Powershell -SharedAccountId 123456789012 -ImagePermissions_AllowFleet $True -ImagePermissions_AllowImageBuilder $True
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateImagePermissions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-APSStack`
次のコード例は、`Update-APSStack` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 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 Cmdlet Reference (V5)*」の「[UpdateStack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した Aurora の例
次のコード例は、Aurora で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Get-RDSOrderableDBInstanceOption`
次のコード例は、`Get-RDSOrderableDBInstanceOption` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例は、 AWS リージョン内で特定の DB インスタンスクラスをサポートする DB エンジンのバージョンを一覧表示します。**
```
$params = @{
Engine = 'aurora-postgresql'
DBInstanceClass = 'db.r5.large'
Region = 'us-east-1'
}
Get-RDSOrderableDBInstanceOption @params
```
**例 2: この例は、 AWS リージョン内で特定の DB エンジンのバージョンをサポートする DB インスタンスクラスを一覧表示します。**
```
$params = @{
Engine = 'aurora-postgresql'
EngineVersion = '13.6'
Region = 'us-east-1'
}
Get-RDSOrderableDBInstanceOption @params
```
+ API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[DescribeOrderableDBInstanceOptions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した Auto Scaling の例
次のコード例は、Auto Scaling で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-ASLoadBalancer`
次のコード例は、`Add-ASLoadBalancer` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したロードバランサーを、指定した Auto Scaling グループにアタッチします。**
```
Add-ASLoadBalancer -LoadBalancerName my-lb -AutoScalingGroupName my-asg
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AttachLoadBalancers](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Complete-ASLifecycleAction`
次のコード例は、`Complete-ASLifecycleAction` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したライフサイクルアクションを完了します。**
```
Complete-ASLifecycleAction -LifecycleHookName myLifecycleHook -AutoScalingGroupName my-asg -LifecycleActionResult CONTINUE -LifecycleActionToken bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CompleteLifecycleAction](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Disable-ASMetricsCollection`
次のコード例は、`Disable-ASMetricsCollection` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループの指定したメトリクスのモニタリングを無効にします。**
```
Disable-ASMetricsCollection -AutoScalingGroupName my-asg -Metric @("GroupMinSize", "GroupMaxSize")
```
**例 2: この例では、指定した Auto Scaling グループのすべてのメトリクスのモニタリングを無効にします。**
```
Disable-ASMetricsCollection -AutoScalingGroupName my-asg
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DisableMetricsCollection](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Dismount-ASInstance`
次のコード例は、`Dismount-ASInstance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループから指定したインスタンスをデタッチし、希望する容量を減らして、Auto Scaling が代替インスタンスを起動しないようにします。**
```
Dismount-ASInstance -InstanceId i-93633f9b -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $true
```
**出力:**
```
ActivityId : 06733445-ce94-4039-be1b-b9f1866e276e
AutoScalingGroupName : my-asg
Cause : At 2015-11-20T22:34:59Z instance i-93633f9b was detached in response to a user request, shrinking
the capacity from 2 to 1.
Description : Detaching EC2 instance: i-93633f9b
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 50
StartTime : 11/20/2015 2:34:59 PM
StatusCode : InProgress
StatusMessage :
```
**例 2: この例では、希望する容量を減らすことなく、指定したインスタンスを指定した Auto Scaling グループからデタッチします。Auto Scaling が代替インスタンスを起動します。**
```
Dismount-ASInstance -InstanceId i-7bf746a2 -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $false
```
**出力:**
```
ActivityId : f43a3cd4-d38c-4af7-9fe0-d76ec2307b6d
AutoScalingGroupName : my-asg
Cause : At 2015-11-20T22:34:59Z instance i-7bf746a2 was detached in response to a user request.
Description : Detaching EC2 instance: i-7bf746a2
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 50
StartTime : 11/20/2015 2:34:59 PM
StatusCode : InProgress
StatusMessage :
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DetachInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Dismount-ASLoadBalancer`
次のコード例は、`Dismount-ASLoadBalancer` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループから指定したロードバランサーをデタッチします。**
```
Dismount-ASLoadBalancer -LoadBalancerName my-lb -AutoScalingGroupName my-asg
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DetachLoadBalancers](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Enable-ASMetricsCollection`
次のコード例は、`Enable-ASMetricsCollection` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループの指定したメトリクスのモニタリングを有効にします。**
```
Enable-ASMetricsCollection -Metric @("GroupMinSize", "GroupMaxSize") -AutoScalingGroupName my-asg -Granularity 1Minute
```
**例 2: この例では、指定した Auto Scaling グループのすべてのメトリクスのモニタリングを有効にします。**
```
Enable-ASMetricsCollection -AutoScalingGroupName my-asg -Granularity 1Minute
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[EnableMetricsCollection](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Enter-ASStandby`
次のコード例は、`Enter-ASStandby` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したインスタンスをスタンバイモードにし、希望する容量を減らして、Auto Scaling が代替インスタンスを起動しないようにします。**
```
Enter-ASStandby -InstanceId i-93633f9b -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $true
```
**出力:**
```
ActivityId : e36a5a54-ced6-4df8-bd19-708e2a59a649
AutoScalingGroupName : my-asg
Cause : At 2015-11-22T15:48:06Z instance i-95b8484f was moved to standby in response to a user request,
shrinking the capacity from 2 to 1.
Description : Moving EC2 instance to Standby: i-95b8484f
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 50
StartTime : 11/22/2015 7:48:06 AM
StatusCode : InProgress
StatusMessage :
```
**例 2: この例では、希望する容量を減らすことなく、指定したインスタンスをスタンバイモードにします。Auto Scaling が代替インスタンスを起動します。**
```
Enter-ASStandby -InstanceId i-93633f9b -AutoScalingGroupName my-asg -ShouldDecrementDesiredCapacity $false
```
**出力:**
```
ActivityId : e36a5a54-ced6-4df8-bd19-708e2a59a649
AutoScalingGroupName : my-asg
Cause : At 2015-11-22T15:48:06Z instance i-95b8484f was moved to standby in response to a user request.
Description : Moving EC2 instance to Standby: i-95b8484f
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 50
StartTime : 11/22/2015 7:48:06 AM
StatusCode : InProgress
StatusMessage :
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[EnterStandby](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Exit-ASStandby`
次のコード例は、`Exit-ASStandby` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したインスタンスをスタンバイモードから解除します。**
```
Exit-ASStandby -InstanceId i-93633f9b -AutoScalingGroupName my-asg
```
**出力:**
```
ActivityId : 1833d3e8-e32f-454e-b731-0670ad4c6934
AutoScalingGroupName : my-asg
Cause : At 2015-11-22T15:51:21Z instance i-95b8484f was moved out of standby in response to a user
request, increasing the capacity from 1 to 2.
Description : Moving EC2 instance out of Standby: i-95b8484f
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 30
StartTime : 11/22/2015 7:51:21 AM
StatusCode : PreInService
StatusMessage :
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ExitStandby](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ASAccountLimit`
次のコード例は、`Get-ASAccountLimit` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 AWS アカウントの Auto Scaling リソース制限について説明します。**
```
Get-ASAccountLimit
```
**出力:**
```
MaxNumberOfAutoScalingGroups : 20
MaxNumberOfLaunchConfigurations : 100
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeAccountLimits](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ASAdjustmentType`
次のコード例は、`Get-ASAdjustmentType` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Auto Scaling でサポートされている調整タイプを記述します。**
```
Get-ASAdjustmentType
```
**出力:**
```
Type
----
ChangeInCapacity
ExactCapacity
PercentChangeInCapacity
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeAdjustmentTypes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ASAutoScalingGroup`
次のコード例は、`Get-ASAutoScalingGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Auto Scaling グループの名前を一覧表示します。**
```
Get-ASAutoScalingGroup | format-table -property AutoScalingGroupName
```
**出力:**
```
AutoScalingGroupName
--------------------
my-asg-1
my-asg-2
my-asg-3
my-asg-4
my-asg-5
my-asg-6
```
**例 2: この例では、指定した Auto Scaling グループを記述します。**
```
Get-ASAutoScalingGroup -AutoScalingGroupName my-asg-1
```
**出力:**
```
AutoScalingGroupARN : arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480
f03:autoScalingGroupName/my-asg-1
AutoScalingGroupName : my-asg-1
AvailabilityZones : {us-west-2b, us-west-2a}
CreatedTime : 3/1/2015 9:05:31 AM
DefaultCooldown : 300
DesiredCapacity : 2
EnabledMetrics : {}
HealthCheckGracePeriod : 300
HealthCheckType : EC2
Instances : {my-lc}
LaunchConfigurationName : my-lc
LoadBalancerNames : {}
MaxSize : 0
MinSize : 0
PlacementGroup :
Status :
SuspendedProcesses : {}
Tags : {}
TerminationPolicies : {Default}
VPCZoneIdentifier : subnet-e4f33493,subnet-5264e837
```
**例 3: この例では、指定した 2 つの Auto Scaling グループを記述します。**
```
Get-ASAutoScalingGroup -AutoScalingGroupName @("my-asg-1", "my-asg-2")
```
**例 4: この例では、指定した Auto Scaling グループの Auto Scaling インスタンスを記述します。**
```
(Get-ASAutoScalingGroup -AutoScalingGroupName my-asg-1).Instances
```
**例 5: この例では、すべての Auto Scaling グループを記述します。**
```
Get-ASAutoScalingGroup
```
**例 6: この例では、指定した Auto Scaling グループ用の起動テンプレートを記述します。この例では、[インスタンスの購入オプション] が [起動テンプレートに準拠する] に設定されていることを前提としています。このオプションが [購入オプションとインスタンスタイプを組み合わせる] に設定されている場合、LaunchTemplate には「MixedInstancesPolicy.LaunchTemplate」プロパティを使用してアクセスできます。**
```
(Get-ASAutoScalingGroup -AutoScalingGroupName my-ag-1).LaunchTemplate
```
**出力:**
```
LaunchTemplateId LaunchTemplateName Version
---------------- ------------------ -------
lt-06095fd619cb40371 test-launch-template $Default
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeAutoScalingGroups](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ASAutoScalingInstance`
次のコード例は、`Get-ASAutoScalingInstance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例は、Auto Scaling インスタンスの ID を一覧表示します。**
```
Get-ASAutoScalingInstance | format-table -property InstanceId
```
**出力:**
```
InstanceId
----------
i-12345678
i-87654321
i-abcd1234
```
**例 2: この例では、指定した Auto Scaling インスタンスを記述します。**
```
Get-ASAutoScalingInstance -InstanceId i-12345678
```
**出力:**
```
AutoScalingGroupName : my-asg
AvailabilityZone : us-west-2b
HealthStatus : HEALTHY
InstanceId : i-12345678
LaunchConfigurationName : my-lc
LifecycleState : InService
```
**例 3: この例では、指定した 2 つの Auto Scaling インスタンスを記述します。**
```
Get-ASAutoScalingInstance -InstanceId @("i-12345678", "i-87654321")
```
**例 4: この例では、指定した Auto Scaling グループの Auto Scaling インスタンスを記述します。**
```
(Get-ASAutoScalingGroup -AutoScalingGroupName my-asg).Instances | Get-ASAutoScalingInstance
```
**例 5: この例では、すべての Auto Scaling インスタンスを記述します。**
```
Get-ASAutoScalingInstance
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeAutoScalingInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ASAutoScalingNotificationType`
次のコード例は、`Get-ASAutoScalingNotificationType` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Auto Scaling でサポートされている通知タイプを一覧表示します。**
```
Get-ASAutoScalingNotificationType
```
**出力:**
```
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeAutoScalingNotificationTypes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ASLaunchConfiguration`
次のコード例は、`Get-ASLaunchConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、起動設定の名前を一覧表示します。**
```
Get-ASLaunchConfiguration | format-table -property LaunchConfigurationName
```
**出力:**
```
LaunchConfigurationName
-----------------------
my-lc-1
my-lc-2
my-lc-3
my-lc-4
my-lc-5
```
**例 2: この例では、指定した起動設定を記述します。**
```
Get-ASLaunchConfiguration -LaunchConfigurationName my-lc-1
```
**出力:**
```
AssociatePublicIpAddress : True
BlockDeviceMappings : {/dev/xvda}
ClassicLinkVPCId :
ClassicLinkVPCSecurityGroups : {}
CreatedTime : 12/12/2014 3:22:08 PM
EbsOptimized : False
IamInstanceProfile :
ImageId : ami-043a5034
InstanceMonitoring : Amazon.AutoScaling.Model.InstanceMonitoring
InstanceType : t2.micro
KernelId :
KeyName :
LaunchConfigurationARN : arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:7e5f31e4-693b-4604-9322-
e6f68d7fafad:launchConfigurationName/my-lc-1
LaunchConfigurationName : my-lc-1
PlacementTenancy :
RamdiskId :
SecurityGroups : {sg-67ef0308}
SpotPrice :
UserData :
```
**例 3: この例では、指定した 2 つの起動設定を記述します。**
```
Get-ASLaunchConfiguration -LaunchConfigurationName @("my-lc-1", "my-lc-2")
```
**例 4: この例では、すべての起動設定を記述します。**
```
Get-ASLaunchConfiguration
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeLaunchConfigurations](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ASLifecycleHook`
次のコード例は、`Get-ASLifecycleHook` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したライフサイクルフックを記述します。**
```
Get-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook
```
**出力:**
```
AutoScalingGroupName : my-asg
DefaultResult : ABANDON
GlobalTimeout : 172800
HeartbeatTimeout : 3600
LifecycleHookName : myLifecycleHook
LifecycleTransition : auto-scaling:EC2_INSTANCE_LAUNCHING
NotificationMetadata :
NotificationTargetARN : arn:aws:sns:us-west-2:123456789012:my-topic
RoleARN : arn:aws:iam::123456789012:role/my-iam-role
```
**例 2: この例では、指定した Auto Scaling グループのすべてのライフサイクルフックを記述します。**
```
Get-ASLifecycleHook -AutoScalingGroupName my-asg
```
**例 3: この例では、すべての Auto Scaling グループのすべてのライフサイクルフックを記述します。**
```
Get-ASLifecycleHook
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeLifecycleHooks](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ASLifecycleHookType`
次のコード例は、`Get-ASLifecycleHookType` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例は、Auto Scaling でサポートされているライフサイクルフックの種類を一覧表示します。**
```
Get-ASLifecycleHookType
```
**出力:**
```
autoscaling:EC2_INSTANCE_LAUNCHING
auto-scaling:EC2_INSTANCE_TERMINATING
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeLifecycleHookTypes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ASLoadBalancer`
次のコード例は、`Get-ASLoadBalancer` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループのロードバランサーを記述します。**
```
Get-ASLoadBalancer -AutoScalingGroupName my-asg
```
**出力:**
```
LoadBalancerName State
---------------- -----
my-lb Added
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeLoadBalancers](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-ASMetricCollectionType`
次のコード例は、`Get-ASMetricCollectionType` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Auto Scaling でサポートされているメトリクスコレクションタイプを一覧表示します。**
```
(Get-ASMetricCollectionType).Metrics
```
**出力:**
```
Metric
------
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupStandbyInstances
GroupTotalInstances
```
**例 2: この例では、対応する粒度を一覧表示します。**
```
(Get-ASMetricCollectionType).Granularities
```
**出力:**
```
Granularity
-----------
1Minute
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeMetricCollectionTypes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ASNotificationConfiguration`
次のコード例は、`Get-ASNotificationConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループに関連付けられている通知アクションを記述します。**
```
Get-ASNotificationConfiguration -AutoScalingGroupName my-asg | format-list
```
**出力:**
```
AutoScalingGroupName : my-asg
NotificationType : auto-scaling:EC2_INSTANCE_LAUNCH
TopicARN : arn:aws:sns:us-west-2:123456789012:my-topic
AutoScalingGroupName : my-asg
NotificationType : auto-scaling:EC2_INSTANCE_TERMINATE
TopicARN : arn:aws:sns:us-west-2:123456789012:my-topic
```
**例 2: この例では、すべての Auto Scaling グループに関連付けられている通知アクションを記述します。**
```
Get-ASNotificationConfiguration
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeNotificationConfigurations](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ASPolicy`
次のコード例は、`Get-ASPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループのすべてのポリシーを記述します。**
```
Get-ASPolicy -AutoScalingGroupName my-asg
```
**出力:**
```
AdjustmentType : ChangeInCapacity
Alarms : {}
AutoScalingGroupName : my-asg
Cooldown : 0
EstimatedInstanceWarmup : 0
MetricAggregationType :
MinAdjustmentMagnitude : 0
MinAdjustmentStep : 0
PolicyARN : arn:aws:auto-scaling:us-west-2:123456789012:scalingPolicy:aa3836ab-5462-42c7-adab-e1d769fc24ef
:autoScalingGroupName/my-asg:policyName/myScaleInPolicy
PolicyName : myScaleInPolicy
PolicyType : SimpleScaling
ScalingAdjustment : -1
StepAdjustments : {}
```
**例 2: この例では、指定した Auto Scaling グループの指定したポリシーを記述します。**
```
Get-ASPolicy -AutoScalingGroupName my-asg -PolicyName @("myScaleOutPolicy", "myScaleInPolicy")
```
**例 3: この例では、すべての Auto Scaling グループのすべてのポリシーを記述します。**
```
Get-ASPolicy
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribePolicies](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ASScalingActivity`
次のコード例は、`Get-ASScalingActivity` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: こので例は、指定した Auto Scaling グループの過去 6 週間のスケーリングアクティビティを記述します。**
```
Get-ASScalingActivity -AutoScalingGroupName my-asg
```
**出力:**
```
ActivityId : 063308ae-aa22-4a9b-94f4-9fae4EXAMPLE
AutoScalingGroupName : my-asg
Cause : At 2015-11-22T15:45:16Z a user request explicitly set group desired capacity changing the desired
capacity from 1 to 2. At 2015-11-22T15:45:34Z an instance was started in response to a difference
between desired and actual capacity, increasing the capacity from 1 to 2.
Description : Launching a new EC2 instance: i-26e715fc
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime : 11/22/2015 7:46:09 AM
Progress : 100
StartTime : 11/22/2015 7:45:35 AM
StatusCode : Successful
StatusMessage :
ActivityId : ce719997-086d-4c73-a2f1-ab703EXAMPLE
AutoScalingGroupName : my-asg
Cause : At 2015-11-20T22:57:53Z a user request created an AutoScalingGroup changing the desired capacity
from 0 to 1. At 2015-11-20T22:57:58Z an instance was started in response to a difference betwe
en desired and actual capacity, increasing the capacity from 0 to 1.
Description : Launching a new EC2 instance: i-93633f9b
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime : 11/20/2015 2:58:32 PM
Progress : 100
StartTime : 11/20/2015 2:57:59 PM
StatusCode : Successful
StatusMessage :
```
**例 2: この例では、指定したスケーリングアクティビティを記述します。**
```
Get-ASScalingActivity -ActivityId "063308ae-aa22-4a9b-94f4-9fae4EXAMPLE"
```
**例 3: この例では、すべての Auto Scaling グループの過去 6 週間のスケーリングアクティビティを記述します。**
```
Get-ASScalingActivity
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeScalingActivities](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ASScalingProcessType`
次のコード例は、`Get-ASScalingProcessType` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Auto Scaling でサポートされているプロセスタイプを一覧表示します。**
```
Get-ASScalingProcessType
```
**出力:**
```
ProcessName
-----------
AZRebalance
AddToLoadBalancer
AlarmNotification
HealthCheck
Launch
ReplaceUnhealthy
ScheduledActions
Terminate
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeScalingProcessTypes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ASScheduledAction`
次のコード例は、`Get-ASScheduledAction` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループのスケジュールされたスケーリングアクティビティを記述します。**
```
Get-ASScheduledAction -AutoScalingGroupName my-asg
```
**出力:**
```
AutoScalingGroupName : my-asg
DesiredCapacity : 10
EndTime :
MaxSize :
MinSize :
Recurrence :
ScheduledActionARN : arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8a4c5f24-6ec6-4306-a2dd-f7
2c3af3a4d6:autoScalingGroupName/my-asg:scheduledActionName/myScheduledAction
ScheduledActionName : myScheduledAction
StartTime : 11/30/2015 8:00:00 AM
Time : 11/30/2015 8:00:00 AM
```
**例 2: この例では、指定したスケジュールされたスケーリングアクションを記述します。**
```
Get-ASScheduledAction -ScheduledActionName @("myScheduledScaleOut", "myScheduledScaleIn")
```
**例 3: この例では、指定した時刻までに開始されるスケジュールされたスケーリングアクションを記述します。**
```
Get-ASScheduledAction -StartTime "2015-12-01T08:00:00Z"
```
**例 4: この例では、指定した時刻までに終了するスケジュールされたスケーリングアクションを記述します。**
```
Get-ASScheduledAction -EndTime "2015-12-30T08:00:00Z"
```
**例 5: この例では、すべての Auto Scaling グループのスケジュールされたスケーリングアクションを記述します。**
```
Get-ASScheduledAction
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeScheduledActions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ASTag`
次のコード例は、`Get-ASTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、キー値が「myTag」または「myTag2」のタグを記述します。フィルター名に使用できる値は、「auto-scaling-group」、「key」、「value」、および「propagate-at-launch」です。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
Get-ASTag -Filter @( @{ Name="key"; Values=@("myTag", "myTag2") } )
```
**出力:**
```
Key : myTag2
PropagateAtLaunch : True
ResourceId : my-asg
ResourceType : auto-scaling-group
Value : myTagValue2
Key : myTag
PropagateAtLaunch : True
ResourceId : my-asg
ResourceType : auto-scaling-group
Value : myTagValue
```
**例 2: PowerShell バージョン 2 では、New-Object を使用してフィルターパラメータのフィルターを作成する必要があります。**
```
$keys = New-Object string[] 2
$keys[0] = "myTag"
$keys[1] = "myTag2"
$filter = New-Object Amazon.AutoScaling.Model.Filter
$filter.Name = "key"
$filter.Values = $keys
Get-ASTag -Filter @( $filter )
```
**例 3: この例では、すべての Auto Scaling グループのすべてのタグを記述します。**
```
Get-ASTag
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ASTerminationPolicyType`
次のコード例は、`Get-ASTerminationPolicyType` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Auto Scaling でサポートされている終了ポリシーを一覧表示します。**
```
Get-ASTerminationPolicyType
```
**出力:**
```
ClosestToNextInstanceHour
Default
NewestInstance
OldestInstance
OldestLaunchConfiguration
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeTerminationPolicyTypes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Mount-ASInstance`
次のコード例は、`Mount-ASInstance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したインスタンスを、指定した Auto Scaling グループにアタッチします。Auto Scaling は、Auto Scaling グループの希望する容量を自動的に増やします。**
```
Mount-ASInstance -InstanceId i-93633f9b -AutoScalingGroupName my-asg
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AttachInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-ASAutoScalingGroup`
次のコード例は、`New-ASAutoScalingGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した名前と属性で Auto Scaling グループを作成します。デフォルトの希望する容量は最小サイズになります。したがって、この Auto Scaling グループは、指定した 2 つのアベイラビリティーゾーンのそれぞれに 1 つずつ、合計 2 つのインスタンスを起動します。**
```
New-ASAutoScalingGroup -AutoScalingGroupName my-asg -LaunchConfigurationName my-lc -MinSize 2 -MaxSize 6 -AvailabilityZone @("us-west-2a", "us-west-2b")
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateAutoScalingGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-ASLaunchConfiguration`
次のコード例は、`New-ASLaunchConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、「my-lc」という名前の起動設定を作成します。この起動設定を使用する Auto Scaling グループによって起動された EC2 インスタンスは、指定されたインスタンスタイプ、AMI、セキュリティグループ、および IAM ロールを使用します。**
```
New-ASLaunchConfiguration -LaunchConfigurationName my-lc -InstanceType "m3.medium" -ImageId "ami-12345678" -SecurityGroup "sg-12345678" -IamInstanceProfile "myIamRole"
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateLaunchConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-ASAutoScalingGroup`
次のコード例は、`Remove-ASAutoScalingGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループに実行中のインスタンスがない場合、そのグループを削除します。操作を続行する前に確認画面が表示されます。**
```
Remove-ASAutoScalingGroup -AutoScalingGroupName my-asg
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASAutoScalingGroup (DeleteAutoScalingGroup)" on Target "my-asg".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**例 2: Force パラメータを指定すると、操作を続行する前に確認を求めるプロンプトが表示されません。**
```
Remove-ASAutoScalingGroup -AutoScalingGroupName my-asg -Force
```
**例 3: この例では、指定した Auto Scaling グループを削除し、そのグループに含まれる実行中のインスタンスをすべて終了します。**
```
Remove-ASAutoScalingGroup -AutoScalingGroupName my-asg -ForceDelete $true -Force
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteAutoScalingGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-ASLaunchConfiguration`
次のコード例は、`Remove-ASLaunchConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した起動設定が Auto Scaling グループにアタッチされていない場合、そのグループを削除します。操作を続行する前に確認画面が表示されます。**
```
Remove-ASLaunchConfiguration -LaunchConfigurationName my-lc
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASLaunchConfiguration (DeleteLaunchConfiguration)" on Target "my-lc".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**例 2: Force パラメータを指定すると、操作を続行する前に確認を求めるプロンプトが表示されません。**
```
Remove-ASLaunchConfiguration -LaunchConfigurationName my-lc -Force
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteLaunchConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-ASLifecycleHook`
次のコード例は、`Remove-ASLifecycleHook` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループの指定したライフサイクルフックを削除します。操作を続行する前に確認画面が表示されます。**
```
Remove-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASLifecycleHook (DeleteLifecycleHook)" on Target "myLifecycleHook".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**例 2: Force パラメータを指定すると、操作を続行する前に確認を求めるプロンプトが表示されません。**
```
Remove-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook -Force
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteLifecycleHook](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-ASNotificationConfiguration`
次のコード例は、`Remove-ASNotificationConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した通知アクションを削除します。操作を続行する前に確認画面が表示されます。**
```
Remove-ASNotificationConfiguration -AutoScalingGroupName my-asg -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic"
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASNotificationConfiguration (DeleteNotificationConfiguration)" on Target
"arn:aws:sns:us-west-2:123456789012:my-topic".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**例 2: Force パラメータを指定すると、操作を続行する前に確認を求めるプロンプトが表示されません。**
```
Remove-ASNotificationConfiguration -AutoScalingGroupName my-asg -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic" -Force
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteNotificationConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-ASPolicy`
次のコード例は、`Remove-ASPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループの指定したポリシーを削除します。操作を続行する前に確認画面が表示されます。**
```
Remove-ASPolicy -AutoScalingGroupName my-asg -PolicyName myScaleInPolicy
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASPolicy (DeletePolicy)" on Target "myScaleInPolicy".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**例 2: Force パラメータを指定すると、操作を続行する前に確認を求めるプロンプトが表示されません。**
```
Remove-ASPolicy -AutoScalingGroupName my-asg -PolicyName myScaleInPolicy -Force
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeletePolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-ASScheduledAction`
次のコード例は、`Remove-ASScheduledAction` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループの指定したスケジュールされたアクションを削除します。操作を続行する前に確認画面が表示されます。**
```
Remove-ASScheduledAction -AutoScalingGroupName my-asg -ScheduledAction "myScheduledAction"
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ASScheduledAction (DeleteScheduledAction)" on Target "myScheduledAction".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**例 2: Force パラメータを指定すると、操作を続行する前に確認を求めるプロンプトが表示されません。**
```
Remove-ASScheduledAction -AutoScalingGroupName my-asg -ScheduledAction "myScheduledAction" -Force
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteScheduledAction](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-ASTag`
次のコード例は、`Remove-ASTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループから指定したタグを削除します。操作を続行する前に確認画面が表示されます。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
Remove-ASTag -Tag @( @{ResourceType="auto-scaling-group"; ResourceId="my-asg"; Key="myTag" } )
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ASTag (DeleteTags)" on target "Amazon.AutoScaling.Model.Tag".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**例 2: Force パラメータを指定すると、操作を続行する前に確認を求めるプロンプトが表示されません。**
```
Remove-ASTag -Tag @( @{ResourceType="auto-scaling-group"; ResourceId="my-asg"; Key="myTag" } ) -Force
```
**例 3: PowerShell バージョン 2 では、New-Object を使用してタグパラメータのタグを作成する必要があります。**
```
$tag = New-Object Amazon.AutoScaling.Model.Tag
$tag.ResourceType = "auto-scaling-group"
$tag.ResourceId = "my-asg"
$tag.Key = "myTag"
Remove-ASTag -Tag $tag -Force
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Resume-ASProcess`
次のコード例は、`Resume-ASProcess` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループの指定した Auto Scaling プロセスを再開します。**
```
Resume-ASProcess -AutoScalingGroupName my-asg -ScalingProcess "AlarmNotification"
```
**例 2: この例では、指定した Auto Scaling グループの中断されたすべての Auto Scaling プロセスを再開します。**
```
Resume-ASProcess -AutoScalingGroupName my-asg
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ResumeProcesses](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Set-ASDesiredCapacity`
次のコード例は、`Set-ASDesiredCapacity` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループのサイズを設定します。**
```
Set-ASDesiredCapacity -AutoScalingGroupName my-asg -DesiredCapacity 2
```
**例 2: この例では、指定した Auto Scaling グループのサイズを設定し、クールダウン期間が完了するまで待ってから、新しいサイズにスケールします。**
```
Set-ASDesiredCapacity -AutoScalingGroupName my-asg -DesiredCapacity 2 -HonorCooldown $true
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[SetDesiredCapacity](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Set-ASInstanceHealth`
次のコード例は、`Set-ASInstanceHealth` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したインスタンスのステータスを「Unhealthy」に設定し、使用を中止します。Auto Scaling はインスタンスを終了して置き換えます。**
```
Set-ASInstanceHealth -HealthStatus Unhealthy -InstanceId i-93633f9b
```
**例 2: この例では、指定したインスタンスのステータスを「Healthy」に設定し、そのまま稼働させます。Auto Scaling グループのヘルスチェック猶予期間は無視されます。**
```
Set-ASInstanceHealth -HealthStatus Healthy -InstanceId i-93633f9b -ShouldRespectGracePeriod $false
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[SetInstanceHealth](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Set-ASInstanceProtection`
次のコード例は、`Set-ASInstanceProtection` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したインスタンスのインスタンス保護を有効にします。**
```
Set-ASInstanceProtection -AutoScalingGroupName my-asg -InstanceId i-12345678 -ProtectedFromScaleIn $true
```
**例 2: この例では、指定したインスタンスのインスタンス保護を無効にします。**
```
Set-ASInstanceProtection -AutoScalingGroupName my-asg -InstanceId i-12345678 -ProtectedFromScaleIn $false
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[SetInstanceProtection](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Set-ASTag`
次のコード例は、`Set-ASTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループに単一のタグを追加します。タグキーは「myTag」で、タグ値は「myTagValue」です。Auto Scaling は、このタグを Auto Scaling グループによって起動された後続の EC2 インスタンスに伝播します。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
Set-ASTag -Tag @( @{ResourceType="auto-scaling-group"; ResourceId="my-asg"; Key="myTag"; Value="myTagValue"; PropagateAtLaunch=$true} )
```
**例 2: PowerShell バージョン 2 では、New-Object を使用してタグパラメータのタグを作成する必要があります。**
```
$tag = New-Object Amazon.AutoScaling.Model.Tag
$tag.ResourceType = "auto-scaling-group"
$tag.ResourceId = "my-asg"
$tag.Key = "myTag"
$tag.Value = "myTagValue"
$tag.PropagateAtLaunch = $true
Set-ASTag -Tag $tag
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)*の「[CreateOrUpdateTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Start-ASPolicy`
次のコード例は、`Start-ASPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループの指定したポリシーを実行します。**
```
Start-ASPolicy -AutoScalingGroupName my-asg -PolicyName "myScaleInPolicy"
```
**例 2: この例では、クールダウン期間が完了するまで待機した後、指定した Auto Scaling グループの指定したポリシーを実行します。**
```
Start-ASPolicy -AutoScalingGroupName my-asg -PolicyName "myScaleInPolicy" -HonorCooldown $true
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ExecutePolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Stop-ASInstanceInAutoScalingGroup`
次のコード例は、`Stop-ASInstanceInAutoScalingGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したインスタンスを終了し、Auto Scaling グループの希望する容量を減らして、Auto Scaling が代替インスタンスを起動しないようにします。**
```
Stop-ASInstanceInAutoScalingGroup -InstanceId i-93633f9b -ShouldDecrementDesiredCapacity $true
```
**出力:**
```
ActivityId : 2e40d9bd-1902-444c-abf3-6ea0002efdc5
AutoScalingGroupName :
Cause : At 2015-11-22T16:09:03Z instance i-93633f9b was taken out of service in response to a user
request, shrinking the capacity from 2 to 1.
Description : Terminating EC2 instance: i-93633f9b
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 0
StartTime : 11/22/2015 8:09:03 AM
StatusCode : InProgress
StatusMessage :
```
**例 2: この例では、Auto Scaling グループの希望する容量を減らすことなく、指定したインスタンスを終了します。Auto Scaling が代替インスタンスを起動します。**
```
Stop-ASInstanceInAutoScalingGroup -InstanceId i-93633f9b -ShouldDecrementDesiredCapacity $false
```
**出力:**
```
ActivityId : 2e40d9bd-1902-444c-abf3-6ea0002efdc5
AutoScalingGroupName :
Cause : At 2015-11-22T16:09:03Z instance i-93633f9b was taken out of service in response to a user
request.
Description : Terminating EC2 instance: i-93633f9b
Details : {"Availability Zone":"us-west-2b","Subnet ID":"subnet-5264e837"}
EndTime :
Progress : 0
StartTime : 11/22/2015 8:09:03 AM
StatusCode : InProgress
StatusMessage :
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[TerminateInstanceInAutoScalingGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Suspend-ASProcess`
次のコード例は、`Suspend-ASProcess` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループの指定した Auto Scaling プロセスを中断します。**
```
Suspend-ASProcess -AutoScalingGroupName my-asg -ScalingProcess "AlarmNotification"
```
**例 2: この例では、指定した Auto Scaling グループのすべての Auto Scaling プロセスを中断します。**
```
Suspend-ASProcess -AutoScalingGroupName my-asg
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[SuspendProcesses](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-ASAutoScalingGroup`
次のコード例は、`Update-ASAutoScalingGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループの最小サイズと最大サイズを更新します。**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -MaxSize 5 -MinSize 1
```
**例 2: この例では、指定した Auto Scaling グループのデフォルトのクールダウン期間を更新します。**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -DefaultCooldown 10
```
**例 3: この例では、指定した Auto Scaling グループのアベイラビリティーゾーンを更新します。**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -AvailabilityZone @("us-west-2a", "us-west-2b")
```
**例 4: この例では、指定した Auto Scaling グループを更新して、Elastic Load Balancing のヘルスチェックを使用します。**
```
Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -HealthCheckType ELB -HealthCheckGracePeriod 60
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateAutoScalingGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Write-ASLifecycleActionHeartbeat`
次のコード例は、`Write-ASLifecycleActionHeartbeat` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したライフサイクルアクションのハートビートを記録します。これにより、カスタムアクションが完了するまでインスタンスは保留中の状態になります。**
```
Write-ASLifecycleActionHeartbeat -AutoScalingGroupName my-asg -LifecycleHookName myLifecycleHook -LifecycleActionToken bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RecordLifecycleActionHeartbeat](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Write-ASLifecycleHook`
次のコード例は、`Write-ASLifecycleHook` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したライフサイクルフックを、指定した Auto Scaling グループに追加します。**
```
Write-ASLifecycleHook -AutoScalingGroupName my-asg -LifecycleHookName "myLifecycleHook" -LifecycleTransition "autoscaling:EC2_INSTANCE_LAUNCHING" -NotificationTargetARN "arn:aws:sns:us-west-2:123456789012:my-sns-topic" -RoleARN "arn:aws:iam::123456789012:role/my-iam-role"
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[PutLifecycleHook](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Write-ASNotificationConfiguration`
次のコード例は、`Write-ASNotificationConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループが、EC2 インスタンスの起動時に指定した SNS トピックに通知を送信するように設定します。**
```
Write-ASNotificationConfiguration -AutoScalingGroupName my-asg -NotificationType "autoscaling:EC2_INSTANCE_LAUNCH" -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic"
```
**例 2: この例では、指定した Auto Scaling グループが、EC2 インスタンスの起動または終了時に、指定した SNS トピックに通知を送信するように設定します。**
```
Write-ASNotificationConfiguration -AutoScalingGroupName my-asg -NotificationType @("autoscaling:EC2_INSTANCE_LAUNCH", "autoscaling:EC2_INSTANCE_TERMINATE") -TopicARN "arn:aws:sns:us-west-2:123456789012:my-topic"
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[PutNotificationConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Write-ASScalingPolicy`
次のコード例は、`Write-ASScalingPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Auto Scaling グループに指定したポリシーを追加します。指定した調整タイプによって、ScalingAdjustment パラメータの解釈方法が決まります。「ChangeInCapacity」では、正の値を指定すると、指定したインスタンス数だけ容量が増え、負の値を指定すると、指定したインスタンス数だけ容量が減ります。**
```
Write-ASScalingPolicy -AutoScalingGroupName my-asg -AdjustmentType "ChangeInCapacity" -PolicyName "myScaleInPolicy" -ScalingAdjustment -1
```
**出力:**
```
arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:aa3836ab-5462-42c7-adab-e1d769fc24ef:autoScalingGroupName/my-asg
:policyName/myScaleInPolicy
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[PutScalingPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Write-ASScheduledUpdateGroupAction`
次のコード例は、`Write-ASScheduledUpdateGroupAction` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、1 回限りのスケジュールされたアクションを作成または更新して、指定した開始時刻に希望する容量を変更します。**
```
Write-ASScheduledUpdateGroupAction -AutoScalingGroupName my-asg -ScheduledActionName "myScheduledAction" -StartTime "2015-12-01T00:00:00Z" -DesiredCapacity 10
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[PutScheduledUpdateGroupAction](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# AWS Budgets Tools for PowerShell V5 を使用した の例
次のコード例は、 で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています AWS Budgets。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `New-BGTBudget`
次のコード例は、`New-BGTBudget` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定された予算と時間の制約を持つ新しい予算を作成し、E メール通知を設定します。**
```
$notification = @{
NotificationType = "ACTUAL"
ComparisonOperator = "GREATER_THAN"
Threshold = 80
}
$addressObject = @{
Address = @("user@domain.com")
SubscriptionType = "EMAIL"
}
$subscriber = New-Object Amazon.Budgets.Model.NotificationWithSubscribers
$subscriber.Notification = $notification
$subscriber.Subscribers.Add($addressObject)
$startDate = [datetime]::new(2017,09,25)
$endDate = [datetime]::new(2017,10,25)
New-BGTBudget -Budget_BudgetName "Tester" -Budget_BudgetType COST -CostTypes_IncludeTax $true -Budget_TimeUnit MONTHLY -BudgetLimit_Unit USD -TimePeriod_Start $startDate -TimePeriod_End $endDate -AccountId 123456789012 -BudgetLimit_Amount 200 -NotificationsWithSubscriber $subscriber
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateBudget](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# AWS Cloud9 Tools for PowerShell V5 を使用した の例
次のコード例は、 で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています AWS Cloud9。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Get-C9EnvironmentData`
次のコード例は、`Get-C9EnvironmentData` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された AWS Cloud9 開発環境に関する情報を取得します。**
```
Get-C9EnvironmentData -EnvironmentId 685f892f431b45c2b28cb69eadcdb0EX,1980b80e5f584920801c09086667f0EX
```
**出力:**
```
Arn : arn:aws:cloud9:us-east-1:123456789012:environment:685f892f431b45c2b28cb69eadcdb0EX
Description : Created from CodeStar.
Id : 685f892f431b45c2b28cb69eadcdb0EX
Lifecycle : Amazon.Cloud9.Model.EnvironmentLifecycle
Name : my-demo-ec2-env
OwnerArn : arn:aws:iam::123456789012:user/MyDemoUser
Type : ec2
Arn : arn:aws:cloud9:us-east-1:123456789012:environment:1980b80e5f584920801c09086667f0EX
Description :
Id : 1980b80e5f584920801c09086667f0EX
Lifecycle : Amazon.Cloud9.Model.EnvironmentLifecycle
Name : my-demo-ssh-env
OwnerArn : arn:aws:iam::123456789012:user/MyDemoUser
Type : ssh
```
**例 2: この例では、指定された AWS Cloud9 開発環境のライフサイクルステータスに関する情報を取得します。**
```
(Get-C9EnvironmentData -EnvironmentId 685f892f431b45c2b28cb69eadcdb0EX).Lifecycle
```
**出力:**
```
FailureResource Reason Status
--------------- ------ ------
CREATED
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeEnvironments](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-C9EnvironmentList`
次のコード例は、`Get-C9EnvironmentList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、使用可能な AWS Cloud9 開発環境識別子のリストを取得します。**
```
Get-C9EnvironmentList
```
**出力:**
```
685f892f431b45c2b28cb69eadcdb0EX
1980b80e5f584920801c09086667f0EX
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListEnvironments](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-C9EnvironmentMembershipList`
次のコード例は、`Get-C9EnvironmentMembershipList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された AWS Cloud9 開発環境の環境メンバーに関する情報を取得します。**
```
Get-C9EnvironmentMembershipList -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX
```
**出力:**
```
EnvironmentId : ffd88420d4824eeeaeaa8a04bfde8cEX
LastAccess : 1/1/0001 12:00:00 AM
Permissions : read-write
UserArn : arn:aws:iam::123456789012:user/AnotherDemoUser
UserId : AIDAJ3BA6O2FMJWCWXHEX
EnvironmentId : ffd88420d4824eeeaeaa8a04bfde8cEX
LastAccess : 1/1/0001 12:00:00 AM
Permissions : owner
UserArn : arn:aws:iam::123456789012:user/MyDemoUser
UserId : AIDAJ3LOROMOUXTBSU6EX
```
**例 2: この例では、指定された AWS Cloud9 開発環境の所有者に関する情報を取得します。**
```
Get-C9EnvironmentMembershipList -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX -Permission owner
```
**出力:**
```
EnvironmentId : ffd88420d4824eeeaeaa8a04bfde8cEX
LastAccess : 1/1/0001 12:00:00 AM
Permissions : owner
UserArn : arn:aws:iam::123456789012:user/MyDemoUser
UserId : AIDAJ3LOROMOUXTBSU6EX
```
**例 3: この例では、multiple AWS Cloud9 開発環境の指定された環境メンバーに関する情報を取得します。**
```
Get-C9EnvironmentMembershipList -UserArn arn:aws:iam::123456789012:user/MyDemoUser
```
**出力:**
```
EnvironmentId : ffd88420d4824eeeaeaa8a04bfde8cEX
LastAccess : 1/17/2018 7:48:14 PM
Permissions : owner
UserArn : arn:aws:iam::123456789012:user/MyDemoUser
UserId : AIDAJ3LOROMOUXTBSU6EX
EnvironmentId : 1980b80e5f584920801c09086667f0EX
LastAccess : 1/16/2018 11:21:24 PM
Permissions : owner
UserArn : arn:aws:iam::123456789012:user/MyDemoUser
UserId : AIDAJ3LOROMOUXTBSU6EX
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeEnvironmentMemberships](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-C9EnvironmentStatus`
次のコード例は、`Get-C9EnvironmentStatus` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された AWS Cloud9 開発環境のステータス情報を取得します。**
```
Get-C9EnvironmentStatus -EnvironmentId 349c86d4579e4e7298d500ff57a6b2EX
```
**出力:**
```
Message Status
------- ------
Environment is ready to use ready
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeEnvironmentStatus](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-C9EnvironmentEC2`
次のコード例は、`New-C9EnvironmentEC2` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された設定で AWS Cloud9 開発環境を作成し、Amazon Elastic Compute Cloud (Amazon EC2) インスタンスを起動してから、インスタンスから環境に接続します。**
```
New-C9EnvironmentEC2 -Name my-demo-env -AutomaticStopTimeMinutes 60 -Description "My demonstration development environment." -InstanceType t2.micro -OwnerArn arn:aws:iam::123456789012:user/MyDemoUser -SubnetId subnet-d43a46EX
```
**出力:**
```
ffd88420d4824eeeaeaa8a04bfde8cEX
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateEnvironmentEc2](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-C9EnvironmentMembership`
次のコード例は、`New-C9EnvironmentMembership` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された環境メンバーを指定された AWS Cloud9 開発環境に追加します。**
```
New-C9EnvironmentMembership -UserArn arn:aws:iam::123456789012:user/AnotherDemoUser -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX -Permission read-write
```
**出力:**
```
EnvironmentId : ffd88420d4824eeeaeaa8a04bfde8cEX
LastAccess : 1/1/0001 12:00:00 AM
Permissions : read-write
UserArn : arn:aws:iam::123456789012:user/AnotherDemoUser
UserId : AIDAJ3BA6O2FMJWCWXHEX
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateEnvironmentMembership](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-C9Environment`
次のコード例は、`Remove-C9Environment` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された AWS Cloud9 開発環境を削除します。環境が Amazon EC2 インスタンスに接続されている場合、インスタンスも終了します。**
```
Remove-C9Environment -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteEnvironment](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-C9EnvironmentMembership`
次のコード例は、`Remove-C9EnvironmentMembership` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された AWS Cloud9 開発環境から指定された環境メンバーを削除します。**
```
Remove-C9EnvironmentMembership -UserArn arn:aws:iam::123456789012:user/AnotherDemoUser -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteEnvironmentMembership](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-C9Environment`
次のコード例は、`Update-C9Environment` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された既存の AWS Cloud9 開発環境の指定された設定を変更します。**
```
Update-C9Environment -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX -Description "My changed demonstration development environment." -Name my-changed-demo-env
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateEnvironment](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-C9EnvironmentMembership`
次のコード例は、`Update-C9EnvironmentMembership` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された AWS Cloud9 開発環境の指定された既存の環境メンバーの設定を変更します。**
```
Update-C9EnvironmentMembership -UserArn arn:aws:iam::123456789012:user/AnotherDemoUser -EnvironmentId ffd88420d4824eeeaeaa8a04bfde8cEX -Permission read-only
```
**出力:**
```
EnvironmentId : ffd88420d4824eeeaeaa8a04bfde8cEX
LastAccess : 1/1/0001 12:00:00 AM
Permissions : read-only
UserArn : arn:aws:iam::123456789012:user/AnotherDemoUser
UserId : AIDAJ3BA6O2FMJWCWXHEX
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateEnvironmentMembership](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# CloudFormation Tools for PowerShell V5 を使用した の例
次のコード例は、 で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています CloudFormation。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Get-CFNStack`
次のコード例は、`Get-CFNStack` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: ユーザーのスタックのすべてを記述するスタックインスタンスのコレクションを返します。**
```
Get-CFNStack
```
**例 2: 指定されたスタックを記述するスタックインスタンスを返します。**
```
Get-CFNStack -StackName "myStack"
```
+ API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[DescribeStacks](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFNStackEvent`
次のコード例は、`Get-CFNStackEvent` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたスタックに関するすべてのスタック関連イベントを返します。**
```
Get-CFNStackEvent -StackName "myStack"
```
+ API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[DescribeStackEvents](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFNStackResource`
次のコード例は、`Get-CFNStackResource` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 論理 ID「MyDBInstance」を使用して、指定されたスタックに関連付けられているテンプレートで識別されたリソースの説明を返します。**
```
Get-CFNStackResource -StackName "myStack" -LogicalResourceId "MyDBInstance"
```
+ API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[DescribeStackResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFNStackResourceList`
次のコード例は、`Get-CFNStackResourceList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたスタックに関連付けられた最大 100 個の AWS リソースのリソースの説明を返します。スタックに関連付けられているすべてのリソースの詳細情報を取得するには、Get-CFNStackResourceSummary を使用します。これは、結果の手動ページングもサポートしています。**
```
Get-CFNStackResourceList -StackName "myStack"
```
**例 2: 論理 ID「Ec2Instance」を使用して、指定されたスタックに関連付けられているテンプレートで識別された Amazon EC2 インスタンスの説明を返します。**
```
Get-CFNStackResourceList -StackName "myStack" -LogicalResourceId "Ec2Instance"
```
**例 3: インスタンス ID「i-123456」で識別される Amazon EC2 インスタンスが含まれるスタックに関連付けられた、最大 100 個のリソースの説明を返します。スタックに関連付けられているすべてのリソースの詳細情報を取得するには、Get-CFNStackResourceSummary を使用します。これは、結果の手動ページングもサポートしています。**
```
Get-CFNStackResourceList -PhysicalResourceId "i-123456"
```
**例 4: スタックのテンプレートで論理 ID「Ec2Instance」によって識別される Amazon EC2 インスタンスの説明を返します。スタックは、スタックに含まれるリソースの物理リソース ID を使用して識別され、この場合はインスタンス ID が「i-123456」の Amazon EC2 インスタンスも含まれます。テンプレートのコンテンツによっては、スタックの識別に異なる物理リソース (Amazon S3 バケットなど) を使用することもできます。**
```
Get-CFNStackResourceList -PhysicalResourceId "i-123456" -LogicalResourceId "Ec2Instance"
```
+ API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[DescribeStackResources](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFNStackResourceSummary`
次のコード例は、`Get-CFNStackResourceSummary` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたスタックに関連付けられているすべてのリソースの説明を返します。**
```
Get-CFNStackResourceSummary -StackName "myStack"
```
+ API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[ListStackResources](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFNStackSummary`
次のコード例は、`Get-CFNStackSummary` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: すべてのスタックの概要情報を返します。**
```
Get-CFNStackSummary
```
**例 2: 現在作成中のすべてのスタックの概要情報を返します。**
```
Get-CFNStackSummary -StackStatusFilter "CREATE_IN_PROGRESS"
```
**例 3: 現在作成中または更新中のすべてのスタックの概要情報を返します。**
```
Get-CFNStackSummary -StackStatusFilter @("CREATE_IN_PROGRESS", "UPDATE_IN_PROGRESS")
```
+ API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[ListStacks](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFNTemplate`
次のコード例は、`Get-CFNTemplate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたスタックに関連付けられているテンプレートを返します。**
```
Get-CFNTemplate -StackName "myStack"
```
+ API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[GetTemplate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Measure-CFNTemplateCost`
次のコード例は、`Measure-CFNTemplateCost` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: テンプレートの実行に必要なリソースを記述するクエリ文字列を含む AWS Simple Monthly Calculator URL を返します。テンプレートは指定された Amazon S3 URL から取得され、単一のカスタマイゼーションパラメータが適用されます。パラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。**
```
Measure-CFNTemplateCost -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
-Region us-west-1 `
-Parameter @{ ParameterKey="KeyName"; ParameterValue="myKeyPairName" }
```
**例 2: テンプレートの実行に必要なリソースを記述するクエリ文字列を含む AWS Simple Monthly Calculator URL を返します。テンプレートは提供されたコンテンツから解析され、カスタマイゼーションパラメータが適用されます (この例は、テンプレートコンテンツが「KeyName」と「InstanceType」の 2 つのパラメータを宣言していることを前提としています)。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。**
```
Measure-CFNTemplateCost -TemplateBody "{TEMPLATE CONTENT HERE}" `
-Parameter @( @{ ParameterKey="KeyName"; ParameterValue="myKeyPairName" },`
@{ ParameterKey="InstanceType"; ParameterValue="m1.large" })
```
**例 3: New-Object を使用してテンプレートパラメータのセットを構築し、テンプレートの実行に必要なリソースを記述するクエリ文字列を含む AWS Simple Monthly Calculator URL を返します。テンプレートは、カスタマイゼーションパラメータを使用して、提供されたコンテンツから解析されます (この例は、テンプレートコンテンツが「KeyName」と「InstanceType」の 2 つのパラメータを宣言していることを前提としています)。**
```
$p1 = New-Object -Type Amazon.CloudFormation.Model.Parameter
$p1.ParameterKey = "KeyName"
$p1.ParameterValue = "myKeyPairName"
$p2 = New-Object -Type Amazon.CloudFormation.Model.Parameter
$p2.ParameterKey = "InstanceType"
$p2.ParameterValue = "m1.large"
Measure-CFNTemplateCost -TemplateBody "{TEMPLATE CONTENT HERE}" -Parameter @( $p1, $p2 )
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[EstimateTemplateCost](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-CFNStack`
次のコード例は、`New-CFNStack` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定された名前を使用して新しいスタックを作成します。テンプレートは、カスタマイゼーションパラメータを使用して、提供されたコンテンツから解析されます (「PK1」と「PK2」はテンプレートコンテンツで宣言されたパラメータの名前を表し、「PV1」と「PV2」はこれらのパラメータの値を表します)。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。スタックの作成に失敗しても、スタックはロールバックされません。**
```
New-CFNStack -StackName "myStack" `
-TemplateBody "{TEMPLATE CONTENT HERE}" `
-Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" }) `
-DisableRollback $true
```
**例 2: 指定された名前を使用して新しいスタックを作成します。テンプレートは、カスタマイゼーションパラメータを使用して、提供されたコンテンツから解析されます (「PK1」と「PK2」はテンプレートコンテンツで宣言されたパラメータの名前を表し、「PV1」と「PV2」はこれらのパラメータの値を表します)。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。スタックの作成に失敗すると、スタックがロールバックされます。**
```
$p1 = New-Object -Type Amazon.CloudFormation.Model.Parameter
$p1.ParameterKey = "PK1"
$p1.ParameterValue = "PV1"
$p2 = New-Object -Type Amazon.CloudFormation.Model.Parameter
$p2.ParameterKey = "PK2"
$p2.ParameterValue = "PV2"
New-CFNStack -StackName "myStack" `
-TemplateBody "{TEMPLATE CONTENT HERE}" `
-Parameter @( $p1, $p2 ) `
-OnFailure "ROLLBACK"
```
**例 3: 指定された名前を使用して新しいスタックを作成します。テンプレートは、カスタマイゼーションパラメータを使用して、Amazon S3 URL から取得されます (「PK1」はテンプレートコンテンツで宣言されたパラメータの名前を表し、「PV1」はパラメータの値を表します)。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。スタックの作成に失敗すると、スタックがロールバックされます (-DisableRollback \$1false を指定する場合と同じです)**。
```
New-CFNStack -StackName "myStack" `
-TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
-Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" }
```
**例 4: 指定された名前を使用して新しいスタックを作成します。テンプレートは、カスタマイゼーションパラメータを使用して、Amazon S3 URL から取得されます (「PK1」はテンプレートコンテンツで宣言されたパラメータの名前を表し、「PV1」はパラメータの値を表します)。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。スタックの作成に失敗すると、スタックがロールバックされます (-DisableRollback \$1false を指定する場合と同じです)。指定された通知 AEN は、公開されたスタック関連のイベントを受け取ります。**
```
New-CFNStack -StackName "myStack" `
-TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
-Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" } `
-NotificationARN @( "arn1", "arn2" )
```
+ API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[CreateStack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-CFNStack`
次のコード例は、`Remove-CFNStack` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたスタックを削除します。**
```
Remove-CFNStack -StackName "myStack"
```
+ API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[DeleteStack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Resume-CFNUpdateRollback`
次のコード例は、`Resume-CFNUpdateRollback` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたスタックのロールバックを続行します。このスタックの状態は「UPDATE\$1ROLLBACK\$1FAILED」になっている必要があります。続行されたロールバックが成功すると、スタックの状態が「UPDATE\$1ROLLBACK\$1COMPLETE」になります。**
```
Resume-CFNUpdateRollback -StackName "myStack"
```
+ API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[ContinueUpdateRollback](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Stop-CFNUpdateStack`
次のコード例は、`Stop-CFNUpdateStack` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたスタックで行われている更新をキャンセルします。**
```
Stop-CFNUpdateStack -StackName "myStack"
```
+ API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[CancelUpdateStack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Test-CFNStack`
次のコード例は、`Test-CFNStack` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: スタックが UPDATE\$1ROLLBACK\$1COMPLETE、CREATE\$1COMPLETE、ROLLBACK\$1COMPLETE、または UPDATE\$1COMPLETE のいずれかの状態に達したかどうかをテストします。**
```
Test-CFNStack -StackName MyStack
```
**出力:**
```
False
```
**例 2: スタックが UPDATE\$1COMPLETE または UPDATE\$1ROLLBACK\$1COMPLETE のいずれかの状態に達したかどうかをテストします。**
```
Test-CFNStack -StackName MyStack -Status UPDATE_COMPLETE,UPDATE_ROLLBACK_COMPLETE
```
**出力:**
```
True
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[Test-CFNStack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Test-CFNTemplate`
次のコード例は、`Test-CFNTemplate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたテンプレートコンテンツを検証します。出力は、テンプレートの機能、説明、パラメータを詳しく説明します。**
```
Test-CFNTemplate -TemplateBody "{TEMPLATE CONTENT HERE}"
```
**例 2: Amazon S3 URL 経由でアクセスされる、指定されたテンプレートを検証します。出力は、テンプレートの機能、説明、パラメータを詳しく説明します。**
```
Test-CFNTemplate -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template
```
+ API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[ValidateTemplate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-CFNStack`
次のコード例は、`Update-CFNStack` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたテンプレートとカスタマイゼーションパラメータでスタック「MyStack」を更新します。「PK1」はテンプレートで宣言されているパラメータの名前を表し、「PV1」はその値を表します。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。**
```
Update-CFNStack -StackName "myStack" `
-TemplateBody "{Template Content Here}" `
-Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" }
```
**例 2: 指定されたテンプレートとカスタマイゼーションパラメータでスタック「MyStack」を更新します。「PK1」と「PK2」はテンプレートで宣言されているパラメータの名前を表し、「PV1」と「PV2」はそれらの要求された値を表します。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。**
```
Update-CFNStack -StackName "myStack" `
-TemplateBody "{Template Content Here}" `
-Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } )
```
**例 3: 指定されたテンプレートとカスタマイゼーションパラメータでスタック「MyStack」を更新します。「PK1」はテンプレートで宣言されているパラメータの名前を表し、「PV2」はその値を表します。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。**
```
Update-CFNStack -StackName "myStack" -TemplateBody "{Template Content Here}" -Parameters @{ ParameterKey="PK1"; ParameterValue="PV1" }
```
**例 4: 指定されたテンプレート (Amazon S3 から取得されたもの) とカスタマイゼーションパラメータでスタック「MyStack」を更新します。「PK1」と「PK2」はテンプレートで宣言されているパラメータの名前を表し、「PV1」と「PV2」はそれらの要求された値を表します。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。**
```
Update-CFNStack -StackName "myStack" `
-TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
-Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } )
```
**例 5: 指定されたテンプレート (Amazon S3 から取得されたもの) とカスタマイゼーションパラメータでスタック「MyStack」(この例では IAM リソースが含まれていることを想定) を更新します。「PK1」と「PK2」はテンプレートで宣言されているパラメータの名前を表し、「PV1」と「PV2」はそれらの要求された値を表します。カスタマイゼーションパラメータは、「ParameterKey」と「ParameterValue」の代わりに、「Key」と「Value」を使用して指定することもできます。IAM リソースが含まれるスタックでは、-Capabilities「CAPABILITY\$1IAM」パラメータを指定する必要があります。指定されていない場合は、更新が「InsufficientCapabilities」エラーで失敗します。**
```
Update-CFNStack -StackName "myStack" `
-TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
-Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } ) `
-Capabilities "CAPABILITY_IAM"
```
+ API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[UpdateStack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Wait-CFNStack`
次のコード例は、`Wait-CFNStack` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: スタックが UPDATE\$1ROLLBACK\$1COMPLETE、CREATE\$1COMPLETE、ROLLBACK\$1COMPLETE、または UPDATE\$1COMPLETE のいずれかの状態に達したかどうかをテストします。スタックがいずれかの状態にも達していない場合、コマンドは 2 秒間スリープしてから再度ステータスをテストします。これは、スタックがリクエストされた状態のいずれかに達するか、デフォルトのタイムアウト期間である 60 秒を経過するまで繰り返されます。タイムアウト期間を超えると、例外がスローされます。スタックがタイムアウト期間内にリクエストされた状態のいずれかに達すると、パイプラインに返されます。**
```
$stack = Wait-CFNStack -StackName MyStack
```
**例 2: この例では、スタックが指定の状態のいずれかに達するまで合計 5 分 (300 秒) 待機します。この例では、タイムアウトの前にいずれかの状態に達しているため、スタックオブジェクトはパイプラインに返されます。**
```
Wait-CFNStack -StackName MyStack -Timeout 300 -Status CREATE_COMPLETE,ROLLBACK_COMPLETE
```
**出力:**
```
Capabilities : {CAPABILITY_IAM}
ChangeSetId :
CreationTime : 6/1/2017 9:29:33 AM
Description : AWS CloudFormation Sample Template ec2_instance_with_instance_profile: Create an EC2 instance with an associated instance profile. **WARNING** This template creates one or more Amazon EC2
instances and an Amazon SQS queue. You will be billed for the AWS resources used if you create a stack from this template.
DisableRollback : False
LastUpdatedTime : 1/1/0001 12:00:00 AM
NotificationARNs : {}
Outputs : {}
Parameters : {}
RoleARN :
StackId : arn:aws:cloudformation:us-west-2:123456789012:stack/MyStack/7ea87b50-46e7-11e7-9c9b-503a90a9c4d1
StackName : MyStack
StackStatus : CREATE_COMPLETE
StackStatusReason :
Tags : {}
TimeoutInMinutes : 0
```
**例 3: この例では、スタックがタイムアウト期間 (この場合はデフォルト期間 60 秒) 内にリクエストされた状態のいずれかに達しなかった場合のエラー出力を示します。**
```
Wait-CFNStack -StackName MyStack -Status CREATE_COMPLETE,ROLLBACK_COMPLETE
```
**出力:**
```
Wait-CFNStack : Timed out after 60 seconds waiting for CloudFormation stack MyStack in region us-west-2 to reach one of state(s): UPDATE_ROLLBACK_COMPLETE,CREATE_COMPLETE,ROLLBACK_COMPLETE,UPDATE_COMPLETE
At line:1 char:1
+ Wait-CFNStack -StackName MyStack -State CREATE_COMPLETE,ROLLBACK_COMPLETE
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : InvalidOperation: (Amazon.PowerShe...tCFNStackCmdlet:WaitCFNStackCmdlet) [Wait-CFNStack], InvalidOperationException
+ FullyQualifiedErrorId : InvalidOperationException,Amazon.PowerShell.Cmdlets.CFN.WaitCFNStackCmdlet
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[Wait-CFNStack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した CloudFront の例
次のコード例は、CloudFront で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Get-CFCloudFrontOriginAccessIdentity`
次のコード例は、`Get-CFCloudFrontOriginAccessIdentity` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、-Id パラメータで指定した、特定の Amazon CloudFront オリジンアクセスアイデンティティを返します。-Id パラメータは必須ではありませんが、指定しないと、結果は返されません。**
```
Get-CFCloudFrontOriginAccessIdentity -Id E3XXXXXXXXXXRT
```
**出力:**
```
CloudFrontOriginAccessIdentityConfig Id S3CanonicalUserId
------------------------------------ -- -----------------
Amazon.CloudFront.Model.CloudFrontOr... E3XXXXXXXXXXRT 4b6e...
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetCloudFrontOriginAccessIdentity](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFCloudFrontOriginAccessIdentityConfig`
次のコード例は、`Get-CFCloudFrontOriginAccessIdentityConfig` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、-Id パラメータで指定した、単一の Amazon CloudFront オリジンアクセスアイデンティティに関する設定情報を返します。-Id パラメータを指定しないと、エラーが発生します。**
```
Get-CFCloudFrontOriginAccessIdentityConfig -Id E3XXXXXXXXXXRT
```
**出力:**
```
CallerReference Comment
--------------- -------
mycallerreference: 2/1/2011 1:16:32 PM Caller reference: 2/1/2011 1:16:32 PM
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetCloudFrontOriginAccessIdentityConfig](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFCloudFrontOriginAccessIdentityList`
次のコード例は、`Get-CFCloudFrontOriginAccessIdentityList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Amazon CloudFront オリジンアクセスアイデンティティのリストを返します。-MaxItem パラメータは値として 2 を指定しているため、結果には 2 つのアイデンティティが含まれます。**
```
Get-CFCloudFrontOriginAccessIdentityList -MaxItem 2
```
**出力:**
```
IsTruncated : True
Items : {E326XXXXXXXXXT, E1YWXXXXXXX9B}
Marker :
MaxItems : 2
NextMarker : E1YXXXXXXXXX9B
Quantity : 2
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListCloudFrontOriginAccessIdentities](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFDistribution`
次のコード例は、`Get-CFDistribution` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 特定のディストリビューションに関する情報を取得します。**
```
Get-CFDistribution -Id EXAMPLE0000ID
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetDistribution](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFDistributionConfig`
次のコード例は、`Get-CFDistributionConfig` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 特定のディストリビューションの設定を取得します。**
```
Get-CFDistributionConfig -Id EXAMPLE0000ID
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetDistributionConfig](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFDistributionList`
次のコード例は、`Get-CFDistributionList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: ディストリビューションを返します。**
```
Get-CFDistributionList
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListDistributions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-CFDistribution`
次のコード例は、`New-CFDistribution` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: ロギングとキャッシュを使用して設定した、基本的な CloudFront ディストリビューションを作成します。**
```
$origin = New-Object Amazon.CloudFront.Model.Origin
$origin.DomainName = "amzn-s3-demo-bucket.s3.amazonaws.com"
$origin.Id = "UniqueOrigin1"
$origin.S3OriginConfig = New-Object Amazon.CloudFront.Model.S3OriginConfig
$origin.S3OriginConfig.OriginAccessIdentity = ""
New-CFDistribution `
-DistributionConfig_Enabled $true `
-DistributionConfig_Comment "Test distribution" `
-Origins_Item $origin `
-Origins_Quantity 1 `
-Logging_Enabled $true `
-Logging_IncludeCookie $true `
-Logging_Bucket amzn-s3-demo-logging-bucket.s3.amazonaws.com `
-Logging_Prefix "help/" `
-DistributionConfig_CallerReference Client1 `
-DistributionConfig_DefaultRootObject index.html `
-DefaultCacheBehavior_TargetOriginId $origin.Id `
-ForwardedValues_QueryString $true `
-Cookies_Forward all `
-WhitelistedNames_Quantity 0 `
-TrustedSigners_Enabled $false `
-TrustedSigners_Quantity 0 `
-DefaultCacheBehavior_ViewerProtocolPolicy allow-all `
-DefaultCacheBehavior_MinTTL 1000 `
-DistributionConfig_PriceClass "PriceClass_All" `
-CacheBehaviors_Quantity 0 `
-Aliases_Quantity 0
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateDistribution](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-CFInvalidation`
次のコード例は、`New-CFInvalidation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ID が EXAMPLENSTXAXE であるディストリビューションで、新しいキャッシュ削除を作成します。CallerReference はユーザーが選択した固有の ID です。この例では、2019 年 5 月 15 日の午前 9 時を表すタイムスタンプを使用しています。\$1Paths 変数には、ユーザーがディストリビューションのキャッシュに含めたくない画像ファイルやメディアファイルへの 3 つのパスが格納されます。-Paths\$1Quantity パラメータ値は、-Paths\$1Item パラメータで指定したパスの総数です。**
```
$Paths = "/images/*.gif", "/images/image1.jpg", "/videos/*.mp4"
New-CFInvalidation -DistributionId "EXAMPLENSTXAXE" -InvalidationBatch_CallerReference 20190515090000 -Paths_Item $Paths -Paths_Quantity 3
```
**出力:**
```
Invalidation Location
------------ --------
Amazon.CloudFront.Model.Invalidation https://cloudfront.amazonaws.com/2018-11-05/distribution/EXAMPLENSTXAXE/invalidation/EXAMPLE8NOK9H
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateInvalidation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-CFSignedCookie`
次のコード例は、`New-CFSignedCookie` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 既定ポリシーを使用して、指定されたリソースに署名付き Cookie を作成します。Cookie は 1 年間有効です。**
```
$params = @{
"ResourceUri"="http://xyz.cloudfront.net/image1.jpeg"
"KeyPairId"="AKIAIOSFODNN7EXAMPLE"
"PrivateKeyFile"="C:\pk-AKIAIOSFODNN7EXAMPLE.pem"
"ExpiresOn"=(Get-Date).AddYears(1)
}
New-CFSignedCookie @params
```
**出力:**
```
Expires
-------
[CloudFront-Expires, 1472227284]
```
**例 2: カスタムポリシーを使用して、指定リソースに署名付き Cookie を作成します。Cookie は 24 時間後に有効になり、1 週間後に期限切れになります。**
```
$start = (Get-Date).AddHours(24)
$params = @{
"ResourceUri"="http://xyz.cloudfront.net/content/*.jpeg"
"KeyPairId"="AKIAIOSFODNN7EXAMPLE"
"PrivateKeyFile"="C:\pk-AKIAIOSFODNN7EXAMPLE.pem"
"ExpiresOn"=$start.AddDays(7)
"ActiveFrom"=$start
}
New-CFSignedCookie @params
```
**出力:**
```
Policy
------
[CloudFront-Policy, eyJTd...wIjo...
```
**例 3: カスタムポリシーを使用して、指定リソースに署名付き Cookie を作成します。Cookie は 24 時間後に有効になり、1 週間後に期限切れになります。リソースへのアクセスは、指定の IP 範囲に制限されます。**
```
$start = (Get-Date).AddHours(24)
$params = @{
"ResourceUri"="http://xyz.cloudfront.net/content/*.jpeg"
"KeyPairId"="AKIAIOSFODNN7EXAMPLE"
"PrivateKeyFile"="C:\pk-AKIAIOSFODNN7EXAMPLE.pem"
"ExpiresOn"=$start.AddDays(7)
"ActiveFrom"=$start
"IpRange"="192.0.2.0/24"
}
New-CFSignedCookie @params
```
**出力:**
```
Policy ------ [CloudFront-Policy, eyJTd...wIjo...
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[New-CFSignedCookie](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-CFSignedUrl`
次のコード例は、`New-CFSignedUrl` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 既定ポリシーを使用して、指定リソースへの署名付き URL を作成します。URL は 1 時間有効です。署名付き URL を含む System.Uri オブジェクトがパイプラインに出力されます。**
```
$params = @{
"ResourceUri"="https://cdn.example.com/index.html"
"KeyPairId"="AKIAIOSFODNN7EXAMPLE"
"PrivateKeyFile"="C:\pk-AKIAIOSFODNN7EXAMPLE.pem"
"ExpiresOn"=(Get-Date).AddHours(1)
}
New-CFSignedUrl @params
```
**例 2: カスタムポリシーを使用して、指定リソースへの署名付き URL を作成します。URL は 24 時間後に有効になり、1 週間後に期限切れになります。**
```
$start = (Get-Date).AddHours(24)
$params = @{
"ResourceUri"="https://cdn.example.com/index.html"
"KeyPairId"="AKIAIOSFODNN7EXAMPLE"
"PrivateKeyFile"="C:\pk-AKIAIOSFODNN7EXAMPLE.pem"
"ExpiresOn"=(Get-Date).AddDays(7)
"ActiveFrom"=$start
}
New-CFSignedUrl @params
```
**例 3: カスタムポリシーを使用して、指定リソースへの署名付き URL を作成します。URL は 24 時間後に有効になり、1 週間後に期限切れになります。リソースへのアクセスは、指定の IP 範囲に制限されます。**
```
$start = (Get-Date).AddHours(24)
$params = @{
"ResourceUri"="https://cdn.example.com/index.html"
"KeyPairId"="AKIAIOSFODNN7EXAMPLE"
"PrivateKeyFile"="C:\pk-AKIAIOSFODNN7EXAMPLE.pem"
"ExpiresOn"=(Get-Date).AddDays(7)
"ActiveFrom"=$start
"IpRange"="192.0.2.0/24"
}
New-CFSignedUrl @params
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[New-CFSignedUrl](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した CloudTrail の例
次のコード例は、CloudTrail で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Find-CTEvent`
次のコード例は、`Find-CTEvent` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 過去 7 日間に発生したすべてのイベントを返します。コマンドレットはデフォルトで、すべてのイベントを配信するために複数の呼び出しを自動的に実行し、サービスがこれ以上データがないことを示した時点で終了します。**
```
Find-CTEvent
```
**例 2: 現在のシェルのデフォルト以外のリージョンを指定して、過去 7 日間に発生したすべてのイベントを返します。**
```
Find-CTEvent -Region eu-central-1
```
**例 3: RunInstances API コールに関連付けられているすべてのイベントを返します。**
```
Find-CTEvent -LookupAttribute @{ AttributeKey="EventName"; AttributeValue="RunInstances" }
```
**例 4: 使用可能な最初の 5 つのイベントを返します。**
```
Find-CTEvent -MaxResult 5
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[LookupEvents](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CTTrail`
次のコード例は、`Get-CTTrail` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: アカウントの現在のリージョンに関連付けられているすべての証跡の設定を返します。**
```
Get-CTTrail
```
**例 2: 指定された証跡の設定を返します。**
```
Get-CTTrail -TrailNameList trail1,trail2
```
**例 3: 現在のシェルのデフォルト (この場合はフランクフルト (eu-central-1) リージョン) 以外のリージョンで作成された、指定された証跡の設定を返します。**
```
Get-CTTrail -TrailNameList trailABC,trailDEF -Region eu-central-1
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeTrails](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CTTrailStatus`
次のコード例は、`Get-CTTrailStatus` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 「myExampleTrail」という名前の証跡のステータス情報を返します。返されるデータには、配信エラー、Amazon SNS および Amazon S3 エラー、証跡のログ記録の開始時間と停止時間に関する情報が含まれます。この例では、証跡が現在のシェルのデフォルトリージョンと同じリージョンで作成されたことを前提としています。**
```
Get-CTTrailStatus -Name myExampleTrail
```
**例 2: 現在のシェルのデフォルト (この場合はフランクフルト (eu-central-1) リージョン) 以外のリージョンで作成された証跡のステータス情報を返します。**
```
Get-CTTrailStatus -Name myExampleTrail -Region eu-central-1
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetTrailStatus](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-CTTrail`
次のコード例は、`New-CTTrail` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: ログファイルストレージにバケット「amzn-s3-demo-bucket」を使用する証跡を作成します。**
```
New-CTTrail -Name "awscloudtrail-example" -S3BucketName "amzn-s3-demo-bucket"
```
**例 2: ログファイルストレージにバケット「amzn-s3-demo-bucket」を使用する証跡を作成します。ログを表す S3 オブジェクトには、共通キープレフィックス「mylogs」があります。新しいログがバケットに配信されると、SNS トピック「mlog-deliverytopic」に通知が送信されます。この例では、スプラッティングを使用してパラメータ値をコマンドレットに指定します。**
```
$params = @{
Name="awscloudtrail-example"
S3BucketName="amzn-s3-demo-bucket"
S3KeyPrefix="mylogs"
SnsTopicName="mlog-deliverytopic"
}
New-CTTrail @params
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateTrail](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-CTTrail`
次のコード例は、`Remove-CTTrail` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定された証跡を削除します。コマンドを実行する前に確認を求められます。-Force スイッチを追加すると、確認メッセージが表示されなくなります。**
```
Remove-CTTrail -Name "awscloudtrail-example"
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteTrail](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Start-CTLogging`
次のコード例は、`Start-CTLogging` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 'myExampleTrail' という名前の証跡の AWS API コールとログファイルの配信の記録を開始します。この例では、証跡が現在のシェルのデフォルトリージョンと同じリージョンで作成されたことを前提としています。**
```
Start-CTLogging -Name myExampleTrail
```
**例 2: 現在のシェルデフォルト (この場合はフランクフルト (eu-central-1) リージョン) 以外のリージョンで作成された証跡の AWS API コールとログファイルの配信の記録を開始します。**
```
Start-CTLogging -Name myExampleTrail -Region eu-central-1
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[StartLogging](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Stop-CTLogging`
次のコード例は、`Stop-CTLogging` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 'myExampleTrail' という名前の証跡の AWS API コールとログファイル配信の記録を停止します。この例では、証跡が現在のシェルのデフォルトリージョンと同じリージョンで作成されたことを前提としています。**
```
Stop-CTLogging -Name myExampleTrail
```
**例 2: 現在のシェルデフォルト (この場合はフランクフルト (eu-central-1) リージョン) 以外のリージョンで作成された証跡の AWS API コールとログファイル配信の記録を停止します。**
```
Stop-CTLogging -Name myExampleTrail -Region eu-central-1
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[StopLogging](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-CTTrail`
次のコード例は、`Update-CTTrail` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: グローバルサービスイベント (IAM からのイベントなど) が記録されるように指定された証跡を更新し、以降のログファイルの共通キープレフィックスを「globallogs」に変更します。**
```
Update-CTTrail -Name "awscloudtrail-example" -IncludeGlobalServiceEvents $true -S3KeyPrefix "globallogs"
```
**例 2: 新しいログ配信に関する通知が指定された SNS トピックに送信されるように、指定された証跡を更新します。**
```
Update-CTTrail -Name "awscloudtrail-example" -SnsTopicName "mlog-deliverytopic2"
```
**例 3: ログが別のバケットに配信されるように、指定された証跡を更新します。**
```
Update-CTTrail -Name "awscloudtrail-example" -S3BucketName "otherlogs"
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateTrail](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した CloudWatch の例
次のコード例は、CloudWatch で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Get-CWDashboard`
次のコード例は、`Get-CWDashboard` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたダッシュボードの本体である arn を返します。**
```
Get-CWDashboard -DashboardName Dashboard1
```
**出力:**
```
DashboardArn DashboardBody
------------ -------------
arn:aws:cloudwatch::123456789012:dashboard/Dashboard1 {...
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetDashboard](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CWDashboardList`
次のコード例は、`Get-CWDashboardList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: アカウントのダッシュボードのコレクションを返します。**
```
Get-CWDashboardList
```
**出力:**
```
DashboardArn DashboardName LastModified Size
------------ ------------- ------------ ----
arn:... Dashboard1 7/6/2017 8:14:15 PM 252
```
**例 2: 名前が 'dev' で始まるアカウントのダッシュボードのコレクションを返します。**
```
Get-CWDashboardList -DashboardNamePrefix dev
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListDashboards](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-CWDashboard`
次のコード例は、`Remove-CWDashboard` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定したダッシュボードを削除し、次に進む前に確認を促します。確認を省略するには、-Force スイッチをコマンドに追加します。**
```
Remove-CWDashboard -DashboardName Dashboard1
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteDashboards](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Write-CWDashboard`
次のコード例は、`Write-CWDashboard` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 'Dashboard1' という名前のダッシュボードを作成または更新して、2 つのメトリクスウィジェットを並べて表示します。**
```
$dashBody = @"
{
"widgets":[
{
"type":"metric",
"x":0,
"y":0,
"width":12,
"height":6,
"properties":{
"metrics":[
[
"AWS/EC2",
"CPUUtilization",
"InstanceId",
"i-012345"
]
],
"period":300,
"stat":"Average",
"region":"us-east-1",
"title":"EC2 Instance CPU"
}
},
{
"type":"metric",
"x":12,
"y":0,
"width":12,
"height":6,
"properties":{
"metrics":[
[
"AWS/S3",
"BucketSizeBytes",
"BucketName",
"amzn-s3-demo-bucket"
]
],
"period":86400,
"stat":"Maximum",
"region":"us-east-1",
"title":"amzn-s3-demo-bucket bytes"
}
}
]
}
"@
Write-CWDashboard -DashboardName Dashboard1 -DashboardBody $dashBody
```
**例 2: ダッシュボードを作成または更新し、ダッシュボードを説明するコンテンツをコマンドレットにパイプします。**
```
$dashBody = @"
{
...
}
"@
$dashBody | Write-CWDashboard -DashboardName Dashboard1
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[PutDashboard](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Write-CWMetricData`
次のコード例は、`Write-CWMetricData` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 新しい MetricDatum オブジェクトを作成し、Amazon Web Services の CloudWatch メトリクスに書き込みます。**
```
### Create a MetricDatum .NET object
$Metric = New-Object -TypeName Amazon.CloudWatch.Model.MetricDatum
$Metric.Timestamp = [DateTime]::UtcNow
$Metric.MetricName = 'CPU'
$Metric.Value = 50
### Write the metric data to the CloudWatch service
Write-CWMetricData -Namespace instance1 -MetricData $Metric
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[PutMetricData](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した CodeCommit の例
次のコード例は、CodeCommit で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Get-CCBranch`
次のコード例は、`Get-CCBranch` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリポジトリの指定されたブランチに関する情報を取得します。**
```
Get-CCBranch -RepositoryName MyDemoRepo -BranchName MyNewBranch
```
**出力:**
```
BranchName CommitId
---------- --------
MyNewBranch 7763222d...561fc9c9
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetBranch](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CCBranchList`
次のコード例は、`Get-CCBranchList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリポジトリのブランチ名のリストを取得します。**
```
Get-CCBranchList -RepositoryName MyDemoRepo
```
**出力:**
```
master
MyNewBranch
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListBranches](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CCRepository`
次のコード例は、`Get-CCRepository` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリポジトリの情報を取得します。**
```
Get-CCRepository -RepositoryName MyDemoRepo
```
**出力:**
```
AccountId : 80398EXAMPLE
Arn : arn:aws:codecommit:us-east-1:80398EXAMPLE:MyDemoRepo
CloneUrlHttp : https://git-codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo
CloneUrlSsh : ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo
CreationDate : 9/8/2015 3:21:33 PM
DefaultBranch :
LastModifiedDate : 9/8/2015 3:21:33 PM
RepositoryDescription : This is a repository for demonstration purposes.
RepositoryId : c7d0d2b0-ce40-4303-b4c3-38529EXAMPLE
RepositoryName : MyDemoRepo
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetRepository](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CCRepositoryBatch`
次のコード例は、`Get-CCRepositoryBatch` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリポジトリのうち、見つかったリポジトリと見つからないリポジトリを確認します。**
```
Get-CCRepositoryBatch -RepositoryName MyDemoRepo, MyNewRepo, AMissingRepo
```
**出力:**
```
Repositories RepositoriesNotFound
------------ --------------------
{MyDemoRepo, MyNewRepo} {AMissingRepo}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[BatchGetRepositories](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CCRepositoryList`
次のコード例は、`Get-CCRepositoryList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、すべてのリポジトリをリポジトリ名で昇順に一覧表示します。**
```
Get-CCRepositoryList -Order Ascending -SortBy RepositoryName
```
**出力:**
```
RepositoryId RepositoryName
------------ --------------
c7d0d2b0-ce40-4303-b4c3-38529EXAMPLE MyDemoRepo
05f30c66-e3e3-4f91-a0cd-1c84aEXAMPLE MyNewRepo
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListRepositories](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-CCBranch`
次のコード例は、`New-CCBranch` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリポジトリの指定された名前と指定されたコミット ID を持つ新しいブランチを作成します。**
```
New-CCBranch -RepositoryName MyDemoRepo -BranchName MyNewBranch -CommitId 7763222d...561fc9c9
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateBranch](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-CCRepository`
次のコード例は、`New-CCRepository` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された名前と説明を持つ新しいリポジトリを作成します。**
```
New-CCRepository -RepositoryName MyDemoRepo -RepositoryDescription "This is a repository for demonstration purposes."
```
**出力:**
```
AccountId : 80398EXAMPLE
Arn : arn:aws:codecommit:us-east-1:80398EXAMPLE:MyDemoRepo
CloneUrlHttp : https://git-codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo
CloneUrlSsh : ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo
CreationDate : 9/18/2015 4:13:25 PM
DefaultBranch :
LastModifiedDate : 9/18/2015 4:13:25 PM
RepositoryDescription : This is a repository for demonstration purposes.
RepositoryId : 43ef2443-3372-4b12-9e78-65c27EXAMPLE
RepositoryName : MyDemoRepo
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateRepository](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-CCRepository`
次のコード例は、`Remove-CCRepository` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリポジトリを強制的に削除します。このコマンドは、続行する前に確認を求めるプロンプトを表示します。-Force パラメータを追加して、プロンプトなしでリポジトリを削除します。**
```
Remove-CCRepository -RepositoryName MyDemoRepo
```
**出力:**
```
43ef2443-3372-4b12-9e78-65c27EXAMPLE
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteRepository](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-CCDefaultBranch`
次のコード例は、`Update-CCDefaultBranch` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリポジトリのデフォルトブランチを指定されたブランチに変更します。**
```
Update-CCDefaultBranch -RepositoryName MyDemoRepo -DefaultBranchName MyNewBranch
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateDefaultBranch](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-CCRepositoryDescription`
次のコード例は、`Update-CCRepositoryDescription` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリポジトリの説明を変更します。**
```
Update-CCRepositoryDescription -RepositoryName MyDemoRepo -RepositoryDescription "This is an updated description."
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateRepositoryDescription](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-CCRepositoryName`
次のコード例は、`Update-CCRepositoryName` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリポジトリの名前を変更します。**
```
Update-CCRepositoryName -NewName MyDemoRepo2 -OldName MyDemoRepo
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateRepositoryName](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した CodeDeploy の例
次のコード例は、CodeDeploy で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-CDOnPremiseInstanceTag`
次のコード例は、`Add-CDOnPremiseInstanceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたオンプレミスインスタンスに指定されたキーと値を持つオンプレミスインスタンスタグを追加します。**
```
Add-CDOnPremiseInstanceTag -InstanceName AssetTag12010298EX -Tag @{"Key" = "Name"; "Value" = "CodeDeployDemo-OnPrem"}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AddTagsToOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CDApplication`
次のコード例は、`Get-CDApplication` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションに関する情報を取得します。**
```
Get-CDApplication -ApplicationName CodeDeployDemoApplication
```
**出力:**
```
ApplicationId ApplicationName CreateTime LinkedToGitHub
------------- --------------- ---------- --------------
e07fb938-091e-4f2f-8963-4d3e8EXAMPLE CodeDeployDemoApplication 7/20/2015 9:49:48 PM False
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetApplication](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CDApplicationBatch`
次のコード例は、`Get-CDApplicationBatch` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションに関する情報を取得します。**
```
Get-CDApplicationBatch -ApplicationName CodeDeployDemoApplication, CodePipelineDemoApplication
```
**出力:**
```
ApplicationId ApplicationName CreateTime LinkedToGitHub
------------- --------------- ---------- --------------
e07fb938-091e-4f2f-8963-4d3e8EXAMPLE CodeDeployDemoApplication 7/20/2015 9:49:48 PM False
1ecfd602-62f1-4038-8f0d-06688EXAMPLE CodePipelineDemoApplication 8/13/2015 5:53:26 PM False
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[BatchGetApplications](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CDApplicationList`
次のコード例は、`Get-CDApplicationList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、使用可能なアプリケーションのリストを取得します。**
```
Get-CDApplicationList
```
**出力:**
```
CodeDeployDemoApplication
CodePipelineDemoApplication
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListApplications](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CDApplicationRevision`
次のコード例は、`Get-CDApplicationRevision` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションリビジョンに関する情報を取得します。**
```
$revision = Get-CDApplicationRevision -ApplicationName CodeDeployDemoApplication -S3Location_Bucket amzn-s3-demo-bucket -Revision_RevisionType S3 -S3Location_Key 5xd27EX.zip -S3Location_BundleType zip -S3Location_ETag 4565c1ac97187f190c1a90265EXAMPLE
Write-Output ("Description = " + $revision.RevisionInfo.Description + ", RegisterTime = " + $revision.RevisionInfo.RegisterTime)
```
**出力:**
```
Description = Application revision registered by Deployment ID: d-CX9CHN3EX, RegisterTime = 07/20/2015 23:46:42
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetApplicationRevision](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CDApplicationRevisionList`
次のコード例は、`Get-CDApplicationRevisionList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションで使用可能なリビジョンに関する情報を取得します。**
```
ForEach ($revision in (Get-CDApplicationRevisionList -ApplicationName CodeDeployDemoApplication -Deployed Ignore)) {
>> If ($revision.RevisionType -Eq "S3") {
>> Write-Output ("Type = S3, Bucket = " + $revision.S3Location.Bucket + ", BundleType = " + $revision.S3Location.BundleType + ", ETag = " + $revision.S3Location.ETag + ", Key = " + $revision.S3Location.Key)
>> }
>> If ($revision.RevisionType -Eq "GitHub") {
>> Write-Output ("Type = GitHub, CommitId = " + $revision.GitHubLocation.CommitId + ", Repository = " + $revision.GitHubLocation.Repository)
>> }
>> }
>>
```
**出力:**
```
Type = S3, Bucket = amzn-s3-demo-bucket, BundleType = zip, ETag = 4565c1ac97187f190c1a90265EXAMPLE, Key = 5xd27EX.zip
Type = GitHub, CommitId = f48933c3...76405362, Repository = MyGitHubUser/CodeDeployDemoRepo
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListApplicationRevisions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CDDeployment`
次のコード例は、`Get-CDDeployment` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたデプロイに関する概要情報を取得します。**
```
Get-CDDeployment -DeploymentId d-QZMRGSTEX
```
**出力:**
```
ApplicationName : CodeDeployDemoApplication
CompleteTime : 7/23/2015 11:26:04 PM
CreateTime : 7/23/2015 11:24:43 PM
Creator : user
DeploymentConfigName : CodeDeployDefault.OneAtATime
DeploymentGroupName : CodeDeployDemoFleet
DeploymentId : d-QZMRGSTEX
DeploymentOverview : Amazon.CodeDeploy.Model.DeploymentOverview
Description :
ErrorInformation :
IgnoreApplicationStopFailures : False
Revision : Amazon.CodeDeploy.Model.RevisionLocation
StartTime : 1/1/0001 12:00:00 AM
Status : Succeeded
```
**例 2: この例では、指定されたデプロイに参加しているインスタンスのステータスに関する情報を取得します。**
```
(Get-CDDeployment -DeploymentId d-QZMRGSTEX).DeploymentOverview
```
**出力:**
```
Failed : 0
InProgress : 0
Pending : 0
Skipped : 0
Succeeded : 3
```
**例 3: この例では、指定されたデプロイのアプリケーションリビジョンに関する情報を取得します。**
```
(Get-CDDeployment -DeploymentId d-QZMRGSTEX).Revision.S3Location
```
**出力:**
```
Bucket : amzn-s3-demo-bucket
BundleType : zip
ETag : cfbb81b304ee5e27efc21adaed3EXAMPLE
Key : clzfqEX
Version :
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetDeployment](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CDDeploymentBatch`
次のコード例は、`Get-CDDeploymentBatch` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたデプロイに関する情報を取得します。**
```
Get-CDDeploymentBatch -DeploymentId d-QZMRGSTEX, d-RR0T5KTEX
```
**出力:**
```
ApplicationName : CodeDeployDemoApplication
CompleteTime : 7/23/2015 11:26:04 PM
CreateTime : 7/23/2015 11:24:43 PM
Creator : user
DeploymentConfigName : CodeDeployDefault.OneAtATime
DeploymentGroupName : CodeDeployDemoFleet
DeploymentId : d-QZMRGSTEX
DeploymentOverview : Amazon.CodeDeploy.Model.DeploymentOverview
Description :
ErrorInformation :
IgnoreApplicationStopFailures : False
Revision : Amazon.CodeDeploy.Model.RevisionLocation
StartTime : 1/1/0001 12:00:00 AM
Status : Succeeded
ApplicationName : CodePipelineDemoApplication
CompleteTime : 7/23/2015 6:07:30 PM
CreateTime : 7/23/2015 6:06:29 PM
Creator : user
DeploymentConfigName : CodeDeployDefault.OneAtATime
DeploymentGroupName : CodePipelineDemoFleet
DeploymentId : d-RR0T5KTEX
DeploymentOverview : Amazon.CodeDeploy.Model.DeploymentOverview
Description :
ErrorInformation :
IgnoreApplicationStopFailures : False
Revision : Amazon.CodeDeploy.Model.RevisionLocation
StartTime : 1/1/0001 12:00:00 AM
Status : Succeeded
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[BatchGetDeployments](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CDDeploymentConfig`
次のコード例は、`Get-CDDeploymentConfig` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたデプロイ設定に関する概要情報を取得します。**
```
Get-CDDeploymentConfig -DeploymentConfigName ThreeQuartersHealthy
```
**出力:**
```
CreateTime DeploymentConfigId DeploymentConfigName MinimumHealthyHosts
---------- ------------------ -------------------- -------------------
10/3/2014 4:32:30 PM 518a3950-d034-46a1-9d2c-3c949EXAMPLE ThreeQuartersHealthy Amazon.CodeDeploy.Model.MinimumHealthyHosts
```
**例 2: この例では、指定されたデプロイ設定の定義に関する情報を取得します。**
```
Write-Output ((Get-CDDeploymentConfig -DeploymentConfigName ThreeQuartersHealthy).MinimumHealthyHosts)
```
**出力:**
```
Type Value
---- -----
FLEET_PERCENT 75
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetDeploymentConfig](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CDDeploymentConfigList`
次のコード例は、`Get-CDDeploymentConfigList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、使用可能なデプロイ設定のリストを取得します。**
```
Get-CDDeploymentConfigList
```
**出力:**
```
ThreeQuartersHealthy
CodeDeployDefault.OneAtATime
CodeDeployDefault.AllAtOnce
CodeDeployDefault.HalfAtATime
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListDeploymentConfigs](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CDDeploymentGroup`
次のコード例は、`Get-CDDeploymentGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたデプロイグループに関する情報を取得します。**
```
Get-CDDeploymentGroup -ApplicationName CodeDeployDemoApplication -DeploymentGroupName CodeDeployDemoFleet
```
**出力:**
```
ApplicationName : CodeDeployDemoApplication
AutoScalingGroups : {}
DeploymentConfigName : CodeDeployDefault.OneAtATime
DeploymentGroupId : 7d7c098a-b444-4b27-96ef-22791EXAMPLE
DeploymentGroupName : CodeDeployDemoFleet
Ec2TagFilters : {Name}
OnPremisesInstanceTagFilters : {}
ServiceRoleArn : arn:aws:iam::80398EXAMPLE:role/CodeDeploySampleStack-4ph6EX-CodeDeployTrustRole-O9MWP7XTL8EX
TargetRevision : Amazon.CodeDeploy.Model.RevisionLocation
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetDeploymentGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CDDeploymentGroupList`
次のコード例は、`Get-CDDeploymentGroupList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションのデプロイグループのリストを取得します。**
```
Get-CDDeploymentGroupList -ApplicationName CodeDeployDemoApplication
```
**出力:**
```
ApplicationName DeploymentGroups NextToken
--------------- ---------------- ---------
CodeDeployDemoApplication {CodeDeployDemoFleet, CodeDeployProductionFleet}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListDeploymentGroups](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CDDeploymentInstance`
次のコード例は、`Get-CDDeploymentInstance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたデプロイの指定されたインスタンスに関する情報を取得します。**
```
Get-CDDeploymentInstance -DeploymentId d-QZMRGSTEX -InstanceId i-254e22EX
```
**出力:**
```
DeploymentId : d-QZMRGSTEX
InstanceId : arn:aws:ec2:us-east-1:80398EXAMPLE:instance/i-254e22EX
LastUpdatedAt : 7/23/2015 11:25:24 PM
LifecycleEvents : {ApplicationStop, DownloadBundle, BeforeInstall, Install...}
Status : Succeeded
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetDeploymentInstance](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CDDeploymentInstanceList`
次のコード例は、`Get-CDDeploymentInstanceList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたデプロイのインスタンス ID のリストを取得します。**
```
Get-CDDeploymentInstanceList -DeploymentId d-QZMRGSTEX
```
**出力:**
```
i-254e22EX
i-274e22EX
i-3b4e22EX
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListDeploymentInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CDDeploymentList`
次のコード例は、`Get-CDDeploymentList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションとデプロイグループのデプロイ ID のリストを取得します。**
```
Get-CDDeploymentList -ApplicationName CodeDeployDemoApplication -DeploymentGroupName CodeDeployDemoFleet
```
**出力:**
```
d-QZMRGSTEX
d-RR0T5KTEX
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListDeployments](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CDOnPremiseInstance`
次のコード例は、`Get-CDOnPremiseInstance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたオンプレミスインスタンスに関する情報を取得します。**
```
Get-CDOnPremiseInstance -InstanceName AssetTag12010298EX
```
**出力:**
```
DeregisterTime : 1/1/0001 12:00:00 AM
IamUserArn : arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser
InstanceArn : arn:aws:codedeploy:us-east-1:80398EXAMPLE:instance/AssetTag12010298EX_rDH556dxEX
InstanceName : AssetTag12010298EX
RegisterTime : 4/3/2015 6:36:24 PM
Tags : {Name}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetOnPremisesInstance](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CDOnPremiseInstanceBatch`
次のコード例は、`Get-CDOnPremiseInstanceBatch` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたオンプレミスインスタンスに関する情報を取得します。**
```
Get-CDOnPremiseInstanceBatch -InstanceName AssetTag12010298EX, AssetTag12010298EX-2
```
**出力:**
```
DeregisterTime : 1/1/0001 12:00:00 AM
IamUserArn : arn:aws:iam::80398EXAMPLE:user/CodeDeployFRWUser
InstanceArn : arn:aws:codedeploy:us-east-1:80398EXAMPLE:instance/AssetTag12010298EX-2_XmeSz18rEX
InstanceName : AssetTag12010298EX-2
RegisterTime : 4/3/2015 6:38:52 PM
Tags : {Name}
DeregisterTime : 1/1/0001 12:00:00 AM
IamUserArn : arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser
InstanceArn : arn:aws:codedeploy:us-east-1:80398EXAMPLE:instance/AssetTag12010298EX_rDH556dxEX
InstanceName : AssetTag12010298EX
RegisterTime : 4/3/2015 6:36:24 PM
Tags : {Name}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[BatchGetOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CDOnPremiseInstanceList`
次のコード例は、`Get-CDOnPremiseInstanceList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、使用可能なオンプレミスインスタンス名のリストを取得します。**
```
Get-CDOnPremiseInstanceList
```
**出力:**
```
AssetTag12010298EX
AssetTag12010298EX-2
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-CDApplication`
次のコード例は、`New-CDApplication` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した名前で新しいアプリケーションを作成します。**
```
New-CDApplication -ApplicationName MyNewApplication
```
**出力:**
```
f19e4b61-2231-4328-b0fd-e57f5EXAMPLE
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateApplication](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-CDDeployment`
次のコード例は、`New-CDDeployment` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたデプロイ設定とアプリケーションリビジョンを使用して、指定されたアプリケーションとデプロイグループの新しいデプロイを作成します。**
```
New-CDDeployment -ApplicationName MyNewApplication -S3Location_Bucket amzn-s3-demo-bucket -S3Location_BundleType zip -DeploymentConfigName CodeDeployDefault.OneAtATime -DeploymentGroupName MyNewDeploymentGroup -IgnoreApplicationStopFailures $True -S3Location_Key aws-codedeploy_linux-master.zip -RevisionType S3
```
**出力:**
```
d-ZHROG7UEX
```
**例 2: この例では、ブルー/グリーンデプロイの置き換え環境に含めるために、そのインスタンスを識別する必要がある EC2 インスタンスタグのグループを指定する方法を示します。**
```
New-CDDeployment -ApplicationName MyNewApplication -S3Location_Bucket amzn-s3-demo-bucket -S3Location_BundleType zip -DeploymentConfigName CodeDeployDefault.OneAtATime -DeploymentGroupName MyNewDeploymentGroup -IgnoreApplicationStopFailures $True -S3Location_Key aws-codedeploy_linux-master.zip -RevisionType S3 -Ec2TagSetList @(@{Key="key1";Type="KEY_ONLY"},@{Key="Key2";Type="KEY_AND_VALUE";Value="Value2"}),@(@{Key="Key3";Type="VALUE_ONLY";Value="Value3"})
```
**出力:**
```
d-ZHROG7UEX
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateDeployment](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-CDDeploymentConfig`
次のコード例は、`New-CDDeploymentConfig` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された名前と動作で新しいデプロイ設定を作成します。**
```
New-CDDeploymentConfig -DeploymentConfigName AtLeastTwoHealthyHosts -MinimumHealthyHosts_Type HOST_COUNT -MinimumHealthyHosts_Value 2
```
**出力:**
```
0f3e8187-44ef-42da-aeed-b6823EXAMPLE
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateDeploymentConfig](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-CDDeploymentGroup`
次のコード例は、`New-CDDeploymentGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションに対して指定された名前、Auto Scaling グループ、デプロイ設定、タグ、サービスロールを持つデプロイグループを作成します。**
```
New-CDDeploymentGroup -ApplicationName MyNewApplication -AutoScalingGroup CodeDeployDemo-ASG -DeploymentConfigName CodeDeployDefault.OneAtATime -DeploymentGroupName MyNewDeploymentGroup -Ec2TagFilter @{Key="Name"; Type="KEY_AND_VALUE"; Value="CodeDeployDemo"} -ServiceRoleArn arn:aws:iam::80398EXAMPLE:role/CodeDeployDemo
```
**出力:**
```
16bbf199-95fd-40fc-a909-0bbcfEXAMPLE
```
**例 2: この例では、ブルー/グリーンデプロイの置き換え環境に含めるために、そのインスタンスを識別する必要がある EC2 インスタンスタグのグループを指定する方法を示します。**
```
New-CDDeploymentGroup -ApplicationName MyNewApplication -AutoScalingGroup CodeDeployDemo-ASG -DeploymentConfigName CodeDeployDefault.OneAtATime -DeploymentGroupName MyNewDeploymentGroup -Ec2TagFilter @{Key="Name"; Type="KEY_AND_VALUE"; Value="CodeDeployDemo"} -ServiceRoleArn arn:aws:iam::80398EXAMPLE:role/CodeDeployDemo -Ec2TagSetList @(@{Key="key1";Type="KEY_ONLY"},@{Key="Key2";Type="KEY_AND_VALUE";Value="Value2"}),@(@{Key="Key3";Type="VALUE_ONLY";Value="Value3"})
```
**出力:**
```
16bbf199-95fd-40fc-a909-0bbcfEXAMPLE
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateDeploymentGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Register-CDApplicationRevision`
次のコード例は、`Register-CDApplicationRevision` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションに対し、指定された Amazon S3 ロケーションでアプリケーションリビジョンを登録します。**
```
Register-CDApplicationRevision -ApplicationName MyNewApplication -S3Location_Bucket amzn-s3-demo-bucket -S3Location_BundleType zip -S3Location_Key aws-codedeploy_linux-master.zip -Revision_RevisionType S3
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RegisterApplicationRevision](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Register-CDOnPremiseInstance`
次のコード例は、`Register-CDOnPremiseInstance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された名前と IAM ユーザーでオンプレミスインスタンスを登録します。**
```
Register-CDOnPremiseInstance -IamUserArn arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser -InstanceName AssetTag12010298EX
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RegisterOnPremisesInstance](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-CDApplication`
次のコード例は、`Remove-CDApplication` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された名前のアプリケーションを削除します。このコマンドは、続行する前に確認を求めるプロンプトを表示します。-Force パラメータを追加して、プロンプトなしでアプリケーションを削除します。**
```
Remove-CDApplication -ApplicationName MyNewApplication
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteApplication](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-CDDeploymentConfig`
次のコード例は、`Remove-CDDeploymentConfig` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された名前のデプロイ設定を削除します。このコマンドは、続行する前に確認を求めるプロンプトを表示します。-Force パラメータを追加して、プロンプトなしでデプロイ設定を削除します。**
```
Remove-CDDeploymentConfig -DeploymentConfigName AtLeastTwoHealthyHosts
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteDeploymentConfig](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-CDDeploymentGroup`
次のコード例は、`Remove-CDDeploymentGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションの指定された名前のデプロイグループを削除します。このコマンドは、続行する前に確認を求めるプロンプトを表示します。-Force パラメータを追加して、プロンプトなしでデプロイグループを削除します。**
```
Remove-CDDeploymentGroup -ApplicationName MyNewApplication -DeploymentGroupName MyNewDeploymentGroup
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteDeploymentGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-CDOnPremiseInstanceTag`
次のコード例は、`Remove-CDOnPremiseInstanceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された名前のオンプレミスインスタンスの指定されたタグを削除します。このコマンドは、続行する前に確認を求めるプロンプトを表示します。-Force パラメータを追加して、プロンプトなしでタグを削除します。**
```
Remove-CDOnPremiseInstanceTag -InstanceName AssetTag12010298EX -Tag @{"Key" = "Name"; "Value" = "CodeDeployDemo-OnPrem"}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RemoveTagsFromOnPremisesInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Stop-CDDeployment`
次のコード例は、`Stop-CDDeployment` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたデプロイ ID を持つデプロイの停止を試みます。**
```
Stop-CDDeployment -DeploymentId d-LJQNREYEX
```
**出力:**
```
Status StatusMessage
------ -------------
Pending Stopping Pending. Stopping to schedule commands in the deployment instances
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[StopDeployment](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Unregister-CDOnPremiseInstance`
次のコード例は、`Unregister-CDOnPremiseInstance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された名前のオンプレミスインスタンスを登録解除します。**
```
Unregister-CDOnPremiseInstance -InstanceName AssetTag12010298EX
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeregisterOnPremisesInstance](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-CDApplication`
次のコード例は、`Update-CDApplication` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションの名前を変更します。**
```
Update-CDApplication -ApplicationName MyNewApplication -NewApplicationName MyNewApplication-2
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)*の「[UpdateApplication](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-CDDeploymentGroup`
次のコード例は、`Update-CDDeploymentGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーションの指定されたデプロイグループの名前を変更します。**
```
Update-CDDeploymentGroup -ApplicationName MyNewApplication -CurrentDeploymentGroupName MyNewDeploymentGroup -NewDeploymentGroupName MyNewDeploymentGroup-2
```
**例 2: この例では、ブルー/グリーンデプロイの置き換え環境に含めるために、そのインスタンスを識別する必要がある EC2 インスタンスタグのグループを指定する方法を示します。**
```
Update-CDDeploymentGroup -ApplicationName MyNewApplication -CurrentDeploymentGroupName MyNewDeploymentGroup -NewDeploymentGroupName MyNewDeploymentGroup-2 -Ec2TagSetList @(@{Key="key1";Type="KEY_ONLY"},@{Key="Key2";Type="KEY_AND_VALUE";Value="Value2"}),@(@{Key="Key3";Type="VALUE_ONLY";Value="Value3"})
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateDeploymentGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した CodePipeline の例
次のコード例は、CodePipeline で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Confirm-CPJob`
次のコード例は、`Confirm-CPJob` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、特定のジョブのステータスを取得します。**
```
Confirm-CPJob -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE -Nonce 3
```
**出力:**
```
Value
-----
InProgress
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AcknowledgeJob](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Disable-CPStageTransition`
次のコード例は、`Disable-CPStageTransition` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたパイプライン内の指定されたステージに対してインバウンド移行を無効にします。**
```
Disable-CPStageTransition -PipelineName CodePipelineDemo -Reason "Disabling temporarily." -StageName Beta -TransitionType Inbound
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DisableStageTransition](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Enable-CPStageTransition`
次のコード例は、`Enable-CPStageTransition` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたパイプライン内の指定されたステージに対してインバウンド移行を有効にします。**
```
Enable-CPStageTransition -PipelineName CodePipelineDemo -StageName Beta -TransitionType Inbound
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[EnableStageTransition](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CPActionType`
次のコード例は、`Get-CPActionType` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された所有者が使用可能なすべてのアクションに関する情報を取得します。**
```
ForEach ($actionType in (Get-CPActionType -ActionOwnerFilter AWS)) {
Write-Output ("For Category = " + $actionType.Id.Category + ", Owner = " + $actionType.Id.Owner + ", Provider = " + $actionType.Id.Provider + ", Version = " + $actionType.Id.Version + ":")
Write-Output (" ActionConfigurationProperties:")
ForEach ($acp in $actionType.ActionConfigurationProperties) {
Write-Output (" For " + $acp.Name + ":")
Write-Output (" Description = " + $acp.Description)
Write-Output (" Key = " + $acp.Key)
Write-Output (" Queryable = " + $acp.Queryable)
Write-Output (" Required = " + $acp.Required)
Write-Output (" Secret = " + $acp.Secret)
}
Write-Output (" InputArtifactDetails:")
Write-Output (" MaximumCount = " + $actionType.InputArtifactDetails.MaximumCount)
Write-Output (" MinimumCount = " + $actionType.InputArtifactDetails.MinimumCount)
Write-Output (" OutputArtifactDetails:")
Write-Output (" MaximumCount = " + $actionType.OutputArtifactDetails.MaximumCount)
Write-Output (" MinimumCount = " + $actionType.OutputArtifactDetails.MinimumCount)
Write-Output (" Settings:")
Write-Output (" EntityUrlTemplate = " + $actionType.Settings.EntityUrlTemplate)
Write-Output (" ExecutionUrlTemplate = " + $actionType.Settings.ExecutionUrlTemplate)
}
```
**出力:**
```
For Category = Deploy, Owner = AWS, Provider = ElasticBeanstalk, Version = 1:
ActionConfigurationProperties:
For ApplicationName:
Description = The AWS Elastic Beanstalk Application name
Key = True
Queryable = False
Required = True
Secret = False
For EnvironmentName:
Description = The AWS Elastic Beanstalk Environment name
Key = True
Queryable = False
Required = True
Secret = False
InputArtifactDetails:
MaximumCount = 1
MinimumCount = 1
OutputArtifactDetails:
MaximumCount = 0
MinimumCount = 0
Settings:
EntityUrlTemplate = https://console.aws.amazon.com/elasticbeanstalk/r/application/{Config:ApplicationName}
ExecutionUrlTemplate = https://console.aws.amazon.com/elasticbeanstalk/r/application/{Config:ApplicationName}
For Category = Deploy, Owner = AWS, Provider = CodeDeploy, Version = 1:
ActionConfigurationProperties:
For ApplicationName:
Description = The AWS CodeDeploy Application name
Key = True
Queryable = False
Required = True
Secret = False
For DeploymentGroupName:
Description = The AWS CodeDeploy Deployment Group name
Key = True
Queryable = False
Required = True
Secret = False
InputArtifactDetails:
MaximumCount = 1
MinimumCount = 1
OutputArtifactDetails:
MaximumCount = 0
MinimumCount = 0
Settings:
EntityUrlTemplate = https://console.aws.amazon.com/codedeploy/home?#/applications/{Config:ApplicationName}/deployment-groups/{Config:DeploymentGroupName}
ExecutionUrlTemplate = https://console.aws.amazon.com/codedeploy/home?#/deployments/{ExternalExecutionId}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListActionTypes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CPActionableJobList`
次のコード例は、`Get-CPActionableJobList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアクションカテゴリ、所有者、プロバイダー、バージョン、およびクエリパラメータのすべての実行可能なジョブに関する情報を取得します。**
```
Get-CPActionableJobList -ActionTypeId_Category Build -ActionTypeId_Owner Custom -ActionTypeId_Provider MyCustomProviderName -ActionTypeId_Version 1 -QueryParam @{"ProjectName" = "MyProjectName"}
```
**出力:**
```
AccountId Data Id Nonce
--------- ---- -- -----
80398EXAMPLE Amazon.CodePipeline.Model.JobData 0de392f5-712d-4f41-ace3-f57a0EXAMPLE 3
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[PollForJobs](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CPJobDetail`
次のコード例は、`Get-CPJobDetail` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたジョブに関する一般的な情報を取得します。**
```
Get-CPJobDetail -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE
```
**出力:**
```
AccountId Data Id
--------- ---- --
80398EXAMPLE Amazon.CodePipeline.Model.JobData f570dc12-5ef3-44bc-945a-6e133EXAMPLE
```
**例 2: この例では、指定されたジョブに関する詳細情報を取得します。**
```
$jobDetails = Get-CPJobDetail -JobId f570dc12-5ef3-44bc-945a-6e133EXAMPLE
Write-Output ("For Job " + $jobDetails.Id + ":")
Write-Output (" AccountId = " + $jobDetails.AccountId)
$jobData = $jobDetails.Data
Write-Output (" Configuration:")
ForEach ($key in $jobData.ActionConfiguration.Keys) {
$value = $jobData.ActionConfiguration.$key
Write-Output (" " + $key + " = " + $value)
}
Write-Output (" ActionTypeId:")
Write-Output (" Category = " + $jobData.ActionTypeId.Category)
Write-Output (" Owner = " + $jobData.ActionTypeId.Owner)
Write-Output (" Provider = " + $jobData.ActionTypeId.Provider)
Write-Output (" Version = " + $jobData.ActionTypeId.Version)
Write-Output (" ArtifactCredentials:")
Write-Output (" AccessKeyId = " + $jobData.ArtifactCredentials.AccessKeyId)
Write-Output (" SecretAccessKey = " + $jobData.ArtifactCredentials.SecretAccessKey)
Write-Output (" SessionToken = " + $jobData.ArtifactCredentials.SessionToken)
Write-Output (" InputArtifacts:")
ForEach ($ia in $jobData.InputArtifacts) {
Write-Output (" " + $ia.Name)
}
Write-Output (" OutputArtifacts:")
ForEach ($oa in $jobData.OutputArtifacts) {
Write-Output (" " + $oa.Name)
}
Write-Output (" PipelineContext:")
$context = $jobData.PipelineContext
Write-Output (" Name = " + $context.Action.Name)
Write-Output (" PipelineName = " + $context.PipelineName)
Write-Output (" Stage = " + $context.Stage.Name)
```
**出力:**
```
For Job f570dc12-5ef3-44bc-945a-6e133EXAMPLE:
AccountId = 80398EXAMPLE
Configuration:
ActionTypeId:
Category = Build
Owner = Custom
Provider = MyCustomProviderName
Version = 1
ArtifactCredentials:
AccessKeyId = ASIAIEI3...IXI6YREX
SecretAccessKey = cqAFDhEi...RdQyfa2u
SessionToken = AQoDYXdz...5u+lsAU=
InputArtifacts:
MyApp
OutputArtifacts:
MyAppBuild
PipelineContext:
Name = Build
PipelineName = CodePipelineDemo
Stage = Build
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetJobDetails](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CPPipeline`
次のコード例は、`Get-CPPipeline` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたパイプラインに関する一般的な情報を取得します。**
```
Get-CPPipeline -Name CodePipelineDemo -Version 1
```
**出力:**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {Source, Build, Beta, TestStage}
Version : 1
```
**例 2: この例では、指定されたパイプラインに関する詳細情報を取得します。**
```
$pipeline = Get-CPPipeline -Name CodePipelineDemo
Write-Output ("Name = " + $pipeline.Name)
Write-Output ("RoleArn = " + $pipeline.RoleArn)
Write-Output ("Version = " + $pipeline.Version)
Write-Output ("ArtifactStore:")
Write-Output (" Location = " + $pipeline.ArtifactStore.Location)
Write-Output (" Type = " + $pipeline.ArtifactStore.Type.Value)
Write-Output ("Stages:")
ForEach ($stage in $pipeline.Stages) {
Write-Output (" Name = " + $stage.Name)
Write-Output (" Actions:")
ForEach ($action in $stage.Actions) {
Write-Output (" Name = " + $action.Name)
Write-Output (" Category = " + $action.ActionTypeId.Category)
Write-Output (" Owner = " + $action.ActionTypeId.Owner)
Write-Output (" Provider = " + $action.ActionTypeId.Provider)
Write-Output (" Version = " + $action.ActionTypeId.Version)
Write-Output (" Configuration:")
ForEach ($key in $action.Configuration.Keys) {
$value = $action.Configuration.$key
Write-Output (" " + $key + " = " + $value)
}
Write-Output (" InputArtifacts:")
ForEach ($ia in $action.InputArtifacts) {
Write-Output (" " + $ia.Name)
}
ForEach ($oa in $action.OutputArtifacts) {
Write-Output (" " + $oa.Name)
}
Write-Output (" RunOrder = " + $action.RunOrder)
}
}
```
**出力:**
```
Name = CodePipelineDemo
RoleArn = arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Version = 3
ArtifactStore:
Location = amzn-s3-demo-bucket
Type = S3
Stages:
Name = Source
Actions:
Name = Source
Category = Source
Owner = ThirdParty
Provider = GitHub
Version = 1
Configuration:
Branch = master
OAuthToken = ****
Owner = my-user-name
Repo = MyRepoName
InputArtifacts:
MyApp
RunOrder = 1
Name = Build
Actions:
Name = Build
Category = Build
Owner = Custom
Provider = MyCustomProviderName
Version = 1
Configuration:
ProjectName = MyProjectName
InputArtifacts:
MyApp
MyAppBuild
RunOrder = 1
Name = Beta
Actions:
Name = CodePipelineDemoFleet
Category = Deploy
Owner = AWS
Provider = CodeDeploy
Version = 1
Configuration:
ApplicationName = CodePipelineDemoApplication
DeploymentGroupName = CodePipelineDemoFleet
InputArtifacts:
MyAppBuild
RunOrder = 1
Name = TestStage
Actions:
Name = MyJenkinsTestAction
Category = Test
Owner = Custom
Provider = MyCustomTestProvider
Version = 1
Configuration:
ProjectName = MyJenkinsProjectName
InputArtifacts:
MyAppBuild
RunOrder = 1
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetPipeline](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CPPipelineList`
次のコード例は、`Get-CPPipelineList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、使用可能なパイプラインのリストを取得します。**
```
Get-CPPipelineList
```
**出力:**
```
Created Name Updated Version
------- ---- ------- -------
8/13/2015 10:17:54 PM CodePipelineDemo 8/13/2015 10:17:54 PM 3
7/8/2015 2:41:53 AM MyFirstPipeline 7/22/2015 9:06:37 PM 7
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListPipelines](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CPPipelineState`
次のコード例は、`Get-CPPipelineState` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたパイプラインのステージに関する一般的な情報を取得します。**
```
Get-CPPipelineState -Name CodePipelineDemo
```
**出力:**
```
Created : 8/13/2015 10:17:54 PM
PipelineName : CodePipelineDemo
PipelineVersion : 1
StageStates : {Source, Build, Beta, TestStage}
Updated : 8/13/2015 10:17:54 PM
```
**例 2: この例では、指定されたパイプラインの状態に関する詳細情報を取得します。**
```
ForEach ($stageState in (Get-CPPipelineState -Name $arg).StageStates) {
Write-Output ("For " + $stageState.StageName + ":")
Write-Output (" InboundTransitionState:")
Write-Output (" DisabledReason = " + $stageState.InboundTransitionState.DisabledReason)
Write-Output (" Enabled = " + $stageState.InboundTransitionState.Enabled)
Write-Output (" LastChangedAt = " + $stageState.InboundTransitionState.LastChangedAt)
Write-Output (" LastChangedBy = " + $stageState.InboundTransitionState.LastChangedBy)
Write-Output (" ActionStates:")
ForEach ($actionState in $stageState.ActionStates) {
Write-Output (" For " + $actionState.ActionName + ":")
Write-Output (" CurrentRevision:")
Write-Output (" Created = " + $actionState.CurrentRevision.Created)
Write-Output (" RevisionChangeId = " + $actionState.CurrentRevision.RevisionChangeId)
Write-Output (" RevisionId = " + $actionState.CurrentRevision.RevisionId)
Write-Output (" EntityUrl = " + $actionState.EntityUrl)
Write-Output (" LatestExecution:")
Write-Output (" ErrorDetails:")
Write-Output (" Code = " + $actionState.LatestExecution.ErrorDetails.Code)
Write-Output (" Message = " + $actionState.LatestExecution.ErrorDetails.Message)
Write-Output (" ExternalExecutionId = " + $actionState.LatestExecution.ExternalExecutionId)
Write-Output (" ExternalExecutionUrl = " + $actionState.LatestExecution.ExternalExecutionUrl)
Write-Output (" LastStatusChange = " + $actionState.LatestExecution.LastStatusChange)
Write-Output (" PercentComplete = " + $actionState.LatestExecution.PercentComplete)
Write-Output (" Status = " + $actionState.LatestExecution.Status)
Write-Output (" Summary = " + $actionState.LatestExecution.Summary)
Write-Output (" RevisionUrl = " + $actionState.RevisionUrl)
}
}
```
**出力:**
```
For Source:
InboundTransitionState:
DisabledReason =
Enabled =
LastChangedAt =
LastChangedBy =
ActionStates:
For Source:
CurrentRevision:
Created =
RevisionChangeId =
RevisionId =
EntityUrl = https://github.com/my-user-name/MyRepoName/tree/master
LatestExecution:
ErrorDetails:
Code =
Message =
ExternalExecutionId =
ExternalExecutionUrl =
LastStatusChange = 07/20/2015 23:28:45
PercentComplete = 0
Status = Succeeded
Summary =
RevisionUrl =
For Build:
InboundTransitionState:
DisabledReason =
Enabled = True
LastChangedAt = 01/01/0001 00:00:00
LastChangedBy =
ActionStates:
For Build:
CurrentRevision:
Created =
RevisionChangeId =
RevisionId =
EntityUrl = http://54.174.131.1EX/job/MyJenkinsDemo
LatestExecution:
ErrorDetails:
Code = TimeoutError
Message = The action failed because a job worker exceeded its time limit. If this is a custom action, make sure that the job worker is configured correctly.
ExternalExecutionId =
ExternalExecutionUrl =
LastStatusChange = 07/21/2015 00:29:29
PercentComplete = 0
Status = Failed
Summary =
RevisionUrl =
For Beta:
InboundTransitionState:
DisabledReason =
Enabled = True
LastChangedAt = 01/01/0001 00:00:00
LastChangedBy =
ActionStates:
For CodePipelineDemoFleet:
CurrentRevision:
Created =
RevisionChangeId =
RevisionId =
EntityUrl = https://console.aws.amazon.com/codedeploy/home?#/applications/CodePipelineDemoApplication/deployment-groups/CodePipelineDemoFleet
LatestExecution:
ErrorDetails:
Code =
Message =
ExternalExecutionId = d-D5LTCZXEX
ExternalExecutionUrl = https://console.aws.amazon.com/codedeploy/home?#/deployments/d-D5LTCZXEX
LastStatusChange = 07/08/2015 22:07:42
PercentComplete = 0
Status = Succeeded
Summary = Deployment Succeeded
RevisionUrl =
For TestStage:
InboundTransitionState:
DisabledReason =
Enabled = True
LastChangedAt = 01/01/0001 00:00:00
LastChangedBy =
ActionStates:
For MyJenkinsTestAction25:
CurrentRevision:
Created =
RevisionChangeId =
RevisionId =
EntityUrl = http://54.174.131.1EX/job/MyJenkinsDemo
LatestExecution:
ErrorDetails:
Code =
Message =
ExternalExecutionId = 5
ExternalExecutionUrl = http://54.174.131.1EX/job/MyJenkinsDemo/5
LastStatusChange = 07/08/2015 22:09:03
PercentComplete = 0
Status = Succeeded
Summary = Finished
RevisionUrl =
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetPipelineState](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-CPCustomActionType`
次のコード例は、`New-CPCustomActionType` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたプロパティを使用して新しいカスタムアクションを作成します。**
```
New-CPCustomActionType -Category Build -ConfigurationProperty @{"Description" = "The name of the build project must be provided when this action is added to the pipeline."; "Key" = $True; "Name" = "ProjectName"; "Queryable" = $False; "Required" = $True; "Secret" = $False; "Type" = "String"} -Settings_EntityUrlTemplate "https://my-build-instance/job/{Config:ProjectName}/" -Settings_ExecutionUrlTemplate "https://my-build-instance/job/mybuildjob/lastSuccessfulBuild{ExternalExecutionId}/" -InputArtifactDetails_MaximumCount 1 -OutputArtifactDetails_MaximumCount 1 -InputArtifactDetails_MinimumCount 0 -OutputArtifactDetails_MinimumCount 0 -Provider "MyBuildProviderName" -Version 1
```
**出力:**
```
ActionConfigurationProperties : {ProjectName}
Id : Amazon.CodePipeline.Model.ActionTypeId
InputArtifactDetails : Amazon.CodePipeline.Model.ArtifactDetails
OutputArtifactDetails : Amazon.CodePipeline.Model.ArtifactDetails
Settings : Amazon.CodePipeline.Model.ActionTypeSettings
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateCustomActionType](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-CPPipeline`
次のコード例は、`New-CPPipeline` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された設定で新しいパイプラインを作成します。**
```
$pipeline = New-Object Amazon.CodePipeline.Model.PipelineDeclaration
$sourceStageAction = New-Object Amazon.CodePipeline.Model.ActionDeclaration
$deployStageAction = New-Object Amazon.CodePipeline.Model.ActionDeclaration
$sourceStageActionOutputArtifact = New-Object Amazon.CodePipeline.Model.OutputArtifact
$sourceStageActionOutputArtifact.Name = "MyApp"
$sourceStageAction.ActionTypeId = @{"Category" = "Source"; "Owner" = "AWS"; "Provider" = "S3"; "Version" = 1}
$sourceStageAction.Configuration.Add("S3Bucket", "amzn-s3-demo-bucket")
$sourceStageAction.Configuration.Add("S3ObjectKey", "my-object-key-name.zip")
$sourceStageAction.OutputArtifacts.Add($sourceStageActionOutputArtifact)
$sourceStageAction.Name = "Source"
$deployStageActionInputArtifact = New-Object Amazon.CodePipeline.Model.InputArtifact
$deployStageActionInputArtifact.Name = "MyApp"
$deployStageAction.ActionTypeId = @{"Category" = "Deploy"; "Owner" = "AWS"; "Provider" = "CodeDeploy"; "Version" = 1}
$deployStageAction.Configuration.Add("ApplicationName", "CodePipelineDemoApplication")
$deployStageAction.Configuration.Add("DeploymentGroupName", "CodePipelineDemoFleet")
$deployStageAction.InputArtifacts.Add($deployStageActionInputArtifact)
$deployStageAction.Name = "CodePipelineDemoFleet"
$sourceStage = New-Object Amazon.CodePipeline.Model.StageDeclaration
$deployStage = New-Object Amazon.CodePipeline.Model.StageDeclaration
$sourceStage.Name = "Source"
$deployStage.Name = "Beta"
$sourceStage.Actions.Add($sourceStageAction)
$deployStage.Actions.Add($deployStageAction)
$pipeline.ArtifactStore = @{"Location" = "amzn-s3-demo-bucket"; "Type" = "S3"}
$pipeline.Name = "CodePipelineDemo"
$pipeline.RoleArn = "arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole"
$pipeline.Stages.Add($sourceStage)
$pipeline.Stages.Add($deployStage)
$pipeline.Version = 1
New-CPPipeline -Pipeline $pipeline
```
**出力:**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {Source, Beta}
Version : 1
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreatePipeline](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-CPCustomActionType`
次のコード例は、`Remove-CPCustomActionType` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したカスタムアクションを削除します。このコマンドは、続行する前に確認を求めるプロンプトを表示します。-Force パラメータを追加して、プロンプトなしでカスタムアクションを削除します。**
```
Remove-CPCustomActionType -Category Build -Provider MyBuildProviderName -Version 1
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteCustomActionType](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-CPPipeline`
次のコード例は、`Remove-CPPipeline` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたパイプラインを削除します。このコマンドは、続行する前に確認を求めるプロンプトを表示します。-Force パラメータを追加して、プロンプトなしでパイプラインを削除します。**
```
Remove-CPPipeline -Name CodePipelineDemo
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeletePipeline](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Start-CPPipelineExecution`
次のコード例は、`Start-CPPipelineExecution` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたパイプラインの実行を開始します。**
```
Start-CPPipelineExecution -Name CodePipelineDemo
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[StartPipelineExecution](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-CPPipeline`
次のコード例は、`Update-CPPipeline` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された設定で指定された既存のパイプラインを更新します。**
```
$pipeline = New-Object Amazon.CodePipeline.Model.PipelineDeclaration
$sourceStageAction = New-Object Amazon.CodePipeline.Model.ActionDeclaration
$deployStageAction = New-Object Amazon.CodePipeline.Model.ActionDeclaration
$sourceStageActionOutputArtifact = New-Object Amazon.CodePipeline.Model.OutputArtifact
$sourceStageActionOutputArtifact.Name = "MyApp"
$sourceStageAction.ActionTypeId = @{"Category" = "Source"; "Owner" = "AWS"; "Provider" = "S3"; "Version" = 1}
$sourceStageAction.Configuration.Add("S3Bucket", "amzn-s3-demo-bucket")
$sourceStageAction.Configuration.Add("S3ObjectKey", "my-object-key-name.zip")
$sourceStageAction.OutputArtifacts.Add($sourceStageActionOutputArtifact)
$sourceStageAction.Name = "Source"
$deployStageActionInputArtifact = New-Object Amazon.CodePipeline.Model.InputArtifact
$deployStageActionInputArtifact.Name = "MyApp"
$deployStageAction.ActionTypeId = @{"Category" = "Deploy"; "Owner" = "AWS"; "Provider" = "CodeDeploy"; "Version" = 1}
$deployStageAction.Configuration.Add("ApplicationName", "CodePipelineDemoApplication")
$deployStageAction.Configuration.Add("DeploymentGroupName", "CodePipelineDemoFleet")
$deployStageAction.InputArtifacts.Add($deployStageActionInputArtifact)
$deployStageAction.Name = "CodePipelineDemoFleet"
$sourceStage = New-Object Amazon.CodePipeline.Model.StageDeclaration
$deployStage = New-Object Amazon.CodePipeline.Model.StageDeclaration
$sourceStage.Name = "MyInputFiles"
$deployStage.Name = "MyTestDeployment"
$sourceStage.Actions.Add($sourceStageAction)
$deployStage.Actions.Add($deployStageAction)
$pipeline.ArtifactStore = @{"Location" = "amzn-s3-demo-bucket"; "Type" = "S3"}
$pipeline.Name = "CodePipelineDemo"
$pipeline.RoleArn = "arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole"
$pipeline.Stages.Add($sourceStage)
$pipeline.Stages.Add($deployStage)
$pipeline.Version = 1
Update-CPPipeline -Pipeline $pipeline
```
**出力:**
```
ArtifactStore : Amazon.CodePipeline.Model.ArtifactStore
Name : CodePipelineDemo
RoleArn : arn:aws:iam::80398EXAMPLE:role/CodePipelineServiceRole
Stages : {InputFiles, TestDeployment}
Version : 2
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdatePipeline](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した Amazon Cognito ID の例
次のコード例は、Amazon Cognito Identity で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Get-CGIIdentityPool`
次のコード例は、`Get-CGIIdentityPool` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 特定のアイデンティティプールに関する情報をその ID を用いて取得します。**
```
Get-CGIIdentityPool -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
```
**出力:**
```
LoggedAt : 8/12/2015 4:29:40 PM
AllowUnauthenticatedIdentities : True
DeveloperProviderName :
IdentityPoolId : us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
IdentityPoolName : CommonTests1
OpenIdConnectProviderARNs : {}
SupportedLoginProviders : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 142
HttpStatusCode : OK
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeIdentityPool](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CGIIdentityPoolList`
次のコード例は、`Get-CGIIdentityPoolList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 既存のアイデンティティプールのリストを取得します。**
```
Get-CGIIdentityPoolList
```
**出力:**
```
IdentityPoolId IdentityPoolName
-------------- ----------------
us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 CommonTests1
us-east-1:118d242d-204e-4b88-b803-EXAMPLEGUID2 Tests2
us-east-1:15d49393-ab16-431a-b26e-EXAMPLEGUID3 CommonTests13
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListIdentityPools](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CGIIdentityPoolRole`
次のコード例は、`Get-CGIIdentityPoolRole` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 特定のアイデンティティプールのロールに関する情報を取得します。**
```
Get-CGIIdentityPoolRole -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
```
**出力:**
```
LoggedAt : 8/12/2015 4:33:51 PM
IdentityPoolId : us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
Roles : {[unauthenticated, arn:aws:iam::123456789012:role/CommonTests1Role]}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 165
HttpStatusCode : OK
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetIdentityPoolRoles](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-CGIIdentityPool`
次のコード例は、`New-CGIIdentityPool` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 認証されていない ID を許可する新しいアイデンティティプールを作成します。**
```
New-CGIIdentityPool -AllowUnauthenticatedIdentities $true -IdentityPoolName CommonTests13
```
**出力:**
```
LoggedAt : 8/12/2015 4:56:07 PM
AllowUnauthenticatedIdentities : True
DeveloperProviderName :
IdentityPoolId : us-east-1:15d49393-ab16-431a-b26e-EXAMPLEGUID3
IdentityPoolName : CommonTests13
OpenIdConnectProviderARNs : {}
SupportedLoginProviders : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 136
HttpStatusCode : OK
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateIdentityPool](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-CGIIdentityPool`
次のコード例は、`Remove-CGIIdentityPool` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 特定のアイデンティティプールを削除します。**
```
Remove-CGIIdentityPool -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteIdentityPool](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Set-CGIIdentityPoolRole`
次のコード例は、`Set-CGIIdentityPoolRole` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 認証されていない IAM ロールを持つように特定のアイデンティティプールを設定します。**
```
Set-CGIIdentityPoolRole -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 -Role @{ "unauthenticated" = "arn:aws:iam::123456789012:role/CommonTests1Role" }
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[SetIdentityPoolRoles](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-CGIIdentityPool`
次のコード例は、`Update-CGIIdentityPool` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: アイデンティティプールプロパティの一部を更新します。この場合、アイデンティティプールの名前を更新します。**
```
Update-CGIIdentityPool -IdentityPoolId us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1 -IdentityPoolName NewPoolName
```
**出力:**
```
LoggedAt : 8/12/2015 4:53:33 PM
AllowUnauthenticatedIdentities : False
DeveloperProviderName :
IdentityPoolId : us-east-1:0de2af35-2988-4d0b-b22d-EXAMPLEGUID1
IdentityPoolName : NewPoolName
OpenIdConnectProviderARNs : {}
SupportedLoginProviders : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 135
HttpStatusCode : OK
```
+ API の詳細については、「*AWS Tools for PowerShell Cmdlet Reference (V5)*」の「[UpdateIdentityPool](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# AWS Config Tools for PowerShell V5 を使用した の例
次のコード例は、 で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています AWS Config。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-CFGResourceTag`
次のコード例は、`Add-CFGResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定タグをリソース ARN に関連付けます。この場合、リソース ARN は config-rule/config-rule-16iyn0 です。**
```
Add-CFGResourceTag -ResourceArn arn:aws:config:eu-west-1:123456789012:config-rule/config-rule-16iyn0 -Tag @{Key="Release";Value="Beta"}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[TagResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGAggregateComplianceByConfigRuleList`
次のコード例は、`Get-CFGAggregateComplianceByConfigRuleList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定の設定ルールの詳細を ConfigurationAggregatorの「kaju」フィルタリングから取得して、ルールの「コンプライアンス」を展開/返します。**
```
Get-CFGAggregateComplianceByConfigRuleList -ConfigurationAggregatorName kaju -Filters_ConfigRuleName ALB_HTTP_TO_HTTPS_REDIRECTION_CHECK | Select-Object -ExpandProperty Compliance
```
**出力:**
```
ComplianceContributorCount ComplianceType
-------------------------- --------------
Amazon.ConfigService.Model.ComplianceContributorCount NON_COMPLIANT
```
**例 2: この例では、指定の ConfigurationAggregator から詳細を取得し、アグリゲータの対象となるすべてのリージョンの指定アカウントに対してフィルタリングして、さらにすべてのルールのコンプライアンスを返します。**
```
Get-CFGAggregateComplianceByConfigRuleList -ConfigurationAggregatorName kaju -Filters_AccountId 123456789012 | Select-Object ConfigRuleName, @{N="Compliance";E={$_.Compliance.ComplianceType}}
```
**出力:**
```
ConfigRuleName Compliance
-------------- ----------
ALB_HTTP_TO_HTTPS_REDIRECTION_CHECK NON_COMPLIANT
ec2-instance-no-public-ip NON_COMPLIANT
desired-instance-type NON_COMPLIANT
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeAggregateComplianceByConfigRules](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGAggregateComplianceDetailsByConfigRule`
次のコード例は、`Get-CFGAggregateComplianceDetailsByConfigRule` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアカウント、アグリゲータ、リージョン、および設定ルールの「COMPLIANT」状態にある AWS Config ルールdesired-instance-type」の resource-id と resource-type の出力を選択する評価結果を返します。**
```
Get-CFGAggregateComplianceDetailsByConfigRule -AccountId 123456789012 -AwsRegion eu-west-1 -ComplianceType COMPLIANT -ConfigRuleName desired-instance-type -ConfigurationAggregatorName raju | Select-Object -ExpandProperty EvaluationResultIdentifier | Select-Object -ExpandProperty EvaluationResultQualifier
```
**出力:**
```
ConfigRuleName ResourceId ResourceType
-------------- ---------- ------------
desired-instance-type i-0f1bf2f34c5678d12 AWS::EC2::Instance
desired-instance-type i-0fd12dd3456789123 AWS::EC2::Instance
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetAggregateComplianceDetailsByConfigRule](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGAggregateConfigRuleComplianceSummary`
次のコード例は、`Get-CFGAggregateConfigRuleComplianceSummary` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定アグリゲータの非準拠ルールの数を返します。**
```
(Get-CFGAggregateConfigRuleComplianceSummary -ConfigurationAggregatorName raju).AggregateComplianceCounts.ComplianceSummary.NonCompliantResourceCount
```
**出力:**
```
CapExceeded CappedCount
----------- -----------
False 5
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetAggregateConfigRuleComplianceSummary](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGAggregateDiscoveredResourceCount`
次のコード例は、`Get-CFGAggregateDiscoveredResourceCount` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、us-east-1 リージョンでフィルタリングされた指定アグリゲータのリソース数を返します。**
```
Get-CFGAggregateDiscoveredResourceCount -ConfigurationAggregatorName Master -Filters_Region us-east-1
```
**出力:**
```
GroupByKey GroupedResourceCounts NextToken TotalDiscoveredResources
---------- --------------------- --------- ------------------------
{} 455
```
**例 2: この例では、特定のアグリゲータのフィルタリングされたリージョンの RESOURCE\$1TYPE 別にグループ化されたリソース数を返します。**
```
Get-CFGAggregateDiscoveredResourceCount -ConfigurationAggregatorName Master -Filters_Region us-east-1 -GroupByKey RESOURCE_TYPE |
Select-Object -ExpandProperty GroupedResourceCounts
```
**出力:**
```
GroupName ResourceCount
--------- -------------
AWS::CloudFormation::Stack 12
AWS::CloudFront::Distribution 1
AWS::CloudTrail::Trail 1
AWS::DynamoDB::Table 1
AWS::EC2::EIP 2
AWS::EC2::FlowLog 2
AWS::EC2::InternetGateway 4
AWS::EC2::NatGateway 2
AWS::EC2::NetworkAcl 4
AWS::EC2::NetworkInterface 12
AWS::EC2::RouteTable 13
AWS::EC2::SecurityGroup 18
AWS::EC2::Subnet 16
AWS::EC2::VPC 4
AWS::EC2::VPCEndpoint 2
AWS::EC2::VPCPeeringConnection 1
AWS::IAM::Group 2
AWS::IAM::Policy 51
AWS::IAM::Role 78
AWS::IAM::User 7
AWS::Lambda::Function 3
AWS::RDS::DBSecurityGroup 1
AWS::S3::Bucket 3
AWS::SSM::AssociationCompliance 107
AWS::SSM::ManagedInstanceInventory 108
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetAggregateDiscoveredResourceCounts](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGAggregateDiscoveredResourceList`
次のコード例は、`Get-CFGAggregateDiscoveredResourceList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、「アイルランド」アグリゲータで集約された指定リソースタイプのリソース ID を返します。リソースタイプのリストについては、https://docs.aws.amazon.com/sdkfornet/v4/apidocs/index.html?page=ConfigService/TConfigServiceResourceType.html&tocid=Amazon\$1ConfigService\$1ResourceType を確認してください。**
```
Get-CFGAggregateDiscoveredResourceList -ConfigurationAggregatorName Ireland -ResourceType ([Amazon.ConfigService.ResourceType]::AWSAutoScalingAutoScalingGroup)
```
**出力:**
```
ResourceId : arn:aws:autoscaling:eu-west-1:123456789012:autoScalingGroup:12e3b4fc-1234-1234-a123-1d2ba3c45678:autoScalingGroupName/asg-1
ResourceName : asg-1
ResourceType : AWS::AutoScaling::AutoScalingGroup
SourceAccountId : 123456789012
SourceRegion : eu-west-1
```
**例 2: この例では、us-east-1 リージョンでフィルタリングされた指定アグリゲータの「default」という名前のリソースタイプ `AwsEC2SecurityGroup` を返します。**
```
Get-CFGAggregateDiscoveredResourceList -ConfigurationAggregatorName raju -ResourceType ([Amazon.ConfigService.ResourceType]::AWSEC2SecurityGroup) -Filters_Region us-east-1 -Filters_ResourceName default
```
**出力:**
```
ResourceId : sg-01234bd5dbfa67c89
ResourceName : default
ResourceType : AWS::EC2::SecurityGroup
SourceAccountId : 123456789102
SourceRegion : us-east-1
ResourceId : sg-0123a4ebbf56789be
ResourceName : default
ResourceType : AWS::EC2::SecurityGroup
SourceAccountId : 123456789102
SourceRegion : us-east-1
ResourceId : sg-4fc1d234
ResourceName : default
ResourceType : AWS::EC2::SecurityGroup
SourceAccountId : 123456789102
SourceRegion : us-east-1
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListAggregateDiscoveredResources](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGAggregateResourceConfig`
次のコード例は、`Get-CFGAggregateResourceConfig` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、集約された指定リソースの設定項目を返して、設定を展開します。**
```
(Get-CFGAggregateResourceConfig -ResourceIdentifier_SourceRegion us-east-1 -ResourceIdentifier_SourceAccountId 123456789012 -ResourceIdentifier_ResourceId sg-4fc1d234 -ResourceIdentifier_ResourceType ([Amazon.ConfigService.ResourceType]::AWSEC2SecurityGroup) -ConfigurationAggregatorName raju).Configuration | ConvertFrom-Json
```
**出力:**
```
{"description":"default VPC security group","groupName":"default","ipPermissions":[{"ipProtocol":"-1","ipv6Ranges":[],"prefixListIds":[],"userIdGroupPairs":[{"groupId":"sg-4fc1d234","userId":"123456789012"}],"ipv4Ranges":[],"ipRanges":[]},{"fromPort":3389,"ipProtocol":"tcp","ipv6Ranges":[],"prefixListIds":[],"toPort":3389,"userIdGroupPairs":[],"ipv4Ranges":[{"cidrIp":"54.240.197.224/29","description":"office subnet"},{"cidrIp":"72.21.198.65/32","description":"home pc"}],"ipRanges":["54.240.197.224/29","72.21.198.65/32"]}],"ownerId":"123456789012","groupId":"sg-4fc1d234","ipPermissionsEgress":[{"ipProtocol":"-1","ipv6Ranges":[],"prefixListIds":[],"userIdGroupPairs":[],"ipv4Ranges":[{"cidrIp":"0.0.0.0/0"}],"ipRanges":["0.0.0.0/0"]}],"tags":[],"vpcId":"vpc-2d1c2e34"}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetAggregateResourceconfig-service](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGAggregateResourceConfigBatch`
次のコード例は、`Get-CFGAggregateResourceConfigBatch` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定アグリゲータに存在するリソース (識別済み) の現在の設定項目を取得します。**
```
$resIdentifier=[Amazon.ConfigService.Model.AggregateResourceIdentifier]@{
ResourceId= "i-012e3cb4df567e8aa"
ResourceName = "arn:aws:ec2:eu-west-1:123456789012:instance/i-012e3cb4df567e8aa"
ResourceType = [Amazon.ConfigService.ResourceType]::AWSEC2Instance
SourceAccountId = "123456789012"
SourceRegion = "eu-west-1"
}
Get-CFGAggregateResourceConfigBatch -ResourceIdentifier $resIdentifier -ConfigurationAggregatorName raju
```
**出力:**
```
BaseConfigurationItems UnprocessedResourceIdentifiers
---------------------- ------------------------------
{} {arn:aws:ec2:eu-west-1:123456789012:instance/i-012e3cb4df567e8aa}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[BatchGetAggregateResourceconfig-service](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGAggregationAuthorizationList`
次のコード例は、`Get-CFGAggregationAuthorizationList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、アグリゲータに付与された認証を取得します。**
```
Get-CFGAggregationAuthorizationList
```
**出力:**
```
AggregationAuthorizationArn AuthorizedAccountId AuthorizedAwsRegion CreationTime
--------------------------- ------------------- ------------------- ------------
arn:aws:config-service:eu-west-1:123456789012:aggregation-authorization/123456789012/eu-west-1 123456789012 eu-west-1 8/26/2019 12:55:27 AM
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeAggregationAuthorizations](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGComplianceByConfigRule`
次のコード例は、`Get-CFGComplianceByConfigRule` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ルールの現在の評価結果がないため、INSUFFICIENT\$1DATA が返されるルール ebs-optimized-instance のコンプライアンスの詳細を取得します。**
```
(Get-CFGComplianceByConfigRule -ConfigRuleName ebs-optimized-instance).Compliance
```
**出力:**
```
ComplianceContributorCount ComplianceType
-------------------------- --------------
INSUFFICIENT_DATA
```
**例 2: この例では、ルール ALB\$1HTTP\$1TO\$1HTTPS\$1REDIRECTION\$1CHECK の非準拠リソースの数を返します。**
```
(Get-CFGComplianceByConfigRule -ConfigRuleName ALB_HTTP_TO_HTTPS_REDIRECTION_CHECK -ComplianceType NON_COMPLIANT).Compliance.ComplianceContributorCount
```
**出力:**
```
CapExceeded CappedCount
----------- -----------
False 2
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeComplianceByConfigRule](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGComplianceByResource`
次のコード例は、`Get-CFGComplianceByResource` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、「COMPLIANT」コンプライアンスタイプの `AWS::SSM::ManagedInstanceInventory` リソースタイプを確認します。**
```
Get-CFGComplianceByResource -ComplianceType COMPLIANT -ResourceType AWS::SSM::ManagedInstanceInventory
```
**出力:**
```
Compliance ResourceId ResourceType
---------- ---------- ------------
Amazon.ConfigService.Model.Compliance i-0123bcf4b567890e3 AWS::SSM::ManagedInstanceInventory
Amazon.ConfigService.Model.Compliance i-0a1234f6f5d6b78f7 AWS::SSM::ManagedInstanceInventory
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeComplianceByResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGComplianceDetailsByConfigRule`
次のコード例は、`Get-CFGComplianceDetailsByConfigRule` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ルール access-keys-rotated の評価結果を取得し、コンプライアンスタイプ別にグループ化された出力を返します。**
```
Get-CFGComplianceDetailsByConfigRule -ConfigRuleName access-keys-rotated | Group-Object ComplianceType
```
**出力:**
```
Count Name Group
----- ---- -----
2 COMPLIANT {Amazon.ConfigService.Model.EvaluationResult, Amazon.ConfigService.Model.EvaluationResult}
5 NON_COMPLIANT {Amazon.ConfigService.Model.EvaluationResult, Amazon.ConfigService.Model.EvaluationResult, Amazon.ConfigService.Model.EvaluationRes...
```
**例 2: この例では、COMPLIANT リソースの access-keys-rotated ルールのコンプライアンスの詳細をクエリします。**
```
Get-CFGComplianceDetailsByConfigRule -ConfigRuleName access-keys-rotated -ComplianceType COMPLIANT | ForEach-Object {$_.EvaluationResultIdentifier.EvaluationResultQualifier}
```
**出力:**
```
ConfigRuleName ResourceId ResourceType
-------------- ---------- ------------
access-keys-rotated BCAB1CDJ2LITAPVEW3JAH AWS::IAM::User
access-keys-rotated BCAB1CDJ2LITL3EHREM4Q AWS::IAM::User
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetComplianceDetailsByConfigRule](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGComplianceDetailsByResource`
次のコード例は、`Get-CFGComplianceDetailsByResource` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリソースについて次のような結果が出ました。**
```
Get-CFGComplianceDetailsByResource -ResourceId ABCD5STJ4EFGHIVEW6JAH -ResourceType 'AWS::IAM::User'
```
**出力:**
```
Annotation :
ComplianceType : COMPLIANT
ConfigRuleInvokedTime : 8/25/2019 11:34:56 PM
EvaluationResultIdentifier : Amazon.ConfigService.Model.EvaluationResultIdentifier
ResultRecordedTime : 8/25/2019 11:34:56 PM
ResultToken :
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetComplianceDetailsByResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGComplianceSummaryByConfigRule`
次のコード例は、`Get-CFGComplianceSummaryByConfigRule` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このサンプルは、非準拠の Config ルールの数を返します。**
```
Get-CFGComplianceSummaryByConfigRule -Select ComplianceSummary.NonCompliantResourceCount
```
**出力:**
```
CapExceeded CappedCount
----------- -----------
False 9
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetComplianceSummaryByConfigRule](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGComplianceSummaryByResourceType`
次のコード例は、`Get-CFGComplianceSummaryByResourceType` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このサンプルは、準拠または非準拠のリソースの数を返し、出力を json に変換します。**
```
Get-CFGComplianceSummaryByResourceType -Select ComplianceSummariesByResourceType.ComplianceSummary | ConvertTo-Json
{
"ComplianceSummaryTimestamp": "2019-12-14T06:14:49.778Z",
"CompliantResourceCount": {
"CapExceeded": false,
"CappedCount": 2
},
"NonCompliantResourceCount": {
"CapExceeded": true,
"CappedCount": 100
}
}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetComplianceSummaryByResourceType](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGConfigRule`
次のコード例は、`Get-CFGConfigRule` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このサンプルは、選択したプロパティを持つアカウントの設定ルールを一覧表示します。**
```
Get-CFGConfigRule | Select-Object ConfigRuleName, ConfigRuleId, ConfigRuleArn, ConfigRuleState
```
**出力:**
```
ConfigRuleName ConfigRuleId ConfigRuleArn ConfigRuleState
-------------- ------------ ------------- ---------------
ALB_REDIRECTION_CHECK config-rule-12iyn3 arn:aws:config-service:eu-west-1:123456789012:config-rule/config-rule-12iyn3 ACTIVE
access-keys-rotated config-rule-aospfr arn:aws:config-service:eu-west-1:123456789012:config-rule/config-rule-aospfr ACTIVE
autoscaling-group-elb-healthcheck-required config-rule-cn1f2x arn:aws:config-service:eu-west-1:123456789012:config-rule/config-rule-cn1f2x ACTIVE
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeConfigRules](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGConfigRuleEvaluationStatus`
次のコード例は、`Get-CFGConfigRuleEvaluationStatus` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このサンプルは、指定された設定ルールのステータス情報を返します。**
```
Get-CFGConfigRuleEvaluationStatus -ConfigRuleName root-account-mfa-enabled, vpc-flow-logs-enabled
```
**出力:**
```
ConfigRuleArn : arn:aws:config:eu-west-1:123456789012:config-rule/config-rule-kvq1wk
ConfigRuleId : config-rule-kvq1wk
ConfigRuleName : root-account-mfa-enabled
FirstActivatedTime : 8/27/2019 8:05:17 AM
FirstEvaluationStarted : True
LastErrorCode :
LastErrorMessage :
LastFailedEvaluationTime : 1/1/0001 12:00:00 AM
LastFailedInvocationTime : 1/1/0001 12:00:00 AM
LastSuccessfulEvaluationTime : 12/13/2019 8:12:03 AM
LastSuccessfulInvocationTime : 12/13/2019 8:12:03 AM
ConfigRuleArn : arn:aws:config:eu-west-1:123456789012:config-rule/config-rule-z1s23b
ConfigRuleId : config-rule-z1s23b
ConfigRuleName : vpc-flow-logs-enabled
FirstActivatedTime : 8/14/2019 6:23:44 AM
FirstEvaluationStarted : True
LastErrorCode :
LastErrorMessage :
LastFailedEvaluationTime : 1/1/0001 12:00:00 AM
LastFailedInvocationTime : 1/1/0001 12:00:00 AM
LastSuccessfulEvaluationTime : 12/13/2019 7:12:01 AM
LastSuccessfulInvocationTime : 12/13/2019 7:12:01 AM
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeConfigRuleEvaluationStatus](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGConfigurationAggregatorList`
次のコード例は、`Get-CFGConfigurationAggregatorList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、リージョン/アカウントのすべてのアグリゲータを返します。**
```
Get-CFGConfigurationAggregatorList
```
**出力:**
```
AccountAggregationSources : {Amazon.ConfigService.Model.AccountAggregationSource}
ConfigurationAggregatorArn : arn:aws:config-service:eu-west-1:123456789012:config-aggregator/config-aggregator-xabca1me
ConfigurationAggregatorName : IrelandMaster
CreationTime : 8/25/2019 11:42:39 PM
LastUpdatedTime : 8/25/2019 11:42:39 PM
OrganizationAggregationSource :
AccountAggregationSources : {}
ConfigurationAggregatorArn : arn:aws:config-service:eu-west-1:123456789012:config-aggregator/config-aggregator-qubqabcd
ConfigurationAggregatorName : raju
CreationTime : 8/11/2019 8:39:25 AM
LastUpdatedTime : 8/11/2019 8:39:25 AM
OrganizationAggregationSource : Amazon.ConfigService.Model.OrganizationAggregationSource
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeConfigurationAggregators](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGConfigurationAggregatorSourcesStatus`
次のコード例は、`Get-CFGConfigurationAggregatorSourcesStatus` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定アグリゲータ内のソースに対してリクエストされたフィールドを表示します。**
```
Get-CFGConfigurationAggregatorSourcesStatus -ConfigurationAggregatorName raju | select SourceType, LastUpdateStatus, LastUpdateTime, SourceId
```
**出力:**
```
SourceType LastUpdateStatus LastUpdateTime SourceId
---------- ---------------- -------------- --------
ORGANIZATION SUCCEEDED 12/31/2019 7:45:06 AM Organization
ACCOUNT SUCCEEDED 12/31/2019 7:09:38 AM 612641234567
ACCOUNT SUCCEEDED 12/31/2019 7:12:53 AM 933301234567
ACCOUNT SUCCEEDED 12/31/2019 7:18:10 AM 933301234567
ACCOUNT SUCCEEDED 12/31/2019 7:25:17 AM 933301234567
ACCOUNT SUCCEEDED 12/31/2019 7:25:49 AM 612641234567
ACCOUNT SUCCEEDED 12/31/2019 7:26:11 AM 612641234567
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeConfigurationAggregatorSourcesStatus](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGConfigurationRecorder`
次のコード例は、`Get-CFGConfigurationRecorder` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、設定レコーダーの詳細を返します。**
```
Get-CFGConfigurationRecorder | Format-List
```
**出力:**
```
Name : default
RecordingGroup : Amazon.ConfigService.Model.RecordingGroup
RoleARN : arn:aws:iam::123456789012:role/aws-service-role/config.amazonaws.com/AWSServiceRoleForConfig
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeConfigurationRecorders](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGConfigurationRecorderStatus`
次のコード例は、`Get-CFGConfigurationRecorderStatus` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このサンプルは、設定レコーダーのステータスを返します。**
```
Get-CFGConfigurationRecorderStatus
```
**出力:**
```
LastErrorCode :
LastErrorMessage :
LastStartTime : 10/11/2019 10:13:51 AM
LastStatus : Success
LastStatusChangeTime : 12/31/2019 6:14:12 AM
LastStopTime : 10/11/2019 10:13:46 AM
Name : default
Recording : True
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeConfigurationRecorderStatus](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGConformancePack`
次のコード例は、`Get-CFGConformancePack` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、すべての適合パックを一覧表示します。**
```
Get-CFGConformancePack
```
**出力:**
```
ConformancePackArn : arn:aws:config:eu-west-1:123456789012:conformance-pack/dono/conformance-pack-p0acq8bpz
ConformancePackId : conformance-pack-p0acabcde
ConformancePackInputParameters : {}
ConformancePackName : dono
CreatedBy :
DeliveryS3Bucket : kt-ps-examples
DeliveryS3KeyPrefix :
LastUpdateRequestedTime : 12/31/2019 8:45:31 AM
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeConformancePacks](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGDeliveryChannel`
次のコード例は、`Get-CFGDeliveryChannel` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、リージョンの配信チャネルを取得し、詳細を表示します。**
```
Get-CFGDeliveryChannel -Region eu-west-1 | Select-Object Name, S3BucketName, S3KeyPrefix, @{N="DeliveryFrequency";E={$_.ConfigSnapshotDeliveryProperties.DeliveryFrequency}}
```
**出力:**
```
Name S3BucketName S3KeyPrefix DeliveryFrequency
---- ------------ ----------- -----------------
default config-bucket-NA my TwentyFour_Hours
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeDeliveryChannels](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-CFGResourceTag`
次のコード例は、`Get-CFGResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定リソースに関連付けられたタグを一覧表示します。**
```
Get-CFGResourceTag -ResourceArn $rules[0].ConfigRuleArn
```
**出力:**
```
Key Value
--- -----
Version 1.3
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-CFGConformancePack`
次のコード例は、`Remove-CFGConformancePack` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定の適合パックと、パックのすべてのルール、修復アクション、評価結果を削除します。**
```
Remove-CFGConformancePack -ConformancePackName dono
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-CFGConformancePack (DeleteConformancePack)" on target "dono".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteConformancePack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Write-CFGConformancePack`
次のコード例は、`Write-CFGConformancePack` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、適合パックを作成し、指定の yaml ファイルからテンプレートを取得します。 **
```
Write-CFGConformancePack -ConformancePackName dono -DeliveryS3Bucket amzn-s3-demo-bucket -TemplateBody (Get-Content C:\windows\temp\template.yaml -Raw)
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[PutConformancePack](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Write-CFGDeliveryChannel`
次のコード例は、`Write-CFGDeliveryChannel` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、既存の配信チャネルの deliveryFrequency プロパティを変更します。**
```
Write-CFGDeliveryChannel -ConfigSnapshotDeliveryProperties_DeliveryFrequency TwentyFour_Hours -DeliveryChannelName default -DeliveryChannel_S3BucketName amzn-s3-demo-bucket -DeliveryChannel_S3KeyPrefix my
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[PutDeliveryChannel](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した Device Farm の例
次のコード例は、Device Farm で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `New-DFUpload`
次のコード例は、`New-DFUpload` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Android アプリの AWS Device Farm アップロードを作成します。プロジェクト ARN は、New-DFProject または Get-DFProjectList の出力から取得できます。New-DFUpload 出力内の署名付き URL を使用して、ファイルを Device Farm にアップロードします。**
```
New-DFUpload -ContentType "application/octet-stream" -ProjectArn "arn:aws:devicefarm:us-west-2:123456789012:project:EXAMPLEa-7ec1-4741-9c1f-d3e04EXAMPLE" -Name "app.apk" -Type ANDROID_APP
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateUpload](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Directory Service Tools for PowerShell V5 を使用した の例
次のコード例は、 で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています Directory Service。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-DSIpRoute`
次のコード例は、`Add-DSIpRoute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定 Directory-id に割り当てられたリソースタグを削除します**
```
Add-DSIpRoute -DirectoryId d-123456ijkl -IpRoute @{CidrIp ="203.0.113.5/32"} -UpdateSecurityGroupForDirectoryController $true
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AddIpRoutes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Add-DSResourceTag`
次のコード例は、`Add-DSResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定の Directory-id にリソースタグを追加します。**
```
Add-DSResourceTag -ResourceId d-123456ijkl -Tag @{Key="myTag"; Value="mytgValue"}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AddTagsToResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Approve-DSTrust`
次のコード例は、`Approve-DSTrust` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された Trustid の AWS Directory Service VerifyTrust API オペレーションを呼び出します。**
```
Approve-DSTrust -TrustId t-9067157123
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[VerifyTrust](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Confirm-DSSharedDirectory`
次のコード例は、`Confirm-DSSharedDirectory` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ディレクトリ所有者から送信されたディレクトリ共有リクエストを受け入れます AWS アカウント。**
```
Confirm-DSSharedDirectory -SharedDirectoryId d-9067012345
```
**出力:**
```
CreatedDateTime : 12/30/2019 4:20:27 AM
LastUpdatedDateTime : 12/30/2019 4:21:40 AM
OwnerAccountId : 123456781234
OwnerDirectoryId : d-123456ijkl
SharedAccountId : 123456784321
SharedDirectoryId : d-9067012345
ShareMethod :
ShareNotes : This is test sharing
ShareStatus : Sharing
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AcceptSharedDirectory](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Connect-DSDirectory`
次のコード例は、`Connect-DSDirectory` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、オンプレミスディレクトリに接続するための AD Connector を作成します。**
```
Connect-DSDirectory -Name contoso.com -ConnectSettings_CustomerUserName Administrator -Password $Password -ConnectSettings_CustomerDnsIp 172.31.36.96 -ShortName CONTOSO -Size Small -ConnectSettings_VpcId vpc-123459da -ConnectSettings_SubnetId subnet-1234ccaa, subnet-5678ffbb
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の[ConnectDirectory](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Deny-DSSharedDirectory`
次のコード例は、`Deny-DSSharedDirectory` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ディレクトリ所有者アカウントから送信されたディレクトリ共有リクエストを拒否します。**
```
Deny-DSSharedDirectory -SharedDirectoryId d-9067012345
```
**出力:**
```
d-9067012345
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の[RejectSharedDirectory](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Disable-DSDirectoryShare`
次のコード例は、`Disable-DSDirectoryShare` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ディレクトリ所有者とコンシューマーアカウントの間のディレクトリ共有を停止します。**
```
Disable-DSDirectoryShare -DirectoryId d-123456ijkl -UnshareTarget_Id 123456784321 -UnshareTarget_Type ACCOUNT
```
**出力:**
```
d-9067012345
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の[UnshareDirectory](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Disable-DSLDAPS`
次のコード例は、`Disable-DSLDAPS` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定ディレクトリの LDAP セキュアコールを非アクティブ化します。**
```
Disable-DSLDAPS -DirectoryId d-123456ijkl -Type Client
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DisableLDAPS](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Disable-DSRadius`
次のコード例は、`Disable-DSRadius` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、AD Connector または Microsoft AD ディレクトリ用に設定された RADIUS サーバーを無効にします。**
```
Disable-DSRadius -DirectoryId d-123456ijkl
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DisableRadius](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Disable-DSSso`
次のコード例は、`Disable-DSSso` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ディレクトリのシングルサインオンを無効にします。**
```
Disable-DSSso -DirectoryId d-123456ijkl
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DisableSso](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Enable-DSDirectoryShare`
次のコード例は、`Enable-DSDirectoryShare` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Handshake メソッドを使用して AWS 、アカウント内の指定されたディレクトリを別の AWS アカウントと共有します。 **
```
Enable-DSDirectoryShare -DirectoryId d-123456ijkl -ShareTarget_Id 123456784321 -ShareMethod HANDSHAKE -ShareTarget_Type ACCOUNT
```
**出力:**
```
d-9067012345
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の[ShareDirectory](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Enable-DSLDAPS`
次のコード例は、`Enable-DSLDAPS` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定ディレクトリのスイッチをアクティブ化して、常に LDAP セキュアコールを使用するようにします。**
```
Enable-DSLDAPS -DirectoryId d-123456ijkl -Type Client
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[EnableLDAPS](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Enable-DSRadius`
次のコード例は、`Enable-DSRadius` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、AD Connector または Microsoft AD ディレクトリ用に指定された RADIUS サーバー設定で多要素認証 (MFA) を有効にします。**
```
Enable-DSRadius -DirectoryId d-123456ijkl
-RadiusSettings_AuthenticationProtocol PAP
-RadiusSettings_DisplayLabel Radius
-RadiusSettings_RadiusPort 1812
-RadiusSettings_RadiusRetry 4
-RadiusSettings_RadiusServer 10.4.185.113
-RadiusSettings_RadiusTimeout 50
-RadiusSettings_SharedSecret wJalrXUtnFEMI
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[EnableRadius](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Enable-DSSso`
次のコード例は、`Enable-DSSso` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ディレクトリのシングルサインオンを有効にします。 **
```
Enable-DSSso -DirectoryId d-123456ijkl
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[EnableSso](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DSCertificate`
次のコード例は、`Get-DSCertificate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、セキュリティ保護された LDAP 接続に登録された証明書に関する情報を表示します。**
```
Get-DSCertificate -DirectoryId d-123456ijkl -CertificateId c-906731e34f
```
**出力:**
```
CertificateId : c-906731e34f
CommonName : contoso-EC2AMAZ-CTGG2NM-CA
ExpiryDateTime : 4/15/2025 6:34:15 PM
RegisteredDateTime : 4/15/2020 6:38:56 PM
State : Registered
StateReason : Certificate registered successfully.
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeCertificate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DSCertificateList`
次のコード例は、`Get-DSCertificateList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定ディレクトリのセキュリティ保護された LDAP 接続用に登録されたすべての証明書が一覧表示されます。**
```
Get-DSCertificateList -DirectoryId d-123456ijkl
```
**出力:**
```
CertificateId CommonName ExpiryDateTime State
------------- ---------- -------------- -----
c-906731e34f contoso-EC2AMAZ-CTGG2NM-CA 4/15/2025 6:34:15 PM Registered
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListCertificates](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DSConditionalForwarder`
次のコード例は、`Get-DSConditionalForwarder` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定 Directory-id の設定済みの条件付きフォワーダーをすべて取得します。**
```
Get-DSConditionalForwarder -DirectoryId d-123456ijkl
```
**出力:**
```
DnsIpAddrs RemoteDomainName ReplicationScope
---------- ---------------- ----------------
{172.31.77.239} contoso.com Domain
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeConditionalForwarders](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DSDirectory`
次のコード例は、`Get-DSDirectory` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、このアカウントに属するディレクトリに関する情報を取得します。**
```
Get-DSDirectory | Select-Object DirectoryId, Name, DnsIpAddrs, Type
```
**出力:**
```
DirectoryId Name DnsIpAddrs Type
----------- ---- ---------- ----
d-123456abcd abcd.example.com {172.31.74.189, 172.31.13.145} SimpleAD
d-123456efgh wifi.example.com {172.31.16.108, 172.31.10.56} ADConnector
d-123456ijkl lan2.example.com {172.31.10.56, 172.31.16.108} MicrosoftAD
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeDirectories](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DSDirectoryLimit`
次のコード例は、`Get-DSDirectoryLimit` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、us-east-1 リージョンのディレクトリ制限情報を表示します。**
```
Get-DSDirectoryLimit -Region us-east-1
```
**出力:**
```
CloudOnlyDirectoriesCurrentCount : 1
CloudOnlyDirectoriesLimit : 10
CloudOnlyDirectoriesLimitReached : False
CloudOnlyMicrosoftADCurrentCount : 1
CloudOnlyMicrosoftADLimit : 20
CloudOnlyMicrosoftADLimitReached : False
ConnectedDirectoriesCurrentCount : 1
ConnectedDirectoriesLimit : 10
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetDirectoryLimits](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DSDomainControllerList`
次のコード例は、`Get-DSDomainControllerList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定 directory-id に対して起動されたドメインコントローラーの詳細なリストを取得します。**
```
Get-DSDomainControllerList -DirectoryId d-123456ijkl
```
**出力:**
```
AvailabilityZone : us-east-1b
DirectoryId : d-123456ijkl
DnsIpAddr : 172.31.16.108
DomainControllerId : dc-1234567aa6
LaunchTime : 4/4/2019 4:53:43 AM
Status : Active
StatusLastUpdatedDateTime : 4/24/2019 1:37:54 PM
StatusReason :
SubnetId : subnet-1234kkaa
VpcId : vpc-123459d
AvailabilityZone : us-east-1d
DirectoryId : d-123456ijkl
DnsIpAddr : 172.31.10.56
DomainControllerId : dc-1234567aa7
LaunchTime : 4/4/2019 4:53:43 AM
Status : Active
StatusLastUpdatedDateTime : 4/4/2019 5:14:31 AM
StatusReason :
SubnetId : subnet-5678ffbb
VpcId : vpc-123459d
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeDomainControllers](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DSEventTopic`
次のコード例は、`Get-DSEventTopic` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、ディレクトリのステータスが変更されたときの通知用に設定された SNS トピックの情報を表示します。**
```
Get-DSEventTopic -DirectoryId d-123456ijkl
```
**出力:**
```
CreatedDateTime : 12/13/2019 11:15:32 AM
DirectoryId : d-123456ijkl
Status : Registered
TopicArn : arn:aws:sns:us-east-1:123456781234:snstopicname
TopicName : snstopicname
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeEventTopics](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DSIpRouteList`
次のコード例は、`Get-DSIpRouteList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、ディレクトリ IP ルーティングで設定されたパブリック IP アドレスブロックを取得します。**
```
Get-DSIpRouteList -DirectoryId d-123456ijkl
```
**出力:**
```
AddedDateTime : 12/13/2019 12:27:22 PM
CidrIp : 203.0.113.5/32
Description : Public IP of On-Prem DNS Server
DirectoryId : d-123456ijkl
IpRouteStatusMsg : Added
IpRouteStatusReason :
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListIpRoutes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DSLDAPSSetting`
次のコード例は、`Get-DSLDAPSSetting` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定ディレクトリの LDAP セキュリティのステータスを説明します。**
```
Get-DSLDAPSSetting -DirectoryId d-123456ijkl
```
**出力:**
```
LastUpdatedDateTime LDAPSStatus LDAPSStatusReason
------------------- ----------- -----------------
4/15/2020 6:51:03 PM Enabled LDAPS is enabled successfully.
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeLDAPSSettings](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DSLogSubscriptionList`
次のコード例は、`Get-DSLogSubscriptionList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定 directory-id のログサブスクリプション情報を取得します。**
```
Get-DSLogSubscriptionList -DirectoryId d-123456ijkl
```
**出力:**
```
DirectoryId LogGroupName SubscriptionCreatedDateTime
----------- ------------ ---------------------------
d-123456ijkl /aws/directoryservice/d-123456ijkl-lan2.example.com 12/14/2019 9:05:23 AM
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListLogSubscriptions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DSResourceTag`
次のコード例は、`Get-DSResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定ディレクトリのすべてのタグを取得します。**
```
Get-DSResourceTag -ResourceId d-123456ijkl
```
**出力:**
```
Key Value
--- -----
myTag myTagValue
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-DSSchemaExtension`
次のコード例は、`Get-DSSchemaExtension` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Microsoft AD ディレクトリに適用されているすべてのスキーマ拡張を一覧表示します。**
```
Get-DSSchemaExtension -DirectoryId d-123456ijkl
```
**出力:**
```
Description : ManagedADSchemaExtension
DirectoryId : d-123456ijkl
EndDateTime : 4/12/2020 10:30:49 AM
SchemaExtensionId : e-9067306643
SchemaExtensionStatus : Completed
SchemaExtensionStatusReason : Schema updates are complete.
StartDateTime : 4/12/2020 10:28:42 AM
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListSchemaExtensions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DSSharedDirectory`
次のコード例は、`Get-DSSharedDirectory` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 AWS アカウントの共有ディレクトリを取得します。**
```
Get-DSSharedDirectory -OwnerDirectoryId d-123456ijkl -SharedDirectoryId d-9067012345
```
**出力:**
```
CreatedDateTime : 12/30/2019 4:34:37 AM
LastUpdatedDateTime : 12/30/2019 4:35:22 AM
OwnerAccountId : 123456781234
OwnerDirectoryId : d-123456ijkl
SharedAccountId : 123456784321
SharedDirectoryId : d-9067012345
ShareMethod : HANDSHAKE
ShareNotes : This is a test Sharing
ShareStatus : Shared
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeSharedDirectories](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DSSnapshot`
次のコード例は、`Get-DSSnapshot` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、このアカウントに属する指定ディレクトリのスナップショットに関する情報を取得します。**
```
Get-DSSnapshot -DirectoryId d-123456ijkl
```
**出力:**
```
DirectoryId : d-123456ijkl
Name :
SnapshotId : s-9064bd1234
StartTime : 12/13/2019 6:33:01 PM
Status : Completed
Type : Auto
DirectoryId : d-123456ijkl
Name :
SnapshotId : s-9064bb4321
StartTime : 12/9/2019 9:48:11 PM
Status : Completed
Type : Auto
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeSnapshots](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DSSnapshotLimit`
次のコード例は、`Get-DSSnapshotLimit` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定ディレクトリの手動スナップショット制限を取得します。**
```
Get-DSSnapshotLimit -DirectoryId d-123456ijkl
```
**出力:**
```
ManualSnapshotsCurrentCount ManualSnapshotsLimit ManualSnapshotsLimitReached
--------------------------- -------------------- ---------------------------
0 5 False
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetSnapshotLimits](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DSTrust`
次のコード例は、`Get-DSTrust` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定された directory-id 用に作成された信頼関係の情報を取得します。**
```
Get-DSTrust -DirectoryId d-123456abcd
```
**出力:**
```
CreatedDateTime : 7/5/2019 4:55:42 AM
DirectoryId : d-123456abcd
LastUpdatedDateTime : 7/5/2019 4:56:04 AM
RemoteDomainName : contoso.com
SelectiveAuth : Disabled
StateLastUpdatedDateTime : 7/5/2019 4:56:04 AM
TrustDirection : One-Way: Incoming
TrustId : t-9067157123
TrustState : Created
TrustStateReason :
TrustType : Forest
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeTrusts](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-DSAlias`
次のコード例は、`New-DSAlias` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ディレクトリのエイリアスを作成し、指定 directory-id にエイリアスを割り当てます。**
```
New-DSAlias -DirectoryId d-123456ijkl -Alias MyOrgName
```
**出力:**
```
Alias DirectoryId
----- -----------
myorgname d-123456ijkl
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateAlias](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-DSComputer`
次のコード例は、`New-DSComputer` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、新しい Active Directory コンピュータオブジェクトを作成します。**
```
New-DSComputer -DirectoryId d-123456ijkl -ComputerName ADMemberServer -Password $Password
```
**出力:**
```
ComputerAttributes ComputerId ComputerName
------------------ ---------- ------------
{WindowsSamName, DistinguishedName} S-1-5-21-1191241402-978882507-2717148213-1662 ADMemberServer
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateComputer](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-DSConditionalForwarder`
次のコード例は、`New-DSConditionalForwarder` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された AWS Directory-id に条件付きフォワーダーを作成します。 **
```
New-DSConditionalForwarder -DirectoryId d-123456ijkl -DnsIpAddr 172.31.36.96,172.31.10.56 -RemoteDomainName contoso.com
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateConditionalForwarder](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-DSDirectory`
次のコード例は、`New-DSDirectory` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、新しい Simple AD ディレクトリを作成します。**
```
New-DSDirectory -Name corp.example.com -Password $Password -Size Small -VpcSettings_VpcId vpc-123459d -VpcSettings_SubnetIds subnet-1234kkaa,subnet-5678ffbb
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateDirectory](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-DSLogSubscription`
次のコード例は、`New-DSLogSubscription` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 AWS アカウントの指定の Amazon CloudWatch ロググループに Directory Service ドメインコントローラーセキュリティログをリアルタイムに転送するためのサブスクリプションを作成します。**
```
New-DSLogSubscription -DirectoryId d-123456ijkl -LogGroupName /aws/directoryservice/d-123456ijkl-lan2.example.com
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateLogSubscription](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-DSMicrosoftAD`
次のコード例は、`New-DSMicrosoftAD` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 に新しい Microsoft AD Directory を作成します AWS クラウド。**
```
New-DSMicrosoftAD -Name corp.example.com -Password $Password -edition Standard -VpcSettings_VpcId vpc-123459d -VpcSettings_SubnetIds subnet-1234kkaa,subnet-5678ffbb
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateMicrosoftAD](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-DSSnapshot`
次のコード例は、`New-DSSnapshot` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ディレクトリスナップショットを作成します。**
```
New-DSSnapshot -DirectoryId d-123456ijkl
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateSnapshot](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-DSTrust`
次のコード例は、`New-DSTrust` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 AWS Managed Microsoft AD ディレクトリと既存のオンプレミス Microsoft Active Directory の間に双方向のフォレスト全体の信頼を作成します。**
```
New-DSTrust -DirectoryId d-123456ijkl -RemoteDomainName contoso.com -TrustDirection Two-Way -TrustType Forest -TrustPassword $Password -ConditionalForwarderIpAddr 172.31.36.96
```
**出力:**
```
t-9067157123
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateTrust](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Register-DSCertificate`
次のコード例は、`Register-DSCertificate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、セキュリティで保護された LDAP 接続の証明書を登録します。**
```
$Certificate = Get-Content contoso.cer -Raw
Register-DSCertificate -DirectoryId d-123456ijkl -CertificateData $Certificate
```
**出力:**
```
c-906731e350
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RegisterCertificate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Register-DSEventTopic`
次のコード例は、`Register-DSEventTopic` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ディレクトリをパブリッシャーとして SNS トピックに関連付けます。**
```
Register-DSEventTopic -DirectoryId d-123456ijkl -TopicName snstopicname
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RegisterEventTopic](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-DSConditionalForwarder`
次のコード例は、`Remove-DSConditionalForwarder` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 AWS Direcotry 用に設定された条件付きフォワーダーを削除します。**
```
Remove-DSConditionalForwarder -DirectoryId d-123456ijkl -RemoteDomainName contoso.com
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteConditionalForwarder](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-DSDirectory`
次のコード例は、`Remove-DSDirectory` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 AWS ディレクトリサービスディレクトリ (Simple AD/Microsoft AD/AD Connector) を削除します。**
```
Remove-DSDirectory -DirectoryId d-123456ijkl
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteDirectory](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-DSIpRoute`
次のコード例は、`Remove-DSIpRoute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定 IP を Directory-id の設定済み IP ルートから削除します。 **
```
Remove-DSIpRoute -DirectoryId d-123456ijkl -CidrIp 203.0.113.5/32
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RemoveIpRoutes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-DSLogSubscription`
次のコード例は、`Remove-DSLogSubscription` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定 Directory-id のログサブスクリプションを削除します**
```
Remove-DSLogSubscription -DirectoryId d-123456ijkl
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteLogSubscription](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-DSResourceTag`
次のコード例は、`Remove-DSResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定 Directory-id に割り当てられたリソースタグを削除します**
```
Remove-DSResourceTag -ResourceId d-123456ijkl -TagKey myTag
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RemoveTagsFromResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-DSSnapshot`
次のコード例は、`Remove-DSSnapshot` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、手動で作成されたスナップショットを削除します。**
```
Remove-DSSnapshot -SnapshotId s-9068b488kc
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteSnapshot](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-DSTrust`
次のコード例は、`Remove-DSTrust` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 AWS Managed AD Directory と外部ドメイン間の既存の信頼関係ヒントを削除します。**
```
Get-DSTrust -DirectoryId d-123456ijkl -Select Trusts.TrustId | Remove-DSTrust
```
**出力:**
```
t-9067157123
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteTrust](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Reset-DSUserPassword`
次のコード例は、`Reset-DSUserPassword` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 AWS Managed microsoft AD または Simple AD Directory で ADUser という名前の Active Direcotry ユーザーのパスワードをリセットします。**
```
Reset-DSUserPassword -UserName ADuser -DirectoryId d-123456ijkl -NewPassword $Password
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ResetUserPassword](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Restore-DSFromSnapshot`
次のコード例は、`Restore-DSFromSnapshot` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、既存のディレクトリスナップショットを使用してディレクトリを復元します。**
```
Restore-DSFromSnapshot -SnapshotId s-9068b488kc
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RestoreFromSnapshot](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Set-DSDomainControllerCount`
次のコード例は、`Set-DSDomainControllerCount` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定 directory-id のドメインコントローラーの数を 3 に設定します。**
```
Set-DSDomainControllerCount -DirectoryId d-123456ijkl -DesiredNumber 3
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateNumberOfDomainControllers](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Start-DSSchemaExtension`
次のコード例は、`Start-DSSchemaExtension` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Microsoft AD ディレクトリにスキーマ拡張を適用します。**
```
$ldif = Get-Content D:\Users\Username\Downloads\ExtendedSchema.ldf -Raw
Start-DSSchemaExtension -DirectoryId d-123456ijkl -CreateSnapshotBeforeSchemaExtension $true -Description ManagedADSchemaExtension -LdifContent $ldif
```
**出力:**
```
e-9067306643
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[StartSchemaExtension](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Stop-DSSchemaExtension`
次のコード例は、`Stop-DSSchemaExtension` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Microsoft AD ディレクトリへの進行中のスキーマ拡張をキャンセルします。**
```
Stop-DSSchemaExtension -DirectoryId d-123456ijkl -SchemaExtensionId e-9067306643
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CancelSchemaExtension](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Unregister-DSCertificate`
次のコード例は、`Unregister-DSCertificate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、セキュリティで保護された LDAP 接続用に登録された証明書をシステムから削除します。**
```
Unregister-DSCertificate -DirectoryId d-123456ijkl -CertificateId c-906731e34f
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeregisterCertificate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Unregister-DSEventTopic`
次のコード例は、`Unregister-DSEventTopic` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された SNS トピックへの発行者として指定されたディレクトリを削除します。**
```
Unregister-DSEventTopic -DirectoryId d-123456ijkl -TopicName snstopicname
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeregisterEventTopic](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-DSConditionalForwarder`
次のコード例は、`Update-DSConditionalForwarder` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 AWS ディレクトリ用に設定された条件付きフォワーダーを更新します。**
```
Update-DSConditionalForwarder -DirectoryId d-123456ijkl -DnsIpAddr 172.31.36.96,172.31.16.108 -RemoteDomainName contoso.com
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateConditionalForwarder](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-DSRadius`
次のコード例は、`Update-DSRadius` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、AD Connector または Microsoft AD ディレクトリの RADIUS サーバー情報を更新します。**
```
Update-DSRadius -DirectoryId d-123456ijkl -RadiusSettings_RadiusRetry 3
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateRadius](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-DSTrust`
次のコード例は、`Update-DSTrust` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定 trust-id の SelectiveAuth パラメータを Disabled から Enabled に更新します。**
```
Update-DSTrust -TrustId t-9067157123 -SelectiveAuth Enabled
```
**出力:**
```
RequestId TrustId
--------- -------
138864a7-c9a8-4ad1-a828-eae479e85b45 t-9067157123
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateTrust](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# AWS DMS Tools for PowerShell V5 を使用した の例
次のコード例は、 で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています AWS DMS。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `New-DMSReplicationTask`
次のコード例は、`New-DMSReplicationTask` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、CdcStartPosition の代わりに CdcStartTime を使用する新しい AWS Database Migration Service レプリケーションタスクを作成します。 CdcStartPosition MigrationType は「full-load-and-cdc」に設定されます。つまり、ターゲットテーブルは空である必要があります。新しいタスクには、Stage のキーと Test のキー値を持つタグが付けられます。このコマンドレットで使用される値の詳細については、 AWS 「 Database Migration Service ユーザーガイド」の「タスクの作成 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP\$1Tasks.Creating.html)」を参照してください。**
```
New-DMSReplicationTask -ReplicationInstanceArn "arn:aws:dms:us-east-1:123456789012:rep:EXAMPLE66XFJUWATDJGBEXAMPLE"`
-CdcStartTime "2019-08-08T12:12:12"`
-CdcStopPosition "server_time:2019-08-09T12:12:12"`
-MigrationType "full-load-and-cdc"`
-ReplicationTaskIdentifier "task1"`
-ReplicationTaskSetting ""`
-SourceEndpointArn "arn:aws:dms:us-east-1:123456789012:endpoint:EXAMPLEW5UANC7Y3P4EEXAMPLE"`
-TableMapping "file:////home/testuser/table-mappings.json"`
-Tag @{"Key"="Stage";"Value"="Test"}`
-TargetEndpointArn "arn:aws:dms:us-east-1:123456789012:endpoint:EXAMPLEJZASXWHTWCLNEXAMPLE"
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateReplicationTask](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した DynamoDB の例
次のコード例は、DynamoDB で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-DDBIndexSchema`
次のコード例は、`Add-DDBIndexSchema` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: TableSchema オブジェクトをパイプラインに書き込む前に、空の TableSchema オブジェクトを作成し、新しいローカルセカンダリインデックス定義を追加します。**
```
$schema | Add-DDBIndexSchema -IndexName "LastPostIndex" -RangeKeyName "LastPostDateTime" -RangeKeyDataType "S" -ProjectionType "keys_only"
$schema = New-DDBTableSchema
```
**出力:**
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{LastPostDateTime} {} {LastPostIndex}
```
**例 2: TableSchema オブジェクトをパイプラインに書き戻す前に、指定 TableSchema オブジェクトに新しいローカルセカンダリインデックス定義を追加します。TableSchema オブジェクトは、-Schema パラメータを使用して指定することもできます。**
```
New-DDBTableSchema | Add-DDBIndexSchema -IndexName "LastPostIndex" -RangeKeyName "LastPostDateTime" -RangeKeyDataType "S" -ProjectionType "keys_only"
```
**出力:**
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{LastPostDateTime} {} {LastPostIndex}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[Add-DDBIndexSchema](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Add-DDBKeySchema`
次のコード例は、`Add-DDBKeySchema` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: TableSchema オブジェクトをパイプラインに書き込む前に、空の TableSchema オブジェクトを作成し、指定キーデータを使用してキーと属性定義のエントリを追加します。キータイプはデフォルトで「HASH」と宣言されます。範囲キーを宣言するには、値「RANGE」を持つ -KeyType パラメータを使用します。**
```
$schema = New-DDBTableSchema
$schema | Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S"
```
**出力:**
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{ForumName} {ForumName} {}
```
**例 2: TableSchema オブジェクトをパイプラインに書き込む前に、指定 TableSchema オブジェクトに新しいキーと属性定義のエントリを追加します。キータイプはデフォルトで「HASH」と宣言されます。範囲キーを宣言するには、値「RANGE」を持つ -KeyType パラメータを使用します。TableSchema オブジェクトは、-Schema パラメータを使用して指定することもできます。**
```
New-DDBTableSchema | Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S"
```
**出力:**
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{ForumName} {ForumName} {}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[Add-DDBKeySchema](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `ConvertFrom-DDBItem`
次のコード例は、`ConvertFrom-DDBItem` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: ConvertFrom-DDBItem を使用して、Get-DDBItem の結果を DynamoDB AttributeValues のハッシュテーブルから string や double などの一般的なタイプのハッシュテーブルに変換します。**
```
@{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
Get-DDBItem -TableName 'Music' -Key $key | ConvertFrom-DDBItem
```
**出力:**
```
Name Value
---- -----
Genre Country
Artist No One You Know
Price 1.94
CriticRating 9
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ConvertFrom-DDBItem](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `ConvertTo-DDBItem`
次のコード例は、`ConvertTo-DDBItem` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: ハッシュテーブルを DynamoDB 属性値のディクショナリに変換する例。**
```
@{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
Key Value
--- -----
SongTitle Amazon.DynamoDBv2.Model.AttributeValue
Artist Amazon.DynamoDBv2.Model.AttributeValue
```
**例 2: ハッシュテーブルを DynamoDB 属性値のディクショナリに変換する例。**
```
@{
MyMap = @{
MyString = 'my string'
}
MyStringSet = [System.Collections.Generic.HashSet[String]]@('my', 'string')
MyNumericSet = [System.Collections.Generic.HashSet[Int]]@(1, 2, 3)
MyBinarySet = [System.Collections.Generic.HashSet[System.IO.MemoryStream]]@(
([IO.MemoryStream]::new([Text.Encoding]::UTF8.GetBytes('my'))),
([IO.MemoryStream]::new([Text.Encoding]::UTF8.GetBytes('string')))
)
MyList1 = @('my', 'string')
MyList2 = [System.Collections.Generic.List[Int]]@(1, 2)
MyList3 = [System.Collections.ArrayList]@('one', 2, $true)
} | ConvertTo-DDBItem
```
**出力:**
```
Key Value
--- -----
MyStringSet Amazon.DynamoDBv2.Model.AttributeValue
MyList1 Amazon.DynamoDBv2.Model.AttributeValue
MyNumericSet Amazon.DynamoDBv2.Model.AttributeValue
MyList2 Amazon.DynamoDBv2.Model.AttributeValue
MyBinarySet Amazon.DynamoDBv2.Model.AttributeValue
MyMap Amazon.DynamoDBv2.Model.AttributeValue
MyList3 Amazon.DynamoDBv2.Model.AttributeValue
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ConvertTo-DDBItem](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DDBBatchItem`
次のコード例は、`Get-DDBBatchItem` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: DynamoDB テーブルの「Music」と「Songs」から「Somewhere Down The Road」という SongTitle の項目を取得します。**
```
$key = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
$keysAndAttributes = New-Object Amazon.DynamoDBv2.Model.KeysAndAttributes
$list = New-Object 'System.Collections.Generic.List[System.Collections.Generic.Dictionary[String, Amazon.DynamoDBv2.Model.AttributeValue]]'
$list.Add($key)
$keysAndAttributes.Keys = $list
$requestItem = @{
'Music' = [Amazon.DynamoDBv2.Model.KeysAndAttributes]$keysAndAttributes
'Songs' = [Amazon.DynamoDBv2.Model.KeysAndAttributes]$keysAndAttributes
}
$batchItems = Get-DDBBatchItem -RequestItem $requestItem
$batchItems.GetEnumerator() | ForEach-Object {$PSItem.Value} | ConvertFrom-DDBItem
```
**出力:**
```
Name Value
---- -----
Artist No One You Know
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
CriticRating 10
Genre Country
Price 1.94
Artist No One You Know
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
CriticRating 10
Genre Country
Price 1.94
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[BatchGetItem](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DDBItem`
次のコード例は、`Get-DDBItem` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: パーティションキー SongTitle とソートキー Artist を含む DynamoDB 項目を返します。**
```
$key = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
Get-DDBItem -TableName 'Music' -Key $key | ConvertFrom-DDBItem
```
**出力:**
```
Name Value
---- -----
Genre Country
SongTitle Somewhere Down The Road
Price 1.94
Artist No One You Know
CriticRating 9
AlbumTitle Somewhat Famous
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetItem](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DDBTable`
次のコード例は、`Get-DDBTable` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定テーブルの詳細を返します。**
```
Get-DDBTable -TableName "myTable"
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeTable](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-DDBTableList`
次のコード例は、`Get-DDBTableList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: すべてのテーブルの詳細を返し、サービスが他にテーブルがないことを知らせるまで自動で繰り返します。**
```
Get-DDBTableList
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListTables](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Invoke-DDBQuery`
次のコード例は、`Invoke-DDBQuery` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定の SongTitle と Artist を含む DynamoDB 項目を返すクエリを呼び出します。**
```
$invokeDDBQuery = @{
TableName = 'Music'
KeyConditionExpression = ' SongTitle = :SongTitle and Artist = :Artist'
ExpressionAttributeValues = @{
':SongTitle' = 'Somewhere Down The Road'
':Artist' = 'No One You Know'
} | ConvertTo-DDBItem
}
Invoke-DDBQuery @invokeDDBQuery | ConvertFrom-DDBItem
```
**出力:**
```
Name Value
---- -----
Genre Country
Artist No One You Know
Price 1.94
CriticRating 9
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[Query](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Invoke-DDBScan`
次のコード例は、`Invoke-DDBScan` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: Music テーブルのすべての項目を返します。**
```
Invoke-DDBScan -TableName 'Music' | ConvertFrom-DDBItem
```
**出力:**
```
Name Value
---- -----
Genre Country
Artist No One You Know
Price 1.94
CriticRating 9
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
Genre Country
Artist No One You Know
Price 1.98
CriticRating 8.4
SongTitle My Dog Spot
AlbumTitle Hey Now
```
**例 2: Music テーブル内の CriticRating が 9 以上の項目を返します。**
```
$scanFilter = @{
CriticRating = [Amazon.DynamoDBv2.Model.Condition]@{
AttributeValueList = @(@{N = '9'})
ComparisonOperator = 'GE'
}
}
Invoke-DDBScan -TableName 'Music' -ScanFilter $scanFilter | ConvertFrom-DDBItem
```
**出力:**
```
Name Value
---- -----
Genre Country
Artist No One You Know
Price 1.94
CriticRating 9
SongTitle Somewhere Down The Road
AlbumTitle Somewhat Famous
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[Scan](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-DDBTable`
次のコード例は、`New-DDBTable` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、「ForumName」(キータイプハッシュ) と「Subject」(キータイプ範囲) で構成されるプライマリキーを持つ「Thread」という名前のテーブルを作成します。テーブルの作成に使用したスキーマは、図のように各 cmdlet にパイプ処理するか、-Schema パラメータを使用して指定できます。**
```
$schema = New-DDBTableSchema
$schema | Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S"
$schema | Add-DDBKeySchema -KeyName "Subject" -KeyType RANGE -KeyDataType "S"
$schema | New-DDBTable -TableName "Thread" -ReadCapacity 10 -WriteCapacity 5
```
**出力:**
```
AttributeDefinitions : {ForumName, Subject}
TableName : Thread
KeySchema : {ForumName, Subject}
TableStatus : CREATING
CreationDateTime : 10/28/2013 4:39:49 PM
ProvisionedThroughput : Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription
TableSizeBytes : 0
ItemCount : 0
LocalSecondaryIndexes : {}
```
**例 2: この例では、「ForumName」(キータイプハッシュ) と「Subject」(キータイプ範囲) で構成されるプライマリキーを持つ Thread という名前のテーブルを作成します。ローカルセカンダリインデックスも定義されます。ローカルセカンダリインデックスのキーは、テーブルのプライマリハッシュキー (ForumName) から自動的に設定されます。テーブルの作成に使用したスキーマは、図のように各 cmdlet にパイプ処理するか、-Schema パラメータを使用して指定できます。**
```
$schema = New-DDBTableSchema
$schema | Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S"
$schema | Add-DDBKeySchema -KeyName "Subject" -KeyDataType "S"
$schema | Add-DDBIndexSchema -IndexName "LastPostIndex" -RangeKeyName "LastPostDateTime" -RangeKeyDataType "S" -ProjectionType "keys_only"
$schema | New-DDBTable -TableName "Thread" -ReadCapacity 10 -WriteCapacity 5
```
**出力:**
```
AttributeDefinitions : {ForumName, LastPostDateTime, Subject}
TableName : Thread
KeySchema : {ForumName, Subject}
TableStatus : CREATING
CreationDateTime : 10/28/2013 4:39:49 PM
ProvisionedThroughput : Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription
TableSizeBytes : 0
ItemCount : 0
LocalSecondaryIndexes : {LastPostIndex}
```
**例 3: この例では、単一のパイプラインを使用して、「ForumName」(キータイプハッシュ) と「Subject」(キータイプ範囲) で構成されるプライマリキー、およびローカルセカンダリインデックスを持つ「Thread」という名前のテーブルを作成する方法を示します。TableSchema がパイプラインまたは -Schema パラメータから提供されない場合、Add-DDBKeySchema と Add-DDBIndexSchema によって新しい TableSchema オブジェクトが作成されます。**
```
New-DDBTableSchema |
Add-DDBKeySchema -KeyName "ForumName" -KeyDataType "S" |
Add-DDBKeySchema -KeyName "Subject" -KeyDataType "S" |
Add-DDBIndexSchema -IndexName "LastPostIndex" `
-RangeKeyName "LastPostDateTime" `
-RangeKeyDataType "S" `
-ProjectionType "keys_only" |
New-DDBTable -TableName "Thread" -ReadCapacity 10 -WriteCapacity 5
```
**出力:**
```
AttributeDefinitions : {ForumName, LastPostDateTime, Subject}
TableName : Thread
KeySchema : {ForumName, Subject}
TableStatus : CREATING
CreationDateTime : 10/28/2013 4:39:49 PM
ProvisionedThroughput : Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription
TableSizeBytes : 0
ItemCount : 0
LocalSecondaryIndexes : {LastPostIndex}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateTable](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-DDBTableSchema`
次のコード例は、`New-DDBTableSchema` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 新しい Amazon DynamoDB テーブルの作成に使用するキーとインデックスの定義を受け入れる準備が整った空の TableSchema オブジェクトを作成します。返されたオブジェクトは、Add-DDBKeySchema、Add-DDBIndexSchema、New-DDBTable コマンドレットにパイプするか、各コマンドレットの -Schema パラメータを使用して渡すことができます。**
```
New-DDBTableSchema
```
**出力:**
```
AttributeSchema KeySchema LocalSecondaryIndexSchema
--------------- --------- -------------------------
{} {} {}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[New-DDBTableSchema](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-DDBItem`
次のコード例は、`Remove-DDBItem` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたキーと一致する DynamoDB 項目を削除します。**
```
$key = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
Remove-DDBItem -TableName 'Music' -Key $key -Confirm:$false
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteItem](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-DDBTable`
次のコード例は、`Remove-DDBTable` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたテーブルを削除します。操作を続行する前に確認画面が表示されます。**
```
Remove-DDBTable -TableName "myTable"
```
**例 2: 指定されたテーブルを削除します。操作を続行する前に確認画面は表示されません。**
```
Remove-DDBTable -TableName "myTable" -Force
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteTable](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Set-DDBBatchItem`
次のコード例は、`Set-DDBBatchItem` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 新しい項目を作成する、または既存の項目を「Music 」DynamoDB テーブルおよび「Songs」DynamoDB テーブルの新しい項目で置き換えます。**
```
$item = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
AlbumTitle = 'Somewhat Famous'
Price = 1.94
Genre = 'Country'
CriticRating = 10.0
} | ConvertTo-DDBItem
$writeRequest = New-Object Amazon.DynamoDBv2.Model.WriteRequest
$writeRequest.PutRequest = [Amazon.DynamoDBv2.Model.PutRequest]$item
$requestItem = @{
'Music' = [Amazon.DynamoDBv2.Model.WriteRequest]($writeRequest)
'Songs' = [Amazon.DynamoDBv2.Model.WriteRequest]($writeRequest)
}
Set-DDBBatchItem -RequestItem $requestItem
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[BatchWriteItem](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Set-DDBItem`
次のコード例は、`Set-DDBItem` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 新しい項目を作成する、または既存の項目を新しい項目で置き換えます。**
```
$item = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
AlbumTitle = 'Somewhat Famous'
Price = 1.94
Genre = 'Country'
CriticRating = 9.0
} | ConvertTo-DDBItem
Set-DDBItem -TableName 'Music' -Item $item
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[PutItem](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-DDBItem`
次のコード例は、`Update-DDBItem` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: パーティションキー SongTitle とソートキー Artist を含む DynamoDB 項目のジャンル属性を「Rap」に設定します。**
```
$key = @{
SongTitle = 'Somewhere Down The Road'
Artist = 'No One You Know'
} | ConvertTo-DDBItem
$updateDdbItem = @{
TableName = 'Music'
Key = $key
UpdateExpression = 'set Genre = :val1'
ExpressionAttributeValue = (@{
':val1' = ([Amazon.DynamoDBv2.Model.AttributeValue]'Rap')
})
}
Update-DDBItem @updateDdbItem
```
**出力:**
```
Name Value
---- -----
Genre Rap
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateItem](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-DDBTable`
次のコード例は、`Update-DDBTable` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたテーブルのプロビジョンされたスループットを更新します。**
```
Update-DDBTable -TableName "myTable" -ReadCapacity 10 -WriteCapacity 5
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateTable](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した Amazon EC2 の例
次のコード例は、Amazon EC2 で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-EC2CapacityReservation`
次のコード例は、`Add-EC2CapacityReservation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された属性で新しいキャパシティ予約を作成します。**
```
Add-EC2CapacityReservation -InstanceType m4.xlarge -InstanceCount 2 -AvailabilityZone eu-west-1b -EbsOptimized True -InstancePlatform Windows
```
**出力:**
```
AvailabilityZone : eu-west-1b
AvailableInstanceCount : 2
CapacityReservationId : cr-0c1f2345db6f7cdba
CreateDate : 3/28/2019 9:29:41 AM
EbsOptimized : True
EndDate : 1/1/0001 12:00:00 AM
EndDateType : unlimited
EphemeralStorage : False
InstanceMatchCriteria : open
InstancePlatform : Windows
InstanceType : m4.xlarge
State : active
Tags : {}
Tenancy : default
TotalInstanceCount : 2
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateCapacityReservation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Add-EC2InternetGateway`
次のコード例は、`Add-EC2InternetGateway` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたインターネットゲートウェイを特定の VPC にアタッチします。**
```
Add-EC2InternetGateway -InternetGatewayId igw-1a2b3c4d -VpcId vpc-12345678
```
**例 2: この例では、VPC とインターネットゲートウェイを作成し、インターネットゲートウェイを VPC にアタッチします。**
```
$vpc = New-EC2Vpc -CidrBlock 10.0.0.0/16
New-EC2InternetGateway | Add-EC2InternetGateway -VpcId $vpc.VpcId
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AttachInternetGateway](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Add-EC2NetworkInterface`
次のコード例は、`Add-EC2NetworkInterface` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したネットワークインターフェイスを指定したインスタンスにアタッチします。**
```
Add-EC2NetworkInterface -NetworkInterfaceId eni-12345678 -InstanceId i-1a2b3c4d -DeviceIndex 1
```
**出力:**
```
eni-attach-1a2b3c4d
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AttachNetworkInterface](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Add-EC2Volume`
次のコード例は、`Add-EC2Volume` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたボリュームを指定されたインスタンスにアタッチし、指定されたデバイス名で公開します。**
```
Add-EC2Volume -VolumeId vol-12345678 -InstanceId i-1a2b3c4d -Device /dev/sdh
```
**出力:**
```
AttachTime : 12/22/2015 1:53:58 AM
DeleteOnTermination : False
Device : /dev/sdh
InstanceId : i-1a2b3c4d
State : attaching
VolumeId : vol-12345678
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AttachVolume](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Add-EC2VpnGateway`
次のコード例は、`Add-EC2VpnGateway` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した仮想プライベートゲートウェイを指定した VPC にアタッチします。**
```
Add-EC2VpnGateway -VpnGatewayId vgw-1a2b3c4d -VpcId vpc-12345678
```
**出力:**
```
State VpcId
----- -----
attaching vpc-12345678
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AttachVpnGateway](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Approve-EC2VpcPeeringConnection`
次のコード例は、`Approve-EC2VpcPeeringConnection` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、リクエストされた VpcPeeringConnectionId pcx-1dfad234b56ff78be を承認します。**
```
Approve-EC2VpcPeeringConnection -VpcPeeringConnectionId pcx-1dfad234b56ff78be
```
**出力:**
```
AccepterVpcInfo : Amazon.EC2.Model.VpcPeeringConnectionVpcInfo
ExpirationTime : 1/1/0001 12:00:00 AM
RequesterVpcInfo : Amazon.EC2.Model.VpcPeeringConnectionVpcInfo
Status : Amazon.EC2.Model.VpcPeeringConnectionStateReason
Tags : {}
VpcPeeringConnectionId : pcx-1dfad234b56ff78be
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AcceptVpcPeeringConnection](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Confirm-EC2ProductInstance`
次のコード例は、`Confirm-EC2ProductInstance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された製品コードが指定されたインスタンスに関連付けられているかどうかを判断します。**
```
Confirm-EC2ProductInstance -ProductCode 774F4FF8 -InstanceId i-12345678
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ConfirmProductInstance](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Copy-EC2Image`
次のコード例は、`Copy-EC2Image` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、「欧州 (アイルランド)」リージョンの指定 AMI を「米国西部 (オレゴン)」リージョンにコピーします。-Region が指定されていない場合、現在のデフォルトリージョンが送信先リージョンとして使用されます。**
```
Copy-EC2Image -SourceRegion eu-west-1 -SourceImageId ami-12345678 -Region us-west-2 -Name "Copy of ami-12345678"
```
**出力:**
```
ami-87654321
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CopyImage](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Copy-EC2Snapshot`
次のコード例は、`Copy-EC2Snapshot` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたスナップショットを欧州 (アイルランド) リージョンから米国西部 (オレゴン) リージョンにコピーします。**
```
Copy-EC2Snapshot -SourceRegion eu-west-1 -SourceSnapshotId snap-12345678 -Region us-west-2
```
**例 2: デフォルトのリージョンを設定し、Region パラメータを省略すると、デフォルトの送信先リージョンがデフォルトのリージョンになります。**
```
Set-DefaultAWSRegion us-west-2
Copy-EC2Snapshot -SourceRegion eu-west-1 -SourceSnapshotId snap-12345678
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CopySnapshot](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Deny-EC2VpcPeeringConnection`
次のコード例は、`Deny-EC2VpcPeeringConnection` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 上記の例では、VpcPeering リクエスト ID pcx-01a2b3ce45fe67eb8 のリクエストを拒否します。**
```
Deny-EC2VpcPeeringConnection -VpcPeeringConnectionId pcx-01a2b3ce45fe67eb8
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RejectVpcPeeringConnection](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Disable-EC2VgwRoutePropagation`
次のコード例は、`Disable-EC2VgwRoutePropagation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、VGW が指定されたルーティングテーブルにルートを自動的に伝播することを無効にします。**
```
Disable-EC2VgwRoutePropagation -RouteTableId rtb-12345678 -GatewayId vgw-1a2b3c4d
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DisableVgwRoutePropagation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Disable-EC2VpcClassicLink`
次のコード例は、`Disable-EC2VpcClassicLink` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、vpc-01e23c4a5d6db78e9 の EC2VpcClassicLink を無効にします。True または False を返します。**
```
Disable-EC2VpcClassicLink -VpcId vpc-01e23c4a5d6db78e9
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DisableVpcClassicLink](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Disable-EC2VpcClassicLinkDnsSupport`
次のコード例は、`Disable-EC2VpcClassicLinkDnsSupport` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、vpc-0b12d3456a7e8910d の ClassicLink DNS サポートを無効にします。**
```
Disable-EC2VpcClassicLinkDnsSupport -VpcId vpc-0b12d3456a7e8910d
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DisableVpcClassicLinkDnsSupport](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Dismount-EC2InternetGateway`
次のコード例は、`Dismount-EC2InternetGateway` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された VPC から指定されたインターネットゲートウェイをデタッチします。**
```
Dismount-EC2InternetGateway -InternetGatewayId igw-1a2b3c4d -VpcId vpc-12345678
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DetachInternetGateway](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Dismount-EC2NetworkInterface`
次のコード例は、`Dismount-EC2NetworkInterface` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ネットワークインターフェイスとインスタンス間の指定されたアタッチメントを削除します。**
```
Dismount-EC2NetworkInterface -AttachmentId eni-attach-1a2b3c4d -Force
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DetachNetworkInterface](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Dismount-EC2Volume`
次のコード例は、`Dismount-EC2Volume` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたボリュームをデタッチします。**
```
Dismount-EC2Volume -VolumeId vol-12345678
```
**出力:**
```
AttachTime : 12/22/2015 1:53:58 AM
DeleteOnTermination : False
Device : /dev/sdh
InstanceId : i-1a2b3c4d
State : detaching
VolumeId : vol-12345678
```
**例 2: インスタンス ID とデバイス名を指定して、正しいボリュームをデタッチするようにすることもできます。**
```
Dismount-EC2Volume -VolumeId vol-12345678 -InstanceId i-1a2b3c4d -Device /dev/sdh
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)*の「[DetachVolume](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Dismount-EC2VpnGateway`
次のコード例は、`Dismount-EC2VpnGateway` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された VPC から指定された仮想プライベートゲートウェイをデタッチします。**
```
Dismount-EC2VpnGateway -VpnGatewayId vgw-1a2b3c4d -VpcId vpc-12345678
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DetachVpnGateway](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-EC2CapacityReservation`
次のコード例は、`Edit-EC2CapacityReservation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インスタンス数を 1 に変更して CapacityReservationId cr-0c1f2345db6f7cdba を変更します。**
```
Edit-EC2CapacityReservation -CapacityReservationId cr-0c1f2345db6f7cdba -InstanceCount 1
```
**出力:**
```
True
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifyCapacityReservation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-EC2Host`
次のコード例は、`Edit-EC2Host` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、専有ホスト h-01e23f4cd567890f3 の 自動配置設定をオフに変更します。**
```
Edit-EC2Host -HostId h-03e09f8cd681609f3 -AutoPlacement off
```
**出力:**
```
Successful Unsuccessful
---------- ------------
{h-01e23f4cd567890f3} {}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifyHosts](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-EC2IdFormat`
次のコード例は、`Edit-EC2IdFormat` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリソースタイプの長い ID 形式を有効にします。**
```
Edit-EC2IdFormat -Resource instance -UseLongId $true
```
**例 2: この例では、指定されたリソースタイプの長い ID 形式を無効にします。**
```
Edit-EC2IdFormat -Resource instance -UseLongId $false
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifyIdFormat](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-EC2ImageAttribute`
次のコード例は、`Edit-EC2ImageAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された AMI の説明を更新します。**
```
Edit-EC2ImageAttribute -ImageId ami-12345678 -Description "New description"
```
**例 2: この例では、AMI を公開します (例: 誰でも AWS アカウント 使用できる）。**
```
Edit-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermission -OperationType add -UserGroup all
```
**例 3: この例では、AMI を非公開にします (例えば、所有者である自分だけが使用できるようにします)。**
```
Edit-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermission -OperationType remove -UserGroup all
```
**例 4: この例では、指定された に起動アクセス許可を付与します AWS アカウント。**
```
Edit-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermission -OperationType add -UserId 111122223333
```
**例 5: この例では、指定された から起動アクセス許可を削除します AWS アカウント。**
```
Edit-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermission -OperationType remove -UserId 111122223333
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifyImageAttribute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-EC2InstanceAttribute`
次のコード例は、`Edit-EC2InstanceAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたインスタンスのインスタンスタイプを変更します。**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -InstanceType m3.medium
```
**例 2: この例では、単一ルート I/O 仮想化 (SR-IOV) ネットワークサポートパラメータ -SriovNetSupport の値に「simple」を指定して、指定されたインスタンスの拡張ネットワーキングを有効にします。**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -SriovNetSupport "simple"
```
**例 3: この例では、指定されたインスタンスのセキュリティグループを変更します。インスタンスは VPC にある必要があります。名前ではなく、各セキュリティグループの ID を指定する必要があります。**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -Group @( "sg-12345678", "sg-45678901" )
```
**例 4: この例では、指定されたインスタンスの EBS I/O 最適化を有効にします。この機能は、すべてのインスタンスタイプで使用できるわけではありません。EBS 最適化インスタンスを使用する場合は、追加料金が適用されます。**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -EbsOptimized $true
```
**例 5: この例では、指定されたインスタンスの送信元/送信先チェックを有効にします。NAT インスタンスが NAT を実行するには、値が「false」である必要があります。**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -SourceDestCheck $true
```
**例 6: この例では、指定されたインスタンスの終了を無効にします。**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -DisableApiTermination $true
```
**例 7: この例では、インスタンスからシャットダウンを開始したときに終了するように、指定されたインスタンスを変更します。**
```
Edit-EC2InstanceAttribute -InstanceId i-12345678 -InstanceInitiatedShutdownBehavior terminate
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifyInstanceAttribute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-EC2InstanceCreditSpecification`
次のコード例は、`Edit-EC2InstanceCreditSpecification` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: これにより、インスタンス i-01234567890abcdef の T2 無制限クレジットが有効になります。**
```
$Credit = New-Object -TypeName Amazon.EC2.Model.InstanceCreditSpecificationRequest
$Credit.InstanceId = "i-01234567890abcdef"
$Credit.CpuCredits = "unlimited"
Edit-EC2InstanceCreditSpecification -InstanceCreditSpecification $Credit
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifyInstanceCreditSpecification](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-EC2NetworkInterfaceAttribute`
次のコード例は、`Edit-EC2NetworkInterfaceAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された添付ファイルが終了時に削除されるように、指定されたネットワークインターフェイスを変更します。**
```
Edit-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-1a2b3c4d -Attachment_AttachmentId eni-attach-1a2b3c4d -Attachment_DeleteOnTermination $true
```
**例 2: この例では、指定されたネットワークインターフェイスの説明を変更します。**
```
Edit-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-1a2b3c4d -Description "my description"
```
**例 3: この例では、指定されたネットワークインターフェイスのセキュリティグループを変更します。**
```
Edit-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-1a2b3c4d -Groups sg-1a2b3c4d
```
**例 4: この例では、指定されたネットワークインターフェイスの送信元/送信先チェックを無効にします。**
```
Edit-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-1a2b3c4d -SourceDestCheck $false
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifyNetworkInterfaceAttribute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-EC2ReservedInstance`
次のコード例は、`Edit-EC2ReservedInstance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリザーブドインスタンスのアベイラビリティーゾーン、インスタンス数、プラットフォームを変更します。**
```
$config = New-Object Amazon.EC2.Model.ReservedInstancesConfiguration
$config.AvailabilityZone = "us-west-2a"
$config.InstanceCount = 1
$config.Platform = "EC2-VPC"
Edit-EC2ReservedInstance `
-ReservedInstancesId @("FE32132D-70D5-4795-B400-AE435EXAMPLE", "0CC556F3-7AB8-4C00-B0E5-98666EXAMPLE") `
-TargetConfiguration $config
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifyReservedInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-EC2SnapshotAttribute`
次のコード例は、`Edit-EC2SnapshotAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、CreateVolumePermission 属性を設定して、指定されたスナップショットを公開します。**
```
Edit-EC2SnapshotAttribute -SnapshotId snap-12345678 -Attribute CreateVolumePermission -OperationType Add -GroupName all
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifySnapshotAttribute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-EC2SpotFleetRequest`
次のコード例は、`Edit-EC2SpotFleetRequest` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンド例では、指定されたスポットフリートリクエストのターゲット容量を更新します。**
```
Edit-EC2SpotFleetRequest -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE -TargetCapacity 10
```
**出力:**
```
True
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifySpotFleetRequest](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-EC2SubnetAttribute`
次のコード例は、`Edit-EC2SubnetAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたサブネットのパブリック IP アドレス指定を有効にします。**
```
Edit-EC2SubnetAttribute -SubnetId subnet-1a2b3c4d -MapPublicIpOnLaunch $true
```
**例 2: この例では、指定されたサブネットのパブリック IP アドレス指定を無効にします。**
```
Edit-EC2SubnetAttribute -SubnetId subnet-1a2b3c4d -MapPublicIpOnLaunch $false
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifySubnetAttribute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-EC2VolumeAttribute`
次のコード例は、`Edit-EC2VolumeAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたボリュームの指定された属性を変更します。ボリュームの I/O オペレーションは、データの不整合の可能性が原因で中断された後に自動的に再開されます。**
```
Edit-EC2VolumeAttribute -VolumeId vol-12345678 -AutoEnableIO $true
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifyVolumeAttribute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-EC2VpcAttribute`
次のコード例は、`Edit-EC2VpcAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された VPC の DNS ホスト名のサポートを有効にします。**
```
Edit-EC2VpcAttribute -VpcId vpc-12345678 -EnableDnsHostnames $true
```
**例 2: この例では、指定された VPC の DNS ホスト名のサポートを無効にします。**
```
Edit-EC2VpcAttribute -VpcId vpc-12345678 -EnableDnsHostnames $false
```
**例 3: この例では、指定された VPC の DNS 解決のサポートを有効にします。**
```
Edit-EC2VpcAttribute -VpcId vpc-12345678 -EnableDnsSupport $true
```
**例 4: この例では、指定された VPC の DNS 解決のサポートを無効にします。**
```
Edit-EC2VpcAttribute -VpcId vpc-12345678 -EnableDnsSupport $false
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifyVpcAttribute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Enable-EC2VgwRoutePropagation`
次のコード例は、`Enable-EC2VgwRoutePropagation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された VGW が指定されたルーティングテーブルに自動的にルートを伝播できるようにします。**
```
Enable-EC2VgwRoutePropagation -RouteTableId rtb-12345678 -GatewayId vgw-1a2b3c4d
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[EnableVgwRoutePropagation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Enable-EC2VolumeIO`
次のコード例は、`Enable-EC2VolumeIO` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、I/O オペレーションが無効になっている場合に、指定されたボリュームの I/O オペレーションを有効にします。**
```
Enable-EC2VolumeIO -VolumeId vol-12345678
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[EnableVolumeIo](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Enable-EC2VpcClassicLink`
次のコード例は、`Enable-EC2VpcClassicLink` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ClassicLink の VPC vpc-0123456b789b0d12f を有効にします。**
```
Enable-EC2VpcClassicLink -VpcId vpc-0123456b789b0d12f
```
**出力:**
```
True
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[EnableVpcClassicLink](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Enable-EC2VpcClassicLinkDnsSupport`
次のコード例は、`Enable-EC2VpcClassicLinkDnsSupport` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、vpc-0b12d3456a7e8910d が ClassicLink の DNS ホスト名解決をサポートできるようにします。**
```
Enable-EC2VpcClassicLinkDnsSupport -VpcId vpc-0b12d3456a7e8910d -Region eu-west-1
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[EnableVpcClassicLinkDnsSupport](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2AccountAttribute`
次のコード例は、`Get-EC2AccountAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、リージョンの EC2-Classic および EC2-VPC にインスタンスを起動できるか、または EC2-VPC にのみインスタンスを起動できるかを記述します。**
```
(Get-EC2AccountAttribute -AttributeName supported-platforms).AttributeValues
```
**出力:**
```
AttributeValue
--------------
EC2
VPC
```
**例 2: この例では、デフォルトの VPC を記述します。リージョンにデフォルトの VPC がない場合は「none」です。**
```
(Get-EC2AccountAttribute -AttributeName default-vpc).AttributeValues
```
**出力:**
```
AttributeValue
--------------
vpc-12345678
```
**例 3: この例では、実行できるオンデマンドインスタンスの最大数を記述します。**
```
(Get-EC2AccountAttribute -AttributeName max-instances).AttributeValues
```
**出力:**
```
AttributeValue
--------------
20
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeAccountAttributes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2Address`
次のコード例は、`Get-EC2Address` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、EC2-Classic のインスタンスに指定された Elastic IP アドレスを記述します。**
```
Get-EC2Address -AllocationId eipalloc-12345678
```
**出力:**
```
AllocationId : eipalloc-12345678
AssociationId : eipassoc-12345678
Domain : vpc
InstanceId : i-87654321
NetworkInterfaceId : eni-12345678
NetworkInterfaceOwnerId : 12345678
PrivateIpAddress : 10.0.2.172
PublicIp : 198.51.100.2
```
**例 2: この例では、VPC 内のインスタンスの Elastic IP アドレスを記述します。この構文には、PowerShell バージョン 3 以降が必要です。**
```
Get-EC2Address -Filter @{ Name="domain";Values="vpc" }
```
**例 3: この例では、EC2-Classic のインスタンスに指定された Elastic IP アドレスを記述します。**
```
Get-EC2Address -PublicIp 203.0.113.17
```
**出力:**
```
AllocationId :
AssociationId :
Domain : standard
InstanceId : i-12345678
NetworkInterfaceId :
NetworkInterfaceOwnerId :
PrivateIpAddress :
PublicIp : 203.0.113.17
```
**例 4: この例では、EC2-Classic のインスタンスの Elastic IP アドレスを記述します。この構文には、PowerShell バージョン 3 以降が必要です。**
```
Get-EC2Address -Filter @{ Name="domain";Values="standard" }
```
**例 5: この例では、すべての Elastic IP アドレスを記述します。**
```
Get-EC2Address
```
**例 6: この例では、フィルターで指定されたインスタンス ID のパブリック IP とプライベート IP を返します。**
```
Get-EC2Address -Region eu-west-1 -Filter @{Name="instance-id";Values="i-0c12d3f4f567ffb89"} | Select-Object PrivateIpAddress, PublicIp
```
**出力:**
```
PrivateIpAddress PublicIp
---------------- --------
10.0.0.99 63.36.5.227
```
**例 7: この例では、割り当て ID、関連付け ID、インスタンス ID を持つすべての Elastic IP を取得します。**
```
Get-EC2Address -Region eu-west-1 | Select-Object InstanceId, AssociationId, AllocationId, PublicIp
```
**出力:**
```
InstanceId AssociationId AllocationId PublicIp
---------- ------------- ------------ --------
eipalloc-012e3b456789e1fad 17.212.120.178
i-0c123dfd3415bac67 eipassoc-0e123456bb7890bdb eipalloc-01cd23ebf45f7890c 17.212.124.77
eipalloc-012345678eeabcfad 17.212.225.7
i-0123d405c67e89a0c eipassoc-0c123b456783966ba eipalloc-0123cdd456a8f7892 37.216.52.173
i-0f1bf2f34c5678d09 eipassoc-0e12934568a952d96 eipalloc-0e1c23e4d5e6789e4 37.218.222.278
i-012e3cb4df567e8aa eipassoc-0d1b2fa4d67d03810 eipalloc-0123f456f78a01b58 37.210.82.27
i-0123bcf4b567890e1 eipassoc-01d2345f678903fb1 eipalloc-0e1db23cfef5c45c7 37.215.222.270
```
**例 8: この例では、タグキー「Category」と値「Prod」に一致する EC2 IP アドレスのリストを取得します。**
```
Get-EC2Address -Filter @{Name="tag:Category";Values="Prod"}
```
**出力:**
```
AllocationId : eipalloc-0123f456f81a01b58
AssociationId : eipassoc-0d1b23a456d103810
CustomerOwnedIp :
CustomerOwnedIpv4Pool :
Domain : vpc
InstanceId : i-012e3cb4df567e1aa
NetworkBorderGroup : eu-west-1
NetworkInterfaceId : eni-0123f41d5a60d5f40
NetworkInterfaceOwnerId : 123456789012
PrivateIpAddress : 192.168.1.84
PublicIp : 34.250.81.29
PublicIpv4Pool : amazon
Tags : {Category, Name}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeAddresses](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2AvailabilityZone`
次のコード例は、`Get-EC2AvailabilityZone` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、利用可能な現在のリージョンのアベイラビリティーゾーンについて記述します。**
```
Get-EC2AvailabilityZone
```
**出力:**
```
Messages RegionName State ZoneName
-------- ---------- ----- --------
{} us-west-2 available us-west-2a
{} us-west-2 available us-west-2b
{} us-west-2 available us-west-2c
```
**例 2: この例では、障害状態にあるアベイラビリティーゾーンを記述します。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
Get-EC2AvailabilityZone -Filter @{ Name="state";Values="impaired" }
```
**例 3: PowerShell バージョン 2 では、New-Object を使用してフィルターを作成する必要があります。**
```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = "impaired"
Get-EC2AvailabilityZone -Filter $filter
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeAvailabilityZones](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2BundleTask`
次のコード例は、`Get-EC2BundleTask` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したバンドルタスクを記述します。**
```
Get-EC2BundleTask -BundleId bun-12345678
```
**例 2: この例では、状態が「完了」または「失敗」のバンドルタスクについて説明します。**
```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = @( "complete", "failed" )
Get-EC2BundleTask -Filter $filter
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeBundleTasks](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2CapacityReservation`
次のコード例は、`Get-EC2CapacityReservation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、リージョンの 1 つ以上のキャパシティ予約について記述します。**
```
Get-EC2CapacityReservation -Region eu-west-1
```
**出力:**
```
AvailabilityZone : eu-west-1b
AvailableInstanceCount : 2
CapacityReservationId : cr-0c1f2345db6f7cdba
CreateDate : 3/28/2019 9:29:41 AM
EbsOptimized : True
EndDate : 1/1/0001 12:00:00 AM
EndDateType : unlimited
EphemeralStorage : False
InstanceMatchCriteria : open
InstancePlatform : Windows
InstanceType : m4.xlarge
State : active
Tags : {}
Tenancy : default
TotalInstanceCount : 2
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeCapacityReservations](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2ConsoleOutput`
次のコード例は、`Get-EC2ConsoleOutput` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Linux インスタンスのコンソール出力を取得します。コンソール出力はエンコードされます。**
```
Get-EC2ConsoleOutput -InstanceId i-0e19abcd47c123456
```
**出力:**
```
InstanceId Output
---------- ------
i-0e194d3c47c123637 WyAgICAwLjAwMDAwMF0gQ29tbW...bGU9dHR5UzAgc2Vs
```
**例 2: この例では、エンコードされたコンソール出力を変数に保存してからデコードします。**
```
$Output_encoded = (Get-EC2ConsoleOutput -InstanceId i-0e19abcd47c123456).Output
[System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($Output_encoded))
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetConsoleOutput](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2CustomerGateway`
次のコード例は、`Get-EC2CustomerGateway` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたカスタマーゲートウェイについて記述します。**
```
Get-EC2CustomerGateway -CustomerGatewayId cgw-1a2b3c4d
```
**出力:**
```
BgpAsn : 65534
CustomerGatewayId : cgw-1a2b3c4d
IpAddress : 203.0.113.12
State : available
Tags : {}
Type : ipsec.1
```
**例 2: この例では、保留中または使用可能な状態のカスタマーゲートウェイを記述します。**
```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = @( "pending", "available" )
Get-EC2CustomerGateway -Filter $filter
```
**例 3: この例では、すべてのカスタマーゲートウェイを記述します。**
```
Get-EC2CustomerGateway
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeCustomerGateways](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2DhcpOption`
次のコード例は、`Get-EC2DhcpOption` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、DHCP オプションセットを一覧表示します。**
```
Get-EC2DhcpOption
```
**出力:**
```
DhcpConfigurations DhcpOptionsId Tag
------------------ ------------- ---
{domain-name, domain-name-servers} dopt-1a2b3c4d {}
{domain-name, domain-name-servers} dopt-2a3b4c5d {}
{domain-name-servers} dopt-3a4b5c6d {}
```
**例 2: この例では、指定された DHCP オプションセットの設定の詳細を取得します。**
```
(Get-EC2DhcpOption -DhcpOptionsId dopt-1a2b3c4d).DhcpConfigurations
```
**出力:**
```
Key Values
--- ------
domain-name {abc.local}
domain-name-servers {10.0.0.101, 10.0.0.102}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeDhcpOptions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2FlowLog`
次のコード例は、`Get-EC2FlowLog` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ログの送信先タイプが「s3」の 1 つ以上のフローログを記述します。**
```
Get-EC2FlowLog -Filter @{Name="log-destination-type";Values="s3"}
```
**出力:**
```
CreationTime : 2/25/2019 9:07:36 PM
DeliverLogsErrorMessage :
DeliverLogsPermissionArn :
DeliverLogsStatus : SUCCESS
FlowLogId : fl-01b2e3d45f67f8901
FlowLogStatus : ACTIVE
LogDestination : arn:aws:s3:::amzn-s3-demo-bucket-dd-tata
LogDestinationType : s3
LogGroupName :
ResourceId : eni-01d2dda3456b7e890
TrafficType : ALL
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の[DescribeFlowLogs](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2Host`
次のコード例は、`Get-EC2Host` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、EC2 ホストの詳細を返します。**
```
Get-EC2Host
```
**出力:**
```
AllocationTime : 3/23/2019 4:55:22 PM
AutoPlacement : off
AvailabilityZone : eu-west-1b
AvailableCapacity : Amazon.EC2.Model.AvailableCapacity
ClientToken :
HostId : h-01e23f4cd567890f1
HostProperties : Amazon.EC2.Model.HostProperties
HostReservationId :
Instances : {}
ReleaseTime : 1/1/0001 12:00:00 AM
State : available
Tags : {}
```
**例 2: この例では、ホスト h-01e23f4cd567899f1 の AvailableInstanceCapacity をクエリします。**
```
Get-EC2Host -HostId h-01e23f4cd567899f1 | Select-Object -ExpandProperty AvailableCapacity | Select-Object -expand AvailableInstanceCapacity
```
**出力:**
```
AvailableCapacity InstanceType TotalCapacity
----------------- ------------ -------------
11 m4.xlarge 11
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeHosts](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2HostReservationOffering`
次のコード例は、`Get-EC2HostReservationOffering` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、PaymentOption が「NoUpfront」である、指定されたフィルター「instance-family」で購入できる専有ホスト予約を記述します。**
```
Get-EC2HostReservationOffering -Filter @{Name="instance-family";Values="m4"} | Where-Object PaymentOption -eq NoUpfront
```
**出力:**
```
CurrencyCode :
Duration : 94608000
HourlyPrice : 1.307
InstanceFamily : m4
OfferingId : hro-0c1f234567890d9ab
PaymentOption : NoUpfront
UpfrontPrice : 0.000
CurrencyCode :
Duration : 31536000
HourlyPrice : 1.830
InstanceFamily : m4
OfferingId : hro-04ad12aaaf34b5a67
PaymentOption : NoUpfront
UpfrontPrice : 0.000
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeHostReservationOfferings](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2HostReservationPurchasePreview`
次のコード例は、`Get-EC2HostReservationPurchasePreview` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、専有ホスト h-01e23f4cd567890f1 の構成と一致する設定の予約購入をプレビューします。**
```
Get-EC2HostReservationPurchasePreview -OfferingId hro-0c1f23456789d0ab -HostIdSet h-01e23f4cd567890f1
```
**出力:**
```
CurrencyCode Purchase TotalHourlyPrice TotalUpfrontPrice
------------ -------- ---------------- -----------------
{} 1.307 0.000
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetHostReservationPurchasePreview](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2IdFormat`
次のコード例は、`Get-EC2IdFormat` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリソースタイプの ID 形式を記述します。**
```
Get-EC2IdFormat -Resource instance
```
**出力:**
```
Resource UseLongIds
-------- ----------
instance False
```
**例 2: この例では、長い ID をサポートするすべてのリソースタイプの ID 形式を記述します。**
```
Get-EC2IdFormat
```
**出力:**
```
Resource UseLongIds
-------- ----------
reservation False
instance False
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeIdFormat](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2IdentityIdFormat`
次のコード例は、`Get-EC2IdentityIdFormat` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロールのリソース「image」の ID 形式を返します。**
```
Get-EC2IdentityIdFormat -PrincipalArn arn:aws:iam::123456789511:role/JDBC -Resource image
```
**出力:**
```
Deadline Resource UseLongIds
-------- -------- ----------
8/2/2018 11:30:00 PM image True
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeIdentityIdFormat](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2Image`
次のコード例は、`Get-EC2Image` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された AMI を記述します。**
```
Get-EC2Image -ImageId ami-12345678
```
**出力:**
```
Architecture : x86_64
BlockDeviceMappings : {/dev/xvda}
CreationDate : 2014-10-20T00:56:28.000Z
Description : My image
Hypervisor : xen
ImageId : ami-12345678
ImageLocation : 123456789012/my-image
ImageOwnerAlias :
ImageType : machine
KernelId :
Name : my-image
OwnerId : 123456789012
Platform :
ProductCodes : {}
Public : False
RamdiskId :
RootDeviceName : /dev/xvda
RootDeviceType : ebs
SriovNetSupport : simple
State : available
StateReason :
Tags : {Name}
VirtualizationType : hvm
```
**例 2: この例では、所有している AMI を記述します。**
```
Get-EC2Image -owner self
```
**例 3: この例では、Microsoft Windows Server を実行するパブリック AMI を記述します。**
```
Get-EC2Image -Filter @{ Name="platform"; Values="windows" }
```
**例 4: この例では、「us-west-2」リージョンのすべてのパブリック AMI を記述します。**
```
Get-EC2Image -Region us-west-2
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeImages](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2ImageAttribute`
次のコード例は、`Get-EC2ImageAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された AMI の説明を取得します。**
```
Get-EC2ImageAttribute -ImageId ami-12345678 -Attribute description
```
**出力:**
```
BlockDeviceMappings : {}
Description : My image description
ImageId : ami-12345678
KernelId :
LaunchPermissions : {}
ProductCodes : {}
RamdiskId :
SriovNetSupport :
```
**例 2: この例では、指定された AMI の起動許可を取得します。**
```
Get-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermission
```
**出力:**
```
BlockDeviceMappings : {}
Description :
ImageId : ami-12345678
KernelId :
LaunchPermissions : {all}
ProductCodes : {}
RamdiskId :
SriovNetSupport :
```
**例 3: この例では、拡張ネットワーキングが有効になっているかどうかをテストします。**
```
Get-EC2ImageAttribute -ImageId ami-12345678 -Attribute sriovNetSupport
```
**出力:**
```
BlockDeviceMappings : {}
Description :
ImageId : ami-12345678
KernelId :
LaunchPermissions : {}
ProductCodes : {}
RamdiskId :
SriovNetSupport : simple
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeImageAttribute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2ImportImageTask`
次のコード例は、`Get-EC2ImportImageTask` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたイメージのインポートタスクを記述します。**
```
Get-EC2ImportImageTask -ImportTaskId import-ami-hgfedcba
```
**出力:**
```
Architecture : x86_64
Description : Windows Image 2
Hypervisor :
ImageId : ami-1a2b3c4d
ImportTaskId : import-ami-hgfedcba
LicenseType : AWS
Platform : Windows
Progress :
SnapshotDetails : {/dev/sda1}
Status : completed
StatusMessage :
```
**例 2: この例では、すべてのイメージのインポートタスクを記述します。**
```
Get-EC2ImportImageTask
```
**出力:**
```
Architecture :
Description : Windows Image 1
Hypervisor :
ImageId :
ImportTaskId : import-ami-abcdefgh
LicenseType : AWS
Platform : Windows
Progress :
SnapshotDetails : {}
Status : deleted
StatusMessage : User initiated task cancelation
Architecture : x86_64
Description : Windows Image 2
Hypervisor :
ImageId : ami-1a2b3c4d
ImportTaskId : import-ami-hgfedcba
LicenseType : AWS
Platform : Windows
Progress :
SnapshotDetails : {/dev/sda1}
Status : completed
StatusMessage :
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeImportImageTasks](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2ImportSnapshotTask`
次のコード例は、`Get-EC2ImportSnapshotTask` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたスナップショットのインポートタスクを記述します。**
```
Get-EC2ImportSnapshotTask -ImportTaskId import-snap-abcdefgh
```
**出力:**
```
Description ImportTaskId SnapshotTaskDetail
----------------- -------------------- ------------------
Disk Image Import 1 import-snap-abcdefgh Amazon.EC2.Model.SnapshotTaskDetail
```
**例 2: この例では、すべてのスナップショットのインポートタスクを記述します。**
```
Get-EC2ImportSnapshotTask
```
**出力:**
```
Description ImportTaskId SnapshotTaskDetail
----------------- -------------------- ------------------
Disk Image Import 1 import-snap-abcdefgh Amazon.EC2.Model.SnapshotTaskDetail
Disk Image Import 2 import-snap-hgfedcba Amazon.EC2.Model.SnapshotTaskDetail
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeImportSnapshotTasks](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2Instance`
次のコード例は、`Get-EC2Instance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したインスタンスを記述します。**
```
(Get-EC2Instance -InstanceId i-12345678).Instances
```
**出力:**
```
AmiLaunchIndex : 0
Architecture : x86_64
BlockDeviceMappings : {/dev/sda1}
ClientToken : TleEy1448154045270
EbsOptimized : False
Hypervisor : xen
IamInstanceProfile : Amazon.EC2.Model.IamInstanceProfile
ImageId : ami-12345678
InstanceId : i-12345678
InstanceLifecycle :
InstanceType : t2.micro
KernelId :
KeyName : my-key-pair
LaunchTime : 12/4/2015 4:44:40 PM
Monitoring : Amazon.EC2.Model.Monitoring
NetworkInterfaces : {ip-10-0-2-172.us-west-2.compute.internal}
Placement : Amazon.EC2.Model.Placement
Platform : Windows
PrivateDnsName : ip-10-0-2-172.us-west-2.compute.internal
PrivateIpAddress : 10.0.2.172
ProductCodes : {}
PublicDnsName :
PublicIpAddress :
RamdiskId :
RootDeviceName : /dev/sda1
RootDeviceType : ebs
SecurityGroups : {default}
SourceDestCheck : True
SpotInstanceRequestId :
SriovNetSupport :
State : Amazon.EC2.Model.InstanceState
StateReason :
StateTransitionReason :
SubnetId : subnet-12345678
Tags : {Name}
VirtualizationType : hvm
VpcId : vpc-12345678
```
**例 2: この例では、現在のリージョンのすべてのインスタンスを予約別にグループ化して記述します。インスタンスの詳細を表示するには、各予約オブジェクト内のインスタンスコレクションを展開します。**
```
Get-EC2Instance
```
**出力:**
```
GroupNames : {}
Groups : {}
Instances : {}
OwnerId : 123456789012
RequesterId : 226008221399
ReservationId : r-c5df370c
GroupNames : {}
Groups : {}
Instances : {}
OwnerId : 123456789012
RequesterId : 854251627541
ReservationId : r-63e65bab
...
```
**例 3: この例では、フィルターを使用して VPC の特定のサブネット内の EC2 インスタンスをクエリする方法を示します。**
```
(Get-EC2Instance -Filter @{Name="vpc-id";Values="vpc-1a2bc34d"},@{Name="subnet-id";Values="subnet-1a2b3c4d"}).Instances
```
**出力:**
```
InstanceId InstanceType Platform PrivateIpAddress PublicIpAddress SecurityGroups SubnetId VpcId
---------- ------------ -------- ---------------- --------------- -------------- -------- -----
i-01af...82cf180e19 t2.medium Windows 10.0.0.98 ... subnet-1a2b3c4d vpc-1a2b3c4d
i-0374...7e9d5b0c45 t2.xlarge Windows 10.0.0.53 ... subnet-1a2b3c4d vpc-1a2b3c4d
```
**例 4: この例では、複数の値を持つフィルターを使用して、実行中および停止中の EC2 インスタンスをクエリする方法を示します。**
```
$InstanceParams = @{
Filter = @(
@{'Name' = 'instance-state-name';'Values' = @("running","stopped")}
)
}
(Get-EC2Instance @InstanceParams).Instances
```
**出力:**
```
InstanceId InstanceType Platform PrivateIpAddress PublicIpAddress SecurityGroups SubnetId VpcId
---------- ------------ -------- ---------------- --------------- -------------- -------- -----
i-05a9...f6c5f46e18 t3.medium 10.0.1.7 ... subnet-1a2b3c4d vpc-1a2b3c4d
i-02cf...945c4fdd07 t3.medium Windows 10.0.1.8 ... subnet-1a2b3c4d vpc-1a2b3c4d
i-0ac0...c037f9f3a1 t3.xlarge Windows 10.0.1.10 ... subnet-1a2b3c4d vpc-1a2b3c4d
i-066b...57b7b08888 t3.medium Windows 10.0.1.11 ... subnet-1a2b3c4d vpc-1a2b3c4d
i-0fee...82e83ccd72 t3.medium Windows 10.0.1.5 ... subnet-1a2b3c4d vpc-1a2b3c4d
i-0a68...274cc5043b t3.medium Windows 10.0.1.6 ... subnet-1a2b3c4d vpc-1a2b3c4d
```
**例 5: この例では、複数の値を持つフィルターを使用して、実行中と停止中の両方の EC2 インスタンスをクエリし、Select-Object コマンドレットを使用して出力する特定の値を選択する方法を示します。**
```
$InstanceParams = @{
Filter = @(
@{'Name' = 'instance-state-name';'Values' = @("running","stopped")}
)
}
$SelectParams = @{
Property = @(
"InstanceID", "InstanceType", "Platform", "PrivateIpAddress",
@{Name="Name";Expression={$_.Tags[$_.Tags.Key.IndexOf("Name")].Value}},
@{Name="State";Expression={$_.State.Name}}
)
}
$result = Get-EC2Instance @InstanceParams
$result.Instances | Select-Object @SelectParams | Format-Table -AutoSize
```
**出力:**
```
InstanceId InstanceType Platform PrivateIpAddress Name State
---------- ------------ -------- ---------------- ---- -----
i-05a9...f6c5f46e18 t3.medium 10.0.1.7 ec2-name-01 running
i-02cf...945c4fdd07 t3.medium Windows 10.0.1.8 ec2-name-02 stopped
i-0ac0...c037f9f3a1 t3.xlarge Windows 10.0.1.10 ec2-name-03 running
i-066b...57b7b08888 t3.medium Windows 10.0.1.11 ec2-name-04 stopped
i-0fee...82e83ccd72 t3.medium Windows 10.0.1.5 ec2-name-05 running
i-0a68...274cc5043b t3.medium Windows 10.0.1.6 ec2-name-06 stopped
```
**例 6: この例では、実際に EC2 インスタンスを取得することなく、DryRun パラメータを使用して EC2 インスタンス取得のアクセス許可を検証します。注: 成功すると例外がスローされますが、これは正常な動作です。**
```
Get-EC2Tag -DryRun $true
```
**出力:**
```
Get-EC2Instance: Request would have succeeded, but DryRun flag is set.
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2InstanceAttribute`
次のコード例は、`Get-EC2InstanceAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたインスタンスのインスタンスタイプを記述します。**
```
Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute instanceType
```
**出力:**
```
InstanceType : t2.micro
```
**例 2: この例では、指定されたインスタンスで拡張ネットワーキングが有効になっているかどうかを記述します。**
```
Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute sriovNetSupport
```
**出力:**
```
SriovNetSupport : simple
```
**例 3: この例では、指定されたインスタンスのセキュリティグループについて記述します。**
```
(Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute groupSet).Groups
```
**出力:**
```
GroupId
-------
sg-12345678
sg-45678901
```
**例 4: この例では、指定したインスタンスで EBS 最適化が有効になっているかどうかを記述します。**
```
Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute ebsOptimized
```
**出力:**
```
EbsOptimized : False
```
**例 5: この例では、指定されたインスタンスの「disableApiTermination」属性を記述します。**
```
Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute disableApiTermination
```
**出力:**
```
DisableApiTermination : False
```
**例 6: この例では、指定されたインスタンスの「instanceInitiatedShutdownBehavior」属性を記述します。**
```
Get-EC2InstanceAttribute -InstanceId i-12345678 -Attribute instanceInitiatedShutdownBehavior
```
**出力:**
```
InstanceInitiatedShutdownBehavior : stop
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeInstanceAttribute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2InstanceMetadata`
次のコード例は、`Get-EC2InstanceMetadata` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: クエリできるインスタンスメタデータの利用可能なカテゴリを一覧表示します。**
```
Get-EC2InstanceMetadata -ListCategory
```
**出力:**
```
AmiId
LaunchIndex
ManifestPath
AncestorAmiId
BlockDeviceMapping
InstanceId
InstanceType
LocalHostname
LocalIpv4
KernelId
AvailabilityZone
ProductCode
PublicHostname
PublicIpv4
PublicKey
RamdiskId
Region
ReservationId
SecurityGroup
UserData
InstanceMonitoring
IdentityDocument
IdentitySignature
IdentityPkcs7
```
**例 2: インスタンスの起動に使用された Amazon マシンイメージ (AMI) の ID を返します。**
```
Get-EC2InstanceMetadata -Category AmiId
```
**出力:**
```
ami-b2e756ca
```
**例 3: この例では、インスタンスの JSON 形式の ID ドキュメントをクエリします。**
```
Get-EC2InstanceMetadata -Category IdentityDocument
{
"availabilityZone" : "us-west-2a",
"devpayProductCodes" : null,
"marketplaceProductCodes" : null,
"version" : "2017-09-30",
"instanceId" : "i-01ed50f7e2607f09e",
"billingProducts" : [ "bp-6ba54002" ],
"instanceType" : "t2.small",
"pendingTime" : "2018-03-07T16:26:04Z",
"imageId" : "ami-b2e756ca",
"privateIp" : "10.0.0.171",
"accountId" : "111122223333",
"architecture" : "x86_64",
"kernelId" : null,
"ramdiskId" : null,
"region" : "us-west-2"
}
```
**例 4: この例では、パスクエリを使用してインスタンスのネットワークインターフェイスの MAC を取得します。**
```
Get-EC2InstanceMetadata -Path "/network/interfaces/macs"
```
**出力:**
```
02:80:7f:ef:4c:e0/
```
**例 5: インスタンスに関連付けられた IAM ロールがある場合、インスタンスの LastUpdated の日付、InstanceProfileArn、InstanceProfileId など、インスタンスプロファイルが更新された最終時刻に関する情報が返されます。**
```
Get-EC2InstanceMetadata -Path "/iam/info"
```
**出力:**
```
{
"Code" : "Success",
"LastUpdated" : "2018-03-08T03:38:40Z",
"InstanceProfileArn" : "arn:aws:iam::111122223333:instance-profile/MyLaunchRole_Profile",
"InstanceProfileId" : "AIPAI4...WVK2RW"
}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[Get-EC2InstanceMetadata](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2InstanceStatus`
次のコード例は、`Get-EC2InstanceStatus` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたインスタンスのステータスを記述します。**
```
Get-EC2InstanceStatus -InstanceId i-12345678
```
**出力:**
```
AvailabilityZone : us-west-2a
Events : {}
InstanceId : i-12345678
InstanceState : Amazon.EC2.Model.InstanceState
Status : Amazon.EC2.Model.InstanceStatusSummary
SystemStatus : Amazon.EC2.Model.InstanceStatusSummary
```
```
$status = Get-EC2InstanceStatus -InstanceId i-12345678
$status.InstanceState
```
**出力:**
```
Code Name
---- ----
16 running
```
```
$status.Status
```
**出力:**
```
Details Status
------- ------
{reachability} ok
```
```
$status.SystemStatus
```
**出力:**
```
Details Status
------- ------
{reachability} ok
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeInstanceStatus](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2InternetGateway`
次のコード例は、`Get-EC2InternetGateway` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたインターネットゲートウェイを記述します。**
```
Get-EC2InternetGateway -InternetGatewayId igw-1a2b3c4d
```
**出力:**
```
Attachments InternetGatewayId Tags
----------- ----------------- ----
{vpc-1a2b3c4d} igw-1a2b3c4d {}
```
**例 2: この例では、すべてのインターネットゲートウェイを記述します。**
```
Get-EC2InternetGateway
```
**出力:**
```
Attachments InternetGatewayId Tags
----------- ----------------- ----
{vpc-1a2b3c4d} igw-1a2b3c4d {}
{} igw-2a3b4c5d {}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeInternetGateways](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2KeyPair`
次のコード例は、`Get-EC2KeyPair` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したキーペアを記述します。**
```
Get-EC2KeyPair -KeyName my-key-pair
```
**出力:**
```
KeyFingerprint KeyName
-------------- -------
1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f my-key-pair
```
**例 2: この例では、すべてのキーペアを記述します。**
```
Get-EC2KeyPair
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeKeyPairs](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2NetworkAcl`
次のコード例は、`Get-EC2NetworkAcl` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したネットワーク ACL を記述します。**
```
Get-EC2NetworkAcl -NetworkAclId acl-12345678
```
**出力:**
```
Associations : {aclassoc-1a2b3c4d}
Entries : {Amazon.EC2.Model.NetworkAclEntry, Amazon.EC2.Model.NetworkAclEntry}
IsDefault : False
NetworkAclId : acl-12345678
Tags : {Name}
VpcId : vpc-12345678
```
**例 2: この例では、指定されたネットワーク ACL のルールを記述します。**
```
(Get-EC2NetworkAcl -NetworkAclId acl-12345678).Entries
```
**出力:**
```
CidrBlock : 0.0.0.0/0
Egress : True
IcmpTypeCode :
PortRange :
Protocol : -1
RuleAction : deny
RuleNumber : 32767
CidrBlock : 0.0.0.0/0
Egress : False
IcmpTypeCode :
PortRange :
Protocol : -1
RuleAction : deny
RuleNumber : 32767
```
**例 3: この例では、すべてのネットワーク ACL を記述します。**
```
Get-EC2NetworkAcl
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeNetworkAcls](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2NetworkInterface`
次のコード例は、`Get-EC2NetworkInterface` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたネットワークインターフェイスを記述します。**
```
Get-EC2NetworkInterface -NetworkInterfaceId eni-12345678
```
**出力:**
```
Association :
Attachment : Amazon.EC2.Model.NetworkInterfaceAttachment
AvailabilityZone : us-west-2c
Description :
Groups : {my-security-group}
MacAddress : 0a:e9:a6:19:4c:7f
NetworkInterfaceId : eni-12345678
OwnerId : 123456789012
PrivateDnsName : ip-10-0-0-107.us-west-2.compute.internal
PrivateIpAddress : 10.0.0.107
PrivateIpAddresses : {ip-10-0-0-107.us-west-2.compute.internal}
RequesterId :
RequesterManaged : False
SourceDestCheck : True
Status : in-use
SubnetId : subnet-1a2b3c4d
TagSet : {}
VpcId : vpc-12345678
```
**例 2: この例では、すべてのネットワークインターフェイスを記述します。**
```
Get-EC2NetworkInterface
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeNetworkInterfaces](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2NetworkInterfaceAttribute`
次のコード例は、`Get-EC2NetworkInterfaceAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたネットワークインターフェイスを記述します。**
```
Get-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-12345678 -Attribute Attachment
```
**出力:**
```
Attachment : Amazon.EC2.Model.NetworkInterfaceAttachment
```
**例 2: この例では、指定されたネットワークインターフェイスを記述します。**
```
Get-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-12345678 -Attribute Description
```
**出力:**
```
Description : My description
```
**例 3: この例では、指定されたネットワークインターフェイスを記述します。**
```
Get-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-12345678 -Attribute GroupSet
```
**出力:**
```
Groups : {my-security-group}
```
**例 4: この例では、指定されたネットワークインターフェイスを記述します。**
```
Get-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-12345678 -Attribute SourceDestCheck
```
**出力:**
```
SourceDestCheck : True
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeNetworkInterfaceAttribute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2PasswordData`
次のコード例は、`Get-EC2PasswordData` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Amazon EC2 が指定された Windows インスタンスの管理者アカウントに割り当てたパスワードを復号します。pem ファイルを指定すると、-Decrypt スイッチの設定が自動的に適用されます。**
```
Get-EC2PasswordData -InstanceId i-12345678 -PemFile C:\path\my-key-pair.pem
```
**出力:**
```
mYZ(PA9?C)Q
```
**例 2: (Windows PowerShell のみ) インスタンスを検査して、インスタンスの起動に使用されるキーペアの名前を判断し、 AWS Toolkit for Visual Studio の設定ストアで対応するキーペアデータを見つけようとします。キーペアデータが見つかった場合、パスワードは復号されます。**
```
Get-EC2PasswordData -InstanceId i-12345678 -Decrypt
```
**出力:**
```
mYZ(PA9?C)Q
```
**例 3: インスタンスの暗号化されたパスワードデータを返します。**
```
Get-EC2PasswordData -InstanceId i-12345678
```
**出力:**
```
iVz3BAK/WAXV.....dqt8WeMA==
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[GetPasswordData](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2PlacementGroup`
次のコード例は、`Get-EC2PlacementGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したプレイスメントグループを記述します。**
```
Get-EC2PlacementGroup -GroupName my-placement-group
```
**出力:**
```
GroupName State Strategy
--------- ----- --------
my-placement-group available cluster
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribePlacementGroups](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2PrefixList`
次のコード例は、`Get-EC2PrefixList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 リージョンの AWS のサービス プレフィックスリスト形式で使用可能な を取得します。**
```
Get-EC2PrefixList
```
**出力:**
```
Cidrs PrefixListId PrefixListName
----- ------------ --------------
{52.94.5.0/24, 52.119.240.0/21, 52.94.24.0/23} pl-6fa54006 com.amazonaws.eu-west-1.dynamodb
{52.218.0.0/17, 54.231.128.0/19} pl-6da54004 com.amazonaws.eu-west-1.s3
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribePrefixLists](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2Region`
次のコード例は、`Get-EC2Region` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、使用可能なリージョンについて記述します。**
```
Get-EC2Region
```
**出力:**
```
Endpoint RegionName
-------- ----------
ec2.eu-west-1.amazonaws.com eu-west-1
ec2.ap-southeast-1.amazonaws.com ap-southeast-1
ec2.ap-southeast-2.amazonaws.com ap-southeast-2
ec2.eu-central-1.amazonaws.com eu-central-1
ec2.ap-northeast-1.amazonaws.com ap-northeast-1
ec2.us-east-1.amazonaws.com us-east-1
ec2.sa-east-1.amazonaws.com sa-east-1
ec2.us-west-1.amazonaws.com us-west-1
ec2.us-west-2.amazonaws.com us-west-2
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeRegions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2RouteTable`
次のコード例は、`Get-EC2RouteTable` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、すべてのルートテーブルについて記述します。**
```
Get-EC2RouteTable
```
**出力:**
```
DestinationCidrBlock : 10.0.0.0/16
DestinationPrefixListId :
GatewayId : local
InstanceId :
InstanceOwnerId :
NetworkInterfaceId :
Origin : CreateRouteTable
State : active
VpcPeeringConnectionId :
DestinationCidrBlock : 0.0.0.0/0
DestinationPrefixListId :
GatewayId : igw-1a2b3c4d
InstanceId :
InstanceOwnerId :
NetworkInterfaceId :
Origin : CreateRoute
State : active
VpcPeeringConnectionId :
```
**例 2: この例では、指定されたルートテーブルの詳細を返します。**
```
Get-EC2RouteTable -RouteTableId rtb-1a2b3c4d
```
**例 3: この例では、指定された VPC のルートテーブルを記述します。**
```
Get-EC2RouteTable -Filter @{ Name="vpc-id"; Values="vpc-1a2b3c4d" }
```
**出力:**
```
Associations : {rtbassoc-12345678}
PropagatingVgws : {}
Routes : {, }
RouteTableId : rtb-1a2b3c4d
Tags : {}
VpcId : vpc-1a2b3c4d
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeRouteTables](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2ScheduledInstance`
次のコード例は、`Get-EC2ScheduledInstance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定のスケジュールされたインスタンスを記述します。**
```
Get-EC2ScheduledInstance -ScheduledInstanceId sci-1234-1234-1234-1234-123456789012
```
**出力:**
```
AvailabilityZone : us-west-2b
CreateDate : 1/25/2016 1:43:38 PM
HourlyPrice : 0.095
InstanceCount : 1
InstanceType : c4.large
NetworkPlatform : EC2-VPC
NextSlotStartTime : 1/31/2016 1:00:00 AM
Platform : Linux/UNIX
PreviousSlotEndTime :
Recurrence : Amazon.EC2.Model.ScheduledInstanceRecurrence
ScheduledInstanceId : sci-1234-1234-1234-1234-123456789012
SlotDurationInHours : 32
TermEndDate : 1/31/2017 1:00:00 AM
TermStartDate : 1/31/2016 1:00:00 AM
TotalScheduledInstanceHours : 1696
```
**例 2: この例では、すべてのスケジュールされたインスタンスを記述します。**
```
Get-EC2ScheduledInstance
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeScheduledInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2ScheduledInstanceAvailability`
次のコード例は、`Get-EC2ScheduledInstanceAvailability` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した日付から毎週日曜日に発生するスケジュールを記述します。**
```
Get-EC2ScheduledInstanceAvailability -Recurrence_Frequency Weekly -Recurrence_Interval 1 -Recurrence_OccurrenceDay 1 -FirstSlotStartTimeRange_EarliestTime 2016-01-31T00:00:00Z -FirstSlotStartTimeRange_LatestTime 2016-01-31T04:00:00Z
```
**出力:**
```
AvailabilityZone : us-west-2b
AvailableInstanceCount : 20
FirstSlotStartTime : 1/31/2016 8:00:00 AM
HourlyPrice : 0.095
InstanceType : c4.large
MaxTermDurationInDays : 366
MinTermDurationInDays : 366
NetworkPlatform : EC2-VPC
Platform : Linux/UNIX
PurchaseToken : eyJ2IjoiMSIsInMiOjEsImMiOi...
Recurrence : Amazon.EC2.Model.ScheduledInstanceRecurrence
SlotDurationInHours : 23
TotalScheduledInstanceHours : 1219
...
```
**例 2: 結果を絞り込むには、オペレーティングシステム、ネットワーク、インスタンスタイプなどの条件でフィルターを追加できます。**
```
-Filter @{ Name="platform";Values="Linux/UNIX" },@{ Name="network-platform";Values="EC2-VPC" },@{ Name="instance-type";Values="c4.large" }
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeScheduledInstanceAvailability](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2SecurityGroup`
次のコード例は、`Get-EC2SecurityGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、VPC に指定されたセキュリティグループについて記述します。VPC に属するセキュリティグループを使用する場合は、グループ名 (-GroupName パラメータ) ではなくセキュリティグループ ID (-GroupId パラメータ) を使用してグループを参照する必要があります。**
```
Get-EC2SecurityGroup -GroupId sg-12345678
```
**出力:**
```
Description : default VPC security group
GroupId : sg-12345678
GroupName : default
IpPermissions : {Amazon.EC2.Model.IpPermission}
IpPermissionsEgress : {Amazon.EC2.Model.IpPermission}
OwnerId : 123456789012
Tags : {}
VpcId : vpc-12345678
```
**例 2: この例では、EC2-Classic に指定されたセキュリティグループを記述します。EC2-Classic のセキュリティグループを使用する場合は、グループ名 (-GroupName パラメータ) またはグループ ID (-GroupId パラメータ) を使用してセキュリティグループを参照できます。**
```
Get-EC2SecurityGroup -GroupName my-security-group
```
**出力:**
```
Description : my security group
GroupId : sg-45678901
GroupName : my-security-group
IpPermissions : {Amazon.EC2.Model.IpPermission, Amazon.EC2.Model.IpPermission}
IpPermissionsEgress : {}
OwnerId : 123456789012
Tags : {}
VpcId :
```
**例 3: この例では、vpc-0fc1ff23456b789eb のすべてのセキュリティグループを取得します。**
```
Get-EC2SecurityGroup -Filter @{Name="vpc-id";Values="vpc-0fc1ff23456b789eb"}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeSecurityGroups](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2Snapshot`
次のコード例は、`Get-EC2Snapshot` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したスナップショットを記述します。**
```
Get-EC2Snapshot -SnapshotId snap-12345678
```
**出力:**
```
DataEncryptionKeyId :
Description : Created by CreateImage(i-1a2b3c4d) for ami-12345678 from vol-12345678
Encrypted : False
KmsKeyId :
OwnerAlias :
OwnerId : 123456789012
Progress : 100%
SnapshotId : snap-12345678
StartTime : 10/23/2014 6:01:28 AM
State : completed
StateMessage :
Tags : {}
VolumeId : vol-12345678
VolumeSize : 8
```
**例 2: この例では、「Name」タグを持つスナップショットを記述します。**
```
Get-EC2Snapshot | ? { $_.Tags.Count -gt 0 -and $_.Tags.Key -eq "Name" }
```
**例 3: この例では、「Name」タグと値「TestValue」を持つスナップショットを記述します。**
```
Get-EC2Snapshot | ? { $_.Tags.Count -gt 0 -and $_.Tags.Key -eq "Name" -and $_.Tags.Value -eq "TestValue" }
```
**例 4: この例では、すべてのスナップショットを記述します。**
```
Get-EC2Snapshot -Owner self
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeSnapshots](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2SnapshotAttribute`
次のコード例は、`Get-EC2SnapshotAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたスナップショットの指定された属性を記述します。**
```
Get-EC2SnapshotAttribute -SnapshotId snap-12345678 -Attribute ProductCodes
```
**出力:**
```
CreateVolumePermissions ProductCodes SnapshotId
----------------------- ------------ ----------
{} {} snap-12345678
```
**例 2: この例では、指定されたスナップショットの指定された属性を記述します。**
```
(Get-EC2SnapshotAttribute -SnapshotId snap-12345678 -Attribute CreateVolumePermission).CreateVolumePermissions
```
**出力:**
```
Group UserId
----- ------
all
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeSnapshotAttribute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2SpotDatafeedSubscription`
次のコード例は、`Get-EC2SpotDatafeedSubscription` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、スポットインスタンスのデータフィードについて記述します。**
```
Get-EC2SpotDatafeedSubscription
```
**出力:**
```
Bucket : amzn-s3-demo-bucket
Fault :
OwnerId : 123456789012
Prefix : spotdata
State : Active
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeSpotDatafeedSubscription](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2SpotFleetInstance`
次のコード例は、`Get-EC2SpotFleetInstance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたスポットフリートリクエストに関連付けられたインスタンスについて記述します。**
```
Get-EC2SpotFleetInstance -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
```
**出力:**
```
InstanceId InstanceType SpotInstanceRequestId
---------- ------------ ---------------------
i-f089262a c3.large sir-12345678
i-7e8b24a4 c3.large sir-87654321
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeSpotFleetInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2SpotFleetRequest`
次のコード例は、`Get-EC2SpotFleetRequest` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたスポットフリートリクエストを記述します。**
```
Get-EC2SpotFleetRequest -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE | format-list
```
**出力:**
```
ConfigData : Amazon.EC2.Model.SpotFleetRequestConfigData
CreateTime : 12/26/2015 8:23:33 AM
SpotFleetRequestId : sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
SpotFleetRequestState : active
```
**例 2: この例では、すべてのスポットフリートリクエストを記述します。**
```
Get-EC2SpotFleetRequest
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeSpotFleetRequests](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2SpotFleetRequestHistory`
次のコード例は、`Get-EC2SpotFleetRequestHistory` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたスポットフリートリクエストの履歴を記述します。**
```
Get-EC2SpotFleetRequestHistory -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE -StartTime 2015-12-26T00:00:00Z
```
**出力:**
```
HistoryRecords : {Amazon.EC2.Model.HistoryRecord, Amazon.EC2.Model.HistoryRecord...}
LastEvaluatedTime : 12/26/2015 8:29:11 AM
NextToken :
SpotFleetRequestId : sfr-088bc5f1-7e7b-451a-bd13-757f10672b93
StartTime : 12/25/2015 8:00:00 AM
```
```
(Get-EC2SpotFleetRequestHistory -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE -StartTime 2015-12-26T00:00:00Z).HistoryRecords
```
**出力:**
```
EventInformation EventType Timestamp
---------------- --------- ---------
Amazon.EC2.Model.EventInformation fleetRequestChange 12/26/2015 8:23:33 AM
Amazon.EC2.Model.EventInformation fleetRequestChange 12/26/2015 8:23:33 AM
Amazon.EC2.Model.EventInformation fleetRequestChange 12/26/2015 8:23:33 AM
Amazon.EC2.Model.EventInformation launched 12/26/2015 8:25:34 AM
Amazon.EC2.Model.EventInformation launched 12/26/2015 8:25:05 AM
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeSpotFleetRequestHistory](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2SpotInstanceRequest`
次のコード例は、`Get-EC2SpotInstanceRequest` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したスポットインスタンスを記述します。**
```
Get-EC2SpotInstanceRequest -SpotInstanceRequestId sir-12345678
```
**出力:**
```
ActualBlockHourlyPrice :
AvailabilityZoneGroup :
BlockDurationMinutes : 0
CreateTime : 4/8/2015 2:51:33 PM
Fault :
InstanceId : i-12345678
LaunchedAvailabilityZone : us-west-2b
LaunchGroup :
LaunchSpecification : Amazon.EC2.Model.LaunchSpecification
ProductDescription : Linux/UNIX
SpotInstanceRequestId : sir-12345678
SpotPrice : 0.020000
State : active
Status : Amazon.EC2.Model.SpotInstanceStatus
Tags : {Name}
Type : one-time
```
**例 2: この例では、すべてのスポットインスタンスリクエストを記述します。**
```
Get-EC2SpotInstanceRequest
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeSpotInstanceRequests](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2SpotPriceHistory`
次のコード例は、`Get-EC2SpotPriceHistory` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたインスタンスタイプとアベイラビリティーゾーンのスポット料金履歴から直近 10 件のエントリを取得します。-AvailabilityZone パラメータに指定された値は、コマンドレットの -Region パラメータ (例に示されていない) に指定されたリージョン値に対して有効であるか、シェルでデフォルトとして設定されている必要があることに注意してください。このコマンド例では、「us-west-2」のデフォルトリージョンが環境で設定されていることを前提としています。**
```
Get-EC2SpotPriceHistory -InstanceType c3.large -AvailabilityZone us-west-2a -MaxResult 10
```
**出力:**
```
AvailabilityZone : us-west-2a
InstanceType : c3.large
Price : 0.017300
ProductDescription : Linux/UNIX (Amazon VPC)
Timestamp : 12/25/2015 7:39:49 AM
AvailabilityZone : us-west-2a
InstanceType : c3.large
Price : 0.017200
ProductDescription : Linux/UNIX (Amazon VPC)
Timestamp : 12/25/2015 7:38:29 AM
AvailabilityZone : us-west-2a
InstanceType : c3.large
Price : 0.017300
ProductDescription : Linux/UNIX (Amazon VPC)
Timestamp : 12/25/2015 6:57:13 AM
...
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeSpotPriceHistory](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2Subnet`
次のコード例は、`Get-EC2Subnet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したサブネットを記述します。**
```
Get-EC2Subnet -SubnetId subnet-1a2b3c4d
```
**出力:**
```
AvailabilityZone : us-west-2c
AvailableIpAddressCount : 251
CidrBlock : 10.0.0.0/24
DefaultForAz : False
MapPublicIpOnLaunch : False
State : available
SubnetId : subnet-1a2b3c4d
Tags : {}
VpcId : vpc-12345678
```
**例 2: この例では、すべてのサブネットを記述します。**
```
Get-EC2Subnet
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeSubnets](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2Tag`
次のコード例は、`Get-EC2Tag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、リソースタイプ「image」のタグを取得します。**
```
Get-EC2Tag -Filter @{Name="resource-type";Values="image"}
```
**出力:**
```
Key ResourceId ResourceType Value
--- ---------- ------------ -----
Name ami-0a123b4ccb567a8ea image Win7-Imported
auto-delete ami-0a123b4ccb567a8ea image never
```
**例 2: この例では、すべてのリソースのすべてのタグを取得し、リソースタイプ別にグループ化します。**
```
Get-EC2Tag | Group-Object resourcetype
```
**出力:**
```
Count Name Group
----- ---- -----
9 subnet {Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription...}
53 instance {Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription...}
3 route-table {Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription}
5 security-group {Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription...}
30 volume {Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription...}
1 internet-gateway {Amazon.EC2.Model.TagDescription}
3 network-interface {Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription}
4 elastic-ip {Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription}
1 dhcp-options {Amazon.EC2.Model.TagDescription}
2 image {Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription}
3 vpc {Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription, Amazon.EC2.Model.TagDescription}
```
**例 3: この例では、指定されたリージョンでタグ「auto-delete」と値「no」を持つすべてのリソースを表示します。**
```
Get-EC2Tag -Region eu-west-1 -Filter @{Name="tag:auto-delete";Values="no"}
```
**出力:**
```
Key ResourceId ResourceType Value
--- ---------- ------------ -----
auto-delete i-0f1bce234d5dd678b instance no
auto-delete vol-01d234aa5678901a2 volume no
auto-delete vol-01234bfb5def6f7b8 volume no
auto-delete vol-01ccb23f4c5e67890 volume no
```
**例 4: この例では、タグ「auto-delete」と値「no」を持つすべてのリソースを取得し、次のパイプでさらにフィルターして「instance」リソースタイプのみを解析し、最終的に各インスタンスリソースに対して、そのインスタンス ID 自体を値とする「ThisInstance」タグを作成します。**
```
Get-EC2Tag -Region eu-west-1 -Filter @{Name="tag:auto-delete";Values="no"} | Where-Object ResourceType -eq "instance" | ForEach-Object {New-EC2Tag -ResourceId $_.ResourceId -Tag @{Key="ThisInstance";Value=$_.ResourceId}}
```
**例 5: この例では、すべてのインスタンスリソースのタグと「Name」キーを取得し、テーブル形式で表示します。**
```
Get-EC2Tag -Filter @{Name="resource-type";Values="instance"},@{Name="key";Values="Name"} | Select-Object ResourceId, @{Name="Name-Tag";Expression={$PSItem.Value}} | Format-Table -AutoSize
```
**出力:**
```
ResourceId Name-Tag
---------- --------
i-012e3cb4df567e1aa jump1
i-01c23a45d6fc7a89f repro-3
```
**例 6: この例では、実際に EC2 タグを取得することなく、DryRun パラメータを使用して EC2 タグ取得のアクセス許可を検証します。注: 成功すると例外がスローされますが、これは正常な動作です。**
```
Get-EC2Tag -DryRun $true
```
**出力:**
```
Get-EC2Tag: Request would have succeeded, but DryRun flag is set.
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-EC2Volume`
次のコード例は、`Get-EC2Volume` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した EBS ボリュームを記述します。**
```
Get-EC2Volume -VolumeId vol-12345678
```
**出力:**
```
Attachments : {}
AvailabilityZone : us-west-2c
CreateTime : 7/17/2015 4:35:19 PM
Encrypted : False
Iops : 90
KmsKeyId :
Size : 30
SnapshotId : snap-12345678
State : in-use
Tags : {}
VolumeId : vol-12345678
VolumeType : standard
```
**例 2: この例では、ステータスが「使用可能」の EBS ボリュームを記述します。**
```
Get-EC2Volume -Filter @{ Name="status"; Values="available" }
```
**出力:**
```
Attachments : {}
AvailabilityZone : us-west-2c
CreateTime : 12/21/2015 2:31:29 PM
Encrypted : False
Iops : 60
KmsKeyId :
Size : 20
SnapshotId : snap-12345678
State : available
Tags : {}
VolumeId : vol-12345678
VolumeType : gp2
...
```
**例 3: この例では、すべての EBS ボリュームを記述します。**
```
Get-EC2Volume
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeVolumes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2VolumeAttribute`
次のコード例は、`Get-EC2VolumeAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたボリュームの指定された属性を記述します。**
```
Get-EC2VolumeAttribute -VolumeId vol-12345678 -Attribute AutoEnableIO
```
**出力:**
```
AutoEnableIO ProductCodes VolumeId
------------ ------------ --------
False {} vol-12345678
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeVolumeAttribute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2VolumeStatus`
次のコード例は、`Get-EC2VolumeStatus` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたボリュームのステータスを記述します。**
```
Get-EC2VolumeStatus -VolumeId vol-12345678
```
**出力:**
```
Actions : {}
AvailabilityZone : us-west-2a
Events : {}
VolumeId : vol-12345678
VolumeStatus : Amazon.EC2.Model.VolumeStatusInfo
```
```
(Get-EC2VolumeStatus -VolumeId vol-12345678).VolumeStatus
```
**出力:**
```
Details Status
------- ------
{io-enabled, io-performance} ok
```
```
(Get-EC2VolumeStatus -VolumeId vol-12345678).VolumeStatus.Details
```
**出力:**
```
Name Status
---- ------
io-enabled passed
io-performance not-applicable
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeVolumeStatus](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2Vpc`
次のコード例は、`Get-EC2Vpc` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した VPC を記述します。**
```
Get-EC2Vpc -VpcId vpc-12345678
```
**出力:**
```
CidrBlock : 10.0.0.0/16
DhcpOptionsId : dopt-1a2b3c4d
InstanceTenancy : default
IsDefault : False
State : available
Tags : {Name}
VpcId : vpc-12345678
```
**例 2: この例では、デフォルトの VPC を記述します (リージョンごとに 1 つだけ指定できます)。アカウントがこのリージョンで EC2-Classic をサポートしている場合、デフォルトの VPC はありません。**
```
Get-EC2Vpc -Filter @{Name="isDefault"; Values="true"}
```
**出力:**
```
CidrBlock : 172.31.0.0/16
DhcpOptionsId : dopt-12345678
InstanceTenancy : default
IsDefault : True
State : available
Tags : {}
VpcId : vpc-45678901
```
**例 3: この例では、指定されたフィルターに一致する VPC を記述します (つまり、値 「10.0.0.0/16」に一致する CIDR を持ち、状態が「available」である VPC)。**
```
Get-EC2Vpc -Filter @{Name="cidr"; Values="10.0.0.0/16"},@{Name="state";Values="available"}
```
**例 4: この例では、すべての VPC を記述します。**
```
Get-EC2Vpc
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeVpcs](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2VpcAttribute`
次のコード例は、`Get-EC2VpcAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、「enableDnsSupport」属性を記述します。**
```
Get-EC2VpcAttribute -VpcId vpc-12345678 -Attribute enableDnsSupport
```
**出力:**
```
EnableDnsSupport
----------------
True
```
**例 2: この例では、「enableDnsHostnames」属性を記述します。**
```
Get-EC2VpcAttribute -VpcId vpc-12345678 -Attribute enableDnsHostnames
```
**出力:**
```
EnableDnsHostnames
------------------
True
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeVpcAttribute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2VpcClassicLink`
次のコード例は、`Get-EC2VpcClassicLink` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 上記の例では、リージョンの ClassicLinkEnabled 状態を持つすべての VPC を返します。**
```
Get-EC2VpcClassicLink -Region eu-west-1
```
**出力:**
```
ClassicLinkEnabled Tags VpcId
------------------ ---- -----
False {Name} vpc-0fc1ff23f45b678eb
False {} vpc-01e23c4a5d6db78e9
False {Name} vpc-0123456b078b9d01f
False {} vpc-12cf3b4f
False {Name} vpc-0b12d3456a7e8901d
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeVpcClassicLink](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2VpcClassicLinkDnsSupport`
次のコード例は、`Get-EC2VpcClassicLinkDnsSupport` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、リージョン eu-west-1 の VPC の ClassicLink DNS サポートステータスを記述します。**
```
Get-EC2VpcClassicLinkDnsSupport -VpcId vpc-0b12d3456a7e8910d -Region eu-west-1
```
**出力:**
```
ClassicLinkDnsSupported VpcId
----------------------- -----
False vpc-0b12d3456a7e8910d
False vpc-12cf3b4f
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeVpcClassicLinkDnsSupport](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2VpcEndpoint`
次のコード例は、`Get-EC2VpcEndpoint` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、リージョン eu-west-1 の 1 つ以上の VPC エンドポイントについて記述します。次に、出力を次のコマンドにパイプします。このコマンドは VpcEndpointId プロパティを選択し、配列 VPC ID を文字列配列として返します。**
```
Get-EC2VpcEndpoint -Region eu-west-1 | Select-Object -ExpandProperty VpcEndpointId
```
**出力:**
```
vpce-01a2ab3f4f5cc6f7d
vpce-01d2b345a6787890b
vpce-0012e34d567890e12
vpce-0c123db4567890123
```
**例 2: この例では、リージョン eu-west-1 のすべての vpc エンドポイントを記述し、VpcEndpointId、VpcId、ServiceName、および PrivateDnsEnabled プロパティを選択して表形式で表示します。**
```
Get-EC2VpcEndpoint -Region eu-west-1 | Select-Object VpcEndpointId, VpcId, ServiceName, PrivateDnsEnabled | Format-Table -AutoSize
```
**出力:**
```
VpcEndpointId VpcId ServiceName PrivateDnsEnabled
------------- ----- ----------- -----------------
vpce-02a2ab2f2f2cc2f2d vpc-0fc6ff46f65b039eb com.amazonaws.eu-west-1.ssm True
vpce-01d1b111a1114561b vpc-0fc6ff46f65b039eb com.amazonaws.eu-west-1.ec2 True
vpce-0011e23d45167e838 vpc-0fc6ff46f65b039eb com.amazonaws.eu-west-1.ec2messages True
vpce-0c123db4567890123 vpc-0fc6ff46f65b039eb com.amazonaws.eu-west-1.ssmmessages True
```
**例 3: この例では、VPC エンドポイント vpce-01a2ab3f4f5cc6f7d のポリシードキュメントを JSON ファイルにエクスポートします。**
```
Get-EC2VpcEndpoint -Region eu-west-1 -VpcEndpointId vpce-01a2ab3f4f5cc6f7d | Select-Object -expand PolicyDocument | Out-File vpce_policyDocument.json
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeVpcEndpoints](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2VpcEndpointService`
次のコード例は、`Get-EC2VpcEndpointService` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたフィルター (この場合は com.amazonaws.eu-west-1.ecs) を持つ EC2 VPC エンドポイントサービスについて記述します。さらに、ServiceDetails プロパティも展開され、詳細が表示されます。**
```
Get-EC2VpcEndpointService -Region eu-west-1 -MaxResult 5 -Filter @{Name="service-name";Values="com.amazonaws.eu-west-1.ecs"} | Select-Object -ExpandProperty ServiceDetails
```
**出力:**
```
AcceptanceRequired : False
AvailabilityZones : {eu-west-1a, eu-west-1b, eu-west-1c}
BaseEndpointDnsNames : {ecs.eu-west-1.vpce.amazonaws.com}
Owner : amazon
PrivateDnsName : ecs.eu-west-1.amazonaws.com
ServiceName : com.amazonaws.eu-west-1.ecs
ServiceType : {Amazon.EC2.Model.ServiceTypeDetail}
VpcEndpointPolicySupported : False
```
**例 2: この例では、すべての EC2 VPC エンドポイントサービスを取得し、「ssm」に一致する ServiceNames を返します。**
```
Get-EC2VpcEndpointService -Region eu-west-1 | Select-Object -ExpandProperty Servicenames | Where-Object { -match "ssm"}
```
**出力:**
```
com.amazonaws.eu-west-1.ssm
com.amazonaws.eu-west-1.ssmmessages
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeVpcEndpointServices](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2VpnConnection`
次のコード例は、`Get-EC2VpnConnection` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された VPN 接続を記述します。**
```
Get-EC2VpnConnection -VpnConnectionId vpn-12345678
```
**出力:**
```
CustomerGatewayConfiguration : [XML document]
CustomerGatewayId : cgw-1a2b3c4d
Options : Amazon.EC2.Model.VpnConnectionOptions
Routes : {Amazon.EC2.Model.VpnStaticRoute}
State : available
Tags : {}
Type : ipsec.1
VgwTelemetry : {Amazon.EC2.Model.VgwTelemetry, Amazon.EC2.Model.VgwTelemetry}
VpnConnectionId : vpn-12345678
VpnGatewayId : vgw-1a2b3c4d
```
**例 2: この例では、保留中または使用可能な状態の VPN 接続を記述します。**
```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = @( "pending", "available" )
Get-EC2VpnConnection -Filter $filter
```
**例 3: この例では、すべての VPN 接続を記述します。**
```
Get-EC2VpnConnection
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeVpnConnections](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EC2VpnGateway`
次のコード例は、`Get-EC2VpnGateway` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された仮想プライベートゲートウェイを記述します。**
```
Get-EC2VpnGateway -VpnGatewayId vgw-1a2b3c4d
```
**出力:**
```
AvailabilityZone :
State : available
Tags : {}
Type : ipsec.1
VpcAttachments : {vpc-12345678}
VpnGatewayId : vgw-1a2b3c4d
```
**例 2: この例では、保留中または使用可能な状態の仮想プライベートゲートウェイを記述します。**
```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "state"
$filter.Values = @( "pending", "available" )
Get-EC2VpnGateway -Filter $filter
```
**例 3: この例では、仮想プライベートゲートウェイを記述します。**
```
Get-EC2VpnGateway
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeVpnGateways](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Grant-EC2SecurityGroupEgress`
次のコード例は、`Grant-EC2SecurityGroupEgress` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、EC2-VPC の指定されたセキュリティグループの退出ルールを定義します。このルールは、TCP ポート 80 で、指定された IP アドレス範囲へのアクセスを許可します。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
$ip = @{ IpProtocol="tcp"; FromPort="80"; ToPort="80"; IpRanges="203.0.113.0/24" }
Grant-EC2SecurityGroupEgress -GroupId sg-12345678 -IpPermission $ip
```
**例 2: PowerShell バージョン 2 では、New-Object を使用して IpPermission オブジェクトを作成する必要があります。**
```
$ip = New-Object Amazon.EC2.Model.IpPermission
$ip.IpProtocol = "tcp"
$ip.FromPort = 80
$ip.ToPort = 80
$ip.IpRanges.Add("203.0.113.0/24")
Grant-EC2SecurityGroupEgress -GroupId sg-12345678 -IpPermission $ip
```
**例 3: この例では、TCP ポート 80 で指定されたソースセキュリティグループへのアクセスを許可します。**
```
$ug = New-Object Amazon.EC2.Model.UserIdGroupPair
$ug.GroupId = "sg-1a2b3c4d"
$ug.UserId = "123456789012"
Grant-EC2SecurityGroupEgress -GroupId sg-12345678 -IpPermission @( @{ IpProtocol="tcp"; FromPort="80"; ToPort="80"; UserIdGroupPairs=$ug } )
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AuthorizeSecurityGroupEgress](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Grant-EC2SecurityGroupIngress`
次のコード例は、`Grant-EC2SecurityGroupIngress` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、EC2-VPC のセキュリティグループの進入ルールを定義します。これらのルールは、SSH (ポート 22) と RDC (ポート 3389) の特定の IP アドレスへのアクセスを許可します。セキュリティグループの名前ではなく、セキュリティグループの ID を使用して、EC2-VPC のセキュリティグループを識別する必要があります。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
$ip1 = @{ IpProtocol="tcp"; FromPort="22"; ToPort="22"; IpRanges="203.0.113.25/32" }
$ip2 = @{ IpProtocol="tcp"; FromPort="3389"; ToPort="3389"; IpRanges="203.0.113.25/32" }
Grant-EC2SecurityGroupIngress -GroupId sg-12345678 -IpPermission @( $ip1, $ip2 )
```
**例 2: PowerShell バージョン 2 では、New-Object を使用して IpPermission オブジェクトを作成する必要があります。**
```
$ip1 = New-Object Amazon.EC2.Model.IpPermission
$ip1.IpProtocol = "tcp"
$ip1.FromPort = 22
$ip1.ToPort = 22
$ip1.IpRanges.Add("203.0.113.25/32")
$ip2 = new-object Amazon.EC2.Model.IpPermission
$ip2.IpProtocol = "tcp"
$ip2.FromPort = 3389
$ip2.ToPort = 3389
$ip2.IpRanges.Add("203.0.113.25/32")
Grant-EC2SecurityGroupIngress -GroupId sg-12345678 -IpPermission @( $ip1, $ip2 )
```
**例 3: この例では、EC2-Classic のセキュリティグループの進入ルールを定義します。これらのルールは、SSH (ポート 22) と RDC (ポート 3389) の特定の IP アドレスへのアクセスを許可します。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
$ip1 = @{ IpProtocol="tcp"; FromPort="22"; ToPort="22"; IpRanges="203.0.113.25/32" }
$ip2 = @{ IpProtocol="tcp"; FromPort="3389"; ToPort="3389"; IpRanges="203.0.113.25/32" }
Grant-EC2SecurityGroupIngress -GroupName "my-security-group" -IpPermission @( $ip1, $ip2 )
```
**例 4: PowerShell バージョン 2 では、New-Object を使用して IpPermission オブジェクトを作成する必要があります。**
```
$ip1 = New-Object Amazon.EC2.Model.IpPermission
$ip1.IpProtocol = "tcp"
$ip1.FromPort = 22
$ip1.ToPort = 22
$ip1.IpRanges.Add("203.0.113.25/32")
$ip2 = new-object Amazon.EC2.Model.IpPermission
$ip2.IpProtocol = "tcp"
$ip2.FromPort = 3389
$ip2.ToPort = 3389
$ip2.IpRanges.Add("203.0.113.25/32")
Grant-EC2SecurityGroupIngress -GroupName "my-security-group" -IpPermission @( $ip1, $ip2 )
```
**例 5: この例では、指定されたソースセキュリティグループ (sg-1a2b3c4d) から指定されたセキュリティグループ (sg-12345678) への TCP ポート 8081 のアクセスを許可します。**
```
$ug = New-Object Amazon.EC2.Model.UserIdGroupPair
$ug.GroupId = "sg-1a2b3c4d"
$ug.UserId = "123456789012"
Grant-EC2SecurityGroupIngress -GroupId sg-12345678 -IpPermission @( @{ IpProtocol="tcp"; FromPort="8081"; ToPort="8081"; UserIdGroupPairs=$ug } )
```
**例 6: この例では、セキュリティグループ sg-1234abcd の進入ルールに、TCP ポート 22 トラフィック用の CIDR 5.5.5.5/32 を説明付きで追加します。**
```
$IpRange = New-Object -TypeName Amazon.EC2.Model.IpRange
$IpRange.CidrIp = "5.5.5.5/32"
$IpRange.Description = "SSH from Office"
$IpPermission = New-Object Amazon.EC2.Model.IpPermission
$IpPermission.IpProtocol = "tcp"
$IpPermission.ToPort = 22
$IpPermission.FromPort = 22
$IpPermission.Ipv4Ranges = $IpRange
Grant-EC2SecurityGroupIngress -GroupId sg-1234abcd -IpPermission $IpPermission
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AuthorizeSecurityGroupIngress](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Import-EC2Image`
次のコード例は、`Import-EC2Image` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、べき等性トークンを使用して、指定された Amazon S3 バケットから Amazon EC2 にシングルディスク仮想マシンイメージをインポートします。この例では、「VM Import Prequisites」トピックで説明されているように、デフォルトの名前が「vmimport」の VM Import サービスロールが存在し、指定されたバケットへの Amazon EC2 アクセスを許可するポリシーが付与されている必要があります。カスタムロールを使用するには、`-RoleName` パラメータを使用してロール名を指定します。**
```
$container = New-Object Amazon.EC2.Model.ImageDiskContainer
$container.Format="VMDK"
$container.UserBucket = New-Object Amazon.EC2.Model.UserBucket
$container.UserBucket.S3Bucket = "amzn-s3-demo-bucket"
$container.UserBucket.S3Key = "Win_2008_Server_Standard_SP2_64-bit-disk1.vmdk"
$parms = @{
"ClientToken"="idempotencyToken"
"Description"="Windows 2008 Standard Image Import"
"Platform"="Windows"
"LicenseType"="AWS"
}
Import-EC2Image -DiskContainer $container @parms
```
**出力:**
```
Architecture :
Description : Windows 2008 Standard Image
Hypervisor :
ImageId :
ImportTaskId : import-ami-abcdefgh
LicenseType : AWS
Platform : Windows
Progress : 2
SnapshotDetails : {}
Status : active
StatusMessage : pending
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ImportImage](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Import-EC2KeyPair`
次のコード例は、`Import-EC2KeyPair` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、パブリックキーを EC2 にインポートします。最初の行は、パブリックキーファイル (\$1.pub) の内容を変数 `$publickey` に保存します。次に、パブリックキーファイルの UTF8 形式を Base64 でエンコードされた文字列に変換し、変換された文字列を変数 `$pkbase64` に保存します。最後の行では、変換されたパブリックキーが EC2 にインポートされます。コマンドレットは、キーフィンガープリントと名前を結果として返します。**
```
$publickey=[Io.File]::ReadAllText("C:\Users\TestUser\.ssh\id_rsa.pub")
$pkbase64 = [System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes($publickey))
Import-EC2KeyPair -KeyName Example-user-key -PublicKey $pkbase64
```
**出力:**
```
KeyFingerprint KeyName
-------------- -------
do:d0:15:8f:79:97:12:be:00:fd:df:31:z3:b1:42:z1 Example-user-key
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ImportKeyPair](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Import-EC2Snapshot`
次のコード例は、`Import-EC2Snapshot` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、「VMDK」形式の VM ディスクイメージを Amazon EBS スナップショットにインポートします。この例では、http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/VMImportPrerequisites.html の `VM Import Prequisites` トピックで説明されているように、デフォルトの名前が「vmimport」の VM Import サービスロールと、指定されたバケットへの Amazon EC2 アクセスを許可するポリシーが必要です。カスタムロールを使用するには、`-RoleName` パラメータを使用してロール名を指定します。**
```
$parms = @{
"ClientToken"="idempotencyToken"
"Description"="Disk Image Import"
"DiskContainer_Description" = "Data disk"
"DiskContainer_Format" = "VMDK"
"DiskContainer_S3Bucket" = "amzn-s3-demo-bucket"
"DiskContainer_S3Key" = "datadiskimage.vmdk"
}
Import-EC2Snapshot @parms
```
**出力:**
```
Description ImportTaskId SnapshotTaskDetail
----------------- -------------------- ------------------
Disk Image Import import-snap-abcdefgh Amazon.EC2.Model.SnapshotTaskDetail
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の[ImportSnapshot](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Move-EC2AddressToVpc`
次のコード例は、`Move-EC2AddressToVpc` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、パブリック IP アドレスが 12.345.67.89 の EC2 インスタンスを、米国東部 (バージニア北部) リージョンの EC2-VPC プラットフォームに移動します。**
```
Move-EC2AddressToVpc -PublicIp 12.345.67.89 -Region us-east-1
```
**例 2: この例では、Get-EC2Instance コマンドの結果を Move-EC2AddressToVpc コマンドレットにパイプします。Get-EC2Instance コマンドは、インスタンス ID で指定されたインスタンスを取得し、インスタンスのパブリック IP アドレスプロパティを返します。**
```
(Get-EC2Instance -Instance i-12345678).Instances.PublicIpAddress | Move-EC2AddressToVpc
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[MoveAddressToVpc](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2Address`
次のコード例は、`New-EC2Address` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、VPC 内のインスタンスで使用する Elastic IP アドレスを割り当てます。**
```
New-EC2Address -Domain Vpc
```
**出力:**
```
AllocationId Domain PublicIp
------------ ------ --------
eipalloc-12345678 vpc 198.51.100.2
```
**例 2: この例では、EC2-Classic のインスタンスで使用する Elastic IP アドレスを割り当てます。**
```
New-EC2Address
```
**出力:**
```
AllocationId Domain PublicIp
------------ ------ --------
standard 203.0.113.17
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AllocateAddress](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2CustomerGateway`
次のコード例は、`New-EC2CustomerGateway` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたカスタマーゲートウェイを作成します。**
```
New-EC2CustomerGateway -Type ipsec.1 -PublicIp 203.0.113.12 -BgpAsn 65534
```
**出力:**
```
BgpAsn : 65534
CustomerGatewayId : cgw-1a2b3c4d
IpAddress : 203.0.113.12
State : available
Tags : {}
Type : ipsec.1
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateCustomerGateway](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2DhcpOption`
次のコード例は、`New-EC2DhcpOption` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された DHCP オプションのセットを作成します。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
$options = @( @{Key="domain-name";Values=@("abc.local")}, @{Key="domain-name-servers";Values=@("10.0.0.101","10.0.0.102")})
New-EC2DhcpOption -DhcpConfiguration $options
```
**出力:**
```
DhcpConfigurations DhcpOptionsId Tags
------------------ ------------- ----
{domain-name, domain-name-servers} dopt-1a2b3c4d {}
```
**例 2: PowerShell バージョン 2 では、New-Object を使用して各 DHCP オプションを作成する必要があります。**
```
$option1 = New-Object Amazon.EC2.Model.DhcpConfiguration
$option1.Key = "domain-name"
$option1.Values = "abc.local"
$option2 = New-Object Amazon.EC2.Model.DhcpConfiguration
$option2.Key = "domain-name-servers"
$option2.Values = @("10.0.0.101","10.0.0.102")
New-EC2DhcpOption -DhcpConfiguration @($option1, $option2)
```
**出力:**
```
DhcpConfigurations DhcpOptionsId Tags
------------------ ------------- ----
{domain-name, domain-name-servers} dopt-2a3b4c5d {}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateDhcpOptions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2FlowLog`
次のコード例は、`New-EC2FlowLog` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、「Admin」ロールの権限を使用して、サブネット subnet-1d234567 に対する EC2 フローログを、すべての「REJECT」トラフィックを対象に、「subnet1-log」という名前の cloud-watch-log に作成します。**
```
New-EC2FlowLog -ResourceId "subnet-1d234567" -LogDestinationType cloud-watch-logs -LogGroupName subnet1-log -TrafficType "REJECT" -ResourceType Subnet -DeliverLogsPermissionArn "arn:aws:iam::98765432109:role/Admin"
```
**出力:**
```
ClientToken FlowLogIds Unsuccessful
----------- ---------- ------------
m1VN2cxP3iB4qo//VUKl5EU6cF7gQLOxcqNefvjeTGw= {fl-012fc34eed5678c9d} {}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateFlowLogs](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2Host`
次のコード例は、`New-EC2Host` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたインスタンスタイプとアベイラビリティーゾーンのアカウントに専有ホストを割り当てます。**
```
New-EC2Host -AutoPlacement on -AvailabilityZone eu-west-1b -InstanceType m4.xlarge -Quantity 1
```
**出力:**
```
h-01e23f4cd567890f3
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AllocateHosts](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2HostReservation`
次のコード例は、`New-EC2HostReservation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、専有ホスト h-01e23f4cd567890f1 の構成と一致する設定で、hro-0c1f23456789d0ab の予約サービスを購入します。**
```
New-EC2HostReservation -OfferingId hro-0c1f23456789d0ab HostIdSet h-01e23f4cd567890f1
```
**出力:**
```
ClientToken :
CurrencyCode :
Purchase : {hr-0123f4b5d67bedc89}
TotalHourlyPrice : 1.307
TotalUpfrontPrice : 0.000
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[PurchaseHostReservation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2Image`
次のコード例は、`New-EC2Image` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたインスタンスから、指定された名前と説明を持つ AMI を作成します。Amazon EC2 は、イメージを作成する前にインスタンスのクリーンシャットダウンを試み、完了時にインスタンスを再起動します。**
```
New-EC2Image -InstanceId i-12345678 -Name "my-web-server" -Description "My web server AMI"
```
**例 2: この例では、指定されたインスタンスから、指定された名前と説明を持つ AMI を作成します。Amazon EC2 は、インスタンスのシャットダウンと再起動をせずにイメージを作成するため、作成されたイメージのファイルシステムの整合性は保証されません。**
```
New-EC2Image -InstanceId i-12345678 -Name "my-web-server" -Description "My web server AMI" -NoReboot $true
```
**例 3: この例では、3 つのボリュームを持つ AMI を作成します。最初のボリュームは Amazon EBS スナップショットに基づいています。2 番目のボリュームは空の 100 GiB Amazon EBS ボリュームです。3 番目のボリュームはインスタンスストアボリュームです。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
$ebsBlock1 = @{SnapshotId="snap-1a2b3c4d"}
$ebsBlock2 = @{VolumeSize=100}
New-EC2Image -InstanceId i-12345678 -Name "my-web-server" -Description "My web server AMI" -BlockDeviceMapping @( @{DeviceName="/dev/sdf";Ebs=$ebsBlock1}, @{DeviceName="/dev/sdg";Ebs=$ebsBlock2}, @{DeviceName="/dev/sdc";VirtualName="ephemeral0"})
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateImage](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2Instance`
次のコード例は、`New-EC2Instance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、EC2-Classic またはデフォルトの VPC で指定された AMI の単一のインスタンスを起動します。**
```
New-EC2Instance -ImageId ami-12345678 -MinCount 1 -MaxCount 1 -InstanceType m3.medium -KeyName my-key-pair -SecurityGroup my-security-group
```
**例 2: この例では、VPC で指定された AMI の単一のインスタンスを起動します。**
```
New-EC2Instance -ImageId ami-12345678 -MinCount 1 -MaxCount 1 -SubnetId subnet-12345678 -InstanceType t2.micro -KeyName my-key-pair -SecurityGroupId sg-12345678
```
**例 3: EBS ボリュームまたはインスタンスストアボリュームを追加するには、ブロックデバイスマッピングを定義してコマンドに追加します。この例では、インスタンスストアボリュームとして追加します。**
```
$bdm = New-Object Amazon.EC2.Model.BlockDeviceMapping
$bdm.VirtualName = "ephemeral0"
$bdm.DeviceName = "/dev/sdf"
New-EC2Instance -ImageId ami-12345678 -BlockDeviceMapping $bdm ...
```
**例 4: 現在の Windows AMI のいずれかを指定するには、Get-SSMLatestEC2Image を使用して AMI ID を取得します。この例では、Windows Server 2016 の現在のベース AMI からインスタンスを起動します。**
```
$ami = (Get-SSMLatestEC2Image -Path 'ami-windows-latest' -ImageName 'WINDOWS*2016*English*Core*BASE').Value
New-EC2Instance -ImageId $ami ...
```
**例 5: 指定された専有ホスト環境でインスタンスを起動します。**
```
New-EC2Instance -ImageId ami-1a2b3c4d -InstanceType m4.large -KeyName my-key-pair -SecurityGroupId sg-1a2b3c4d -AvailabilityZone us-west-1a -Tenancy host -HostID h-1a2b3c4d5e6f1a2b3
```
**例 6: このリクエストは 2 つのインスタンスを起動し、ウェブサーバーのキーと本番稼働用の値を持つタグをインスタンスに適用します。リクエストは、作成されたボリューム (この場合は各インスタンスのルートボリューム) に、コストセンターのキーと cc123 の値を持つタグも適用します。**
```
$tag1 = @{ Key="webserver"; Value="production" }
$tag2 = @{ Key="cost-center"; Value="cc123" }
$tagspec1 = new-object Amazon.EC2.Model.TagSpecification
$tagspec1.ResourceType = "instance"
$tagspec1.Tags.Add($tag1)
$tagspec2 = new-object Amazon.EC2.Model.TagSpecification
$tagspec2.ResourceType = "volume"
$tagspec2.Tags.Add($tag2)
New-EC2Instance -ImageId "ami-1a2b3c4d" -KeyName "my-key-pair" -MaxCount 2 -InstanceType "t2.large" -SubnetId "subnet-1a2b3c4d" -TagSpecification $tagspec1,$tagspec2
```
**例 7: この例では、インスタンスを実際に作成せずに DryRun パラメータを使用して EC2 インスタンスを起動するためのアクセス許可を検証します。注: 成功すると例外がスローされますが、これは正常な動作です。**
```
New-EC2Instance -ImageId 'ami-12345678' -InstanceType 't2.micro' -KeyName 'my-key-pair' -Region 'us-west-2' -DryRun $true
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RunInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2InstanceExportTask`
次のコード例は、`New-EC2InstanceExportTask` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、停止したインスタンス `i-0800b00a00EXAMPLE` を仮想ハードディスク (VHD)として S3 バケット `testbucket-export-instances-2019` にエクスポートします。ターゲット環境は で`Microsoft`、インスタンスが `us-east-1` リージョンにあり、ユーザーのデフォルト AWS リージョンが us-east-1 ではないため、リージョンパラメータが追加されます。エクスポートタスクのステータスを取得するには、このコマンドの結果から `ExportTaskId` 値をコピーし、`Get-EC2ExportTask -ExportTaskId export_task_ID_from_results.` を実行します。**
```
New-EC2InstanceExportTask -InstanceId i-0800b00a00EXAMPLE -ExportToS3Task_DiskImageFormat VHD -ExportToS3Task_S3Bucket "amzn-s3-demo-bucket" -TargetEnvironment Microsoft -Region us-east-1
```
**出力:**
```
Description :
ExportTaskId : export-i-077c73108aEXAMPLE
ExportToS3Task : Amazon.EC2.Model.ExportToS3Task
InstanceExportDetails : Amazon.EC2.Model.InstanceExportDetails
State : active
StatusMessage :
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateInstanceExportTask](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2InternetGateway`
次のコード例は、`New-EC2InternetGateway` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インターネットゲートウェイを作成します。**
```
New-EC2InternetGateway
```
**出力:**
```
Attachments InternetGatewayId Tags
----------- ----------------- ----
{} igw-1a2b3c4d {}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateInternetGateway](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2KeyPair`
次のコード例は、`New-EC2KeyPair` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、キーペアを作成し、指定した名前のファイルに PEM エンコードされた RSA プライベートキーをキャプチャします。PowerShell を使用している場合は、有効なキーを生成するためにエンコーディングを ascii に設定する必要があります。詳細については、「 コマンドラインインターフェイスユーザーガイド」のAmazon EC2 AWS キーペアの作成、表示、削除 (https://docs.aws.amazon.com/cli/latest/userguide/cli-services-ec2-keypairs.html)」を参照してください。**
```
(New-EC2KeyPair -KeyName "my-key-pair").KeyMaterial | Out-File -Encoding ascii -FilePath C:\path\my-key-pair.pem
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateKeyPair](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2NetworkAcl`
次のコード例は、`New-EC2NetworkAcl` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した VPC に対してネットワーク ACL を作成します。**
```
New-EC2NetworkAcl -VpcId vpc-12345678
```
**出力:**
```
Associations : {}
Entries : {Amazon.EC2.Model.NetworkAclEntry, Amazon.EC2.Model.NetworkAclEntry}
IsDefault : False
NetworkAclId : acl-12345678
Tags : {}
VpcId : vpc-12345678
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateNetworkAcl](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2NetworkAclEntry`
次のコード例は、`New-EC2NetworkAclEntry` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したネットワーク ACL のエントリを作成します。このルールは、UDP ポート 53 (DNS) 上の任意の場所 (0.0.0.0/0) から任意の関連付けられたサブネットへの受信トラフィックを許可します。**
```
New-EC2NetworkAclEntry -NetworkAclId acl-12345678 -Egress $false -RuleNumber 100 -Protocol 17 -PortRange_From 53 -PortRange_To 53 -CidrBlock 0.0.0.0/0 -RuleAction allow
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateNetworkAclEntry](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2NetworkInterface`
次のコード例は、`New-EC2NetworkInterface` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたネットワークインターフェイスを作成します。**
```
New-EC2NetworkInterface -SubnetId subnet-1a2b3c4d -Description "my network interface" -Group sg-12345678 -PrivateIpAddress 10.0.0.17
```
**出力:**
```
Association :
Attachment :
AvailabilityZone : us-west-2c
Description : my network interface
Groups : {my-security-group}
MacAddress : 0a:72:bc:1a:cd:7f
NetworkInterfaceId : eni-12345678
OwnerId : 123456789012
PrivateDnsName : ip-10-0-0-17.us-west-2.compute.internal
PrivateIpAddress : 10.0.0.17
PrivateIpAddresses : {}
RequesterId :
RequesterManaged : False
SourceDestCheck : True
Status : pending
SubnetId : subnet-1a2b3c4d
TagSet : {}
VpcId : vpc-12345678
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateNetworkInterface](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2PlacementGroup`
次のコード例は、`New-EC2PlacementGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された名前のプレイスメントグループを作成します。**
```
New-EC2PlacementGroup -GroupName my-placement-group -Strategy cluster
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreatePlacementGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2Route`
次のコード例は、`New-EC2Route` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したルートテーブルに対してルートを作成します。ルートはすべてのトラフィックと一致し、これを指定されたインターネットゲートウェイに送信します。**
```
New-EC2Route -RouteTableId rtb-1a2b3c4d -DestinationCidrBlock 0.0.0.0/0 -GatewayId igw-1a2b3c4d
```
**出力:**
```
True
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateRoute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2RouteTable`
次のコード例は、`New-EC2RouteTable` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された VPC に対してルートテーブルを作成します。**
```
New-EC2RouteTable -VpcId vpc-12345678
```
**出力:**
```
Associations : {}
PropagatingVgws : {}
Routes : {}
RouteTableId : rtb-1a2b3c4d
Tags : {}
VpcId : vpc-12345678
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateRouteTable](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2ScheduledInstance`
次のコード例は、`New-EC2ScheduledInstance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定のスケジュールされたインスタンスを起動します。**
```
New-EC2ScheduledInstance -ScheduledInstanceId sci-1234-1234-1234-1234-123456789012 -InstanceCount 1 `
-IamInstanceProfile_Name my-iam-role `
-LaunchSpecification_ImageId ami-12345678 `
-LaunchSpecification_InstanceType c4.large `
-LaunchSpecification_SubnetId subnet-12345678`
-LaunchSpecification_SecurityGroupId sg-12345678
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RunScheduledInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2ScheduledInstancePurchase`
次のコード例は、`New-EC2ScheduledInstancePurchase` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、スケジュールされたインスタンスを購入します。**
```
$request = New-Object Amazon.EC2.Model.PurchaseRequest
$request.InstanceCount = 1
$request.PurchaseToken = "eyJ2IjoiMSIsInMiOjEsImMiOi..."
New-EC2ScheduledInstancePurchase -PurchaseRequest $request
```
**出力:**
```
AvailabilityZone : us-west-2b
CreateDate : 1/25/2016 1:43:38 PM
HourlyPrice : 0.095
InstanceCount : 1
InstanceType : c4.large
NetworkPlatform : EC2-VPC
NextSlotStartTime : 1/31/2016 1:00:00 AM
Platform : Linux/UNIX
PreviousSlotEndTime :
Recurrence : Amazon.EC2.Model.ScheduledInstanceRecurrence
ScheduledInstanceId : sci-1234-1234-1234-1234-123456789012
SlotDurationInHours : 32
TermEndDate : 1/31/2017 1:00:00 AM
TermStartDate : 1/31/2016 1:00:00 AM
TotalScheduledInstanceHours : 1696
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[PurchaseScheduledInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2SecurityGroup`
次のコード例は、`New-EC2SecurityGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された VPC 用にセキュリティグループを作成します。**
```
New-EC2SecurityGroup -GroupName my-security-group -Description "my security group" -VpcId vpc-12345678
```
**出力:**
```
sg-12345678
```
**例 2: この例では、EC2-Classic のセキュリティグループを作成します。**
```
New-EC2SecurityGroup -GroupName my-security-group -Description "my security group"
```
**出力:**
```
sg-45678901
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateSecurityGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2Snapshot`
次のコード例は、`New-EC2Snapshot` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたボリュームのスナップショットを作成します。**
```
New-EC2Snapshot -VolumeId vol-12345678 -Description "This is a test"
```
**出力:**
```
DataEncryptionKeyId :
Description : This is a test
Encrypted : False
KmsKeyId :
OwnerAlias :
OwnerId : 123456789012
Progress :
SnapshotId : snap-12345678
StartTime : 12/22/2015 1:28:42 AM
State : pending
StateMessage :
Tags : {}
VolumeId : vol-12345678
VolumeSize : 20
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateSnapshot](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2SpotDatafeedSubscription`
次のコード例は、`New-EC2SpotDatafeedSubscription` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、スポットインスタンスのデータフィードを作成します。**
```
New-EC2SpotDatafeedSubscription -Bucket amzn-s3-demo-bucket -Prefix spotdata
```
**出力:**
```
Bucket : amzn-s3-demo-bucket
Fault :
OwnerId : 123456789012
Prefix : spotdata
State : Active
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateSpotDatafeedSubscription](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2Subnet`
次のコード例は、`New-EC2Subnet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した CIDR でサブネットを作成します。**
```
New-EC2Subnet -VpcId vpc-12345678 -CidrBlock 10.0.0.0/24
```
**出力:**
```
AvailabilityZone : us-west-2c
AvailableIpAddressCount : 251
CidrBlock : 10.0.0.0/24
DefaultForAz : False
MapPublicIpOnLaunch : False
State : pending
SubnetId : subnet-1a2b3c4d
Tag : {}
VpcId : vpc-12345678
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateSubnet](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2Tag`
次のコード例は、`New-EC2Tag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したリソースに単一のタグを追加します。タグキーは「myTag」で、タグ値は「myTagValue」です。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
New-EC2Tag -Resource i-12345678 -Tag @{ Key="myTag"; Value="myTagValue" }
```
**例 2: この例では、指定されたリソースに指定されたタグを更新または追加します。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
New-EC2Tag -Resource i-12345678 -Tag @( @{ Key="myTag"; Value="newTagValue" }, @{ Key="test"; Value="anotherTagValue" } )
```
**例 3: PowerShell バージョン 2 では、New-Object を使用してタグパラメータのタグを作成する必要があります。**
```
$tag = New-Object Amazon.EC2.Model.Tag
$tag.Key = "myTag"
$tag.Value = "myTagValue"
New-EC2Tag -Resource i-12345678 -Tag $tag
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2Volume`
次のコード例は、`New-EC2Volume` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したボリュームを作成します。**
```
New-EC2Volume -Size 50 -AvailabilityZone us-west-2a -VolumeType gp2
```
**出力:**
```
Attachments : {}
AvailabilityZone : us-west-2a
CreateTime : 12/22/2015 1:42:07 AM
Encrypted : False
Iops : 150
KmsKeyId :
Size : 50
SnapshotId :
State : creating
Tags : {}
VolumeId : vol-12345678
VolumeType : gp2
```
**例 2: このリクエスト例では、ボリュームを作成し、キーがスタック、値が本番環境のタグを適用します。**
```
$tag = @{ Key="stack"; Value="production" }
$tagspec = new-object Amazon.EC2.Model.TagSpecification
$tagspec.ResourceType = "volume"
$tagspec.Tags.Add($tag)
New-EC2Volume -Size 80 -AvailabilityZone "us-west-2a" -TagSpecification $tagspec
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateVolume](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2Vpc`
次のコード例は、`New-EC2Vpc` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した CIDR で VPC を作成します。Amazon VPC では、VPC 用に、デフォルトの DHCP オプションセット、メインルートテーブル、デフォルトのネットワーク ACL も作成します。**
```
New-EC2VPC -CidrBlock 10.0.0.0/16
```
**出力:**
```
CidrBlock : 10.0.0.0/16
DhcpOptionsId : dopt-1a2b3c4d
InstanceTenancy : default
IsDefault : False
State : pending
Tags : {}
VpcId : vpc-12345678
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateVpc](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2VpcEndpoint`
次のコード例は、`New-EC2VpcEndpoint` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、VPC vpc-0fc1ff23f45b678eb でサービス com.amazonaws.eu-west-1.s3 の新しい VPC エンドポイントを作成します。**
```
New-EC2VpcEndpoint -ServiceName com.amazonaws.eu-west-1.s3 -VpcId vpc-0fc1ff23f45b678eb
```
**出力:**
```
ClientToken VpcEndpoint
----------- -----------
Amazon.EC2.Model.VpcEndpoint
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateVpcEndpoint](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2VpnConnection`
次のコード例は、`New-EC2VpnConnection` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した仮想プライベートゲートウェイと指定したカスタマーゲートウェイの間に VPN 接続を作成します。出力には、ネットワーク管理者が必要とする設定情報が XML 形式で含まれます。**
```
New-EC2VpnConnection -Type ipsec.1 -CustomerGatewayId cgw-1a2b3c4d -VpnGatewayId vgw-1a2b3c4d
```
**出力:**
```
CustomerGatewayConfiguration : [XML document]
CustomerGatewayId : cgw-1a2b3c4d
Options :
Routes : {}
State : pending
Tags : {}
Type :
VgwTelemetry : {}
VpnConnectionId : vpn-12345678
VpnGatewayId : vgw-1a2b3c4d
```
**例 2: この例では、VPN 接続を作成し、指定された名前のファイルに設定をキャプチャします。**
```
(New-EC2VpnConnection -CustomerGatewayId cgw-1a2b3c4d -VpnGatewayId vgw-1a2b3c4d).CustomerGatewayConfiguration | Out-File C:\path\vpn-configuration.xml
```
**例 3: この例では、指定された仮想プライベートゲートウェイと指定されたカスタマーゲートウェイの間に VPN 接続を作成します。**
```
New-EC2VpnConnection -Type ipsec.1 -CustomerGatewayId cgw-1a2b3c4d -VpnGatewayId vgw-1a2b3c4d -Options_StaticRoutesOnly $true
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateVpnConnection](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2VpnConnectionRoute`
次のコード例は、`New-EC2VpnConnectionRoute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された VPN 接続に対して指定された静的ルートを作成します。**
```
New-EC2VpnConnectionRoute -VpnConnectionId vpn-12345678 -DestinationCidrBlock 11.12.0.0/16
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateVpnConnectionRoute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EC2VpnGateway`
次のコード例は、`New-EC2VpnGateway` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された仮想プライベートゲートウェイを作成します。**
```
New-EC2VpnGateway -Type ipsec.1
```
**出力:**
```
AvailabilityZone :
State : available
Tags : {}
Type : ipsec.1
VpcAttachments : {}
VpnGatewayId : vgw-1a2b3c4d
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateVpnGateway](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Register-EC2Address`
次のコード例は、`Register-EC2Address` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された Elastic IP アドレスを VPC 内の指定されたインスタンスに関連付けます。**
```
C:\> Register-EC2Address -InstanceId i-12345678 -AllocationId eipalloc-12345678
```
**出力:**
```
eipassoc-12345678
```
**例 2: この例では、指定された Elastic IP アドレスを EC2-Classic の指定されたインスタンスに関連付けます。**
```
C:\> Register-EC2Address -InstanceId i-12345678 -PublicIp 203.0.113.17
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AssociateAddress](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Register-EC2DhcpOption`
次のコード例は、`Register-EC2DhcpOption` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された DHCP オプションセットを指定された VPC に関連付けます。**
```
Register-EC2DhcpOption -DhcpOptionsId dopt-1a2b3c4d -VpcId vpc-12345678
```
**例 2: この例では、デフォルトの DHCP オプションセットを指定された VPC に関連付けます。**
```
Register-EC2DhcpOption -DhcpOptionsId default -VpcId vpc-12345678
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AssociateDhcpOptions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Register-EC2Image`
次のコード例は、`Register-EC2Image` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Amazon S3 の指定されたマニフェストファイルを使用して AMI を登録します。**
```
Register-EC2Image -ImageLocation amzn-s3-demo-bucket/my-web-server-ami/image.manifest.xml -Name my-web-server-ami
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RegisterImage](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Register-EC2PrivateIpAddress`
次のコード例は、`Register-EC2PrivateIpAddress` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたセカンダリプライベート IP アドレスを指定されたネットワークインターフェイスに割り当てます。**
```
Register-EC2PrivateIpAddress -NetworkInterfaceId eni-1a2b3c4d -PrivateIpAddress 10.0.0.82
```
**例 2: この例では、2 つのセカンダリプライベート IP アドレスを作成し、指定されたネットワークインターフェイスに割り当てます。**
```
Register-EC2PrivateIpAddress -NetworkInterfaceId eni-1a2b3c4d -SecondaryPrivateIpAddressCount 2
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AssignPrivateIpAddresses](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Register-EC2RouteTable`
次のコード例は、`Register-EC2RouteTable` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたルートテーブルを指定されたサブネットに関連付けます。**
```
Register-EC2RouteTable -RouteTableId rtb-1a2b3c4d -SubnetId subnet-1a2b3c4d
```
**出力:**
```
rtbassoc-12345678
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AssociateRouteTable](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2Address`
次のコード例は、`Remove-EC2Address` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、VPC 内のインスタンスに指定された Elastic IP アドレスを解放します。**
```
Remove-EC2Address -AllocationId eipalloc-12345678 -Force
```
**例 2: この例では、EC2-Classic のインスタンスに指定された Elastic IP アドレスを解放します。**
```
Remove-EC2Address -PublicIp 198.51.100.2 -Force
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ReleaseAddress](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2CapacityReservation`
次のコード例は、`Remove-EC2CapacityReservation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、キャパシティ予約 cr-0c1f2345db6f7cdba をキャンセルします。**
```
Remove-EC2CapacityReservation -CapacityReservationId cr-0c1f2345db6f7cdba
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EC2CapacityReservation (CancelCapacityReservation)" on target "cr-0c1f2345db6f7cdba".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y
True
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CancelCapacityReservation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2CustomerGateway`
次のコード例は、`Remove-EC2CustomerGateway` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたカスタマーゲートウェイを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2CustomerGateway -CustomerGatewayId cgw-1a2b3c4d
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2CustomerGateway (DeleteCustomerGateway)" on Target "cgw-1a2b3c4d".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteCustomerGateway](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2DhcpOption`
次のコード例は、`Remove-EC2DhcpOption` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された DHCP オプションのセットを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2DhcpOption -DhcpOptionsId dopt-1a2b3c4d
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2DhcpOption (DeleteDhcpOptions)" on Target "dopt-1a2b3c4d".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteDhcpOptions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2FlowLog`
次のコード例は、`Remove-EC2FlowLog` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された FlowLogId fl-01a2b3456a789c01 を削除します。**
```
Remove-EC2FlowLog -FlowLogId fl-01a2b3456a789c01
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EC2FlowLog (DeleteFlowLogs)" on target "fl-01a2b3456a789c01".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteFlowLogs](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2Host`
次のコード例は、`Remove-EC2Host` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたホスト ID h-0badafd1dcb2f3456 を解放します。**
```
Remove-EC2Host -HostId h-0badafd1dcb2f3456
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EC2Host (ReleaseHosts)" on target "h-0badafd1dcb2f3456".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
Successful Unsuccessful
---------- ------------
{h-0badafd1dcb2f3456} {}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ReleaseHosts](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2Instance`
次のコード例は、`Remove-EC2Instance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたインスタンスを終了します (インスタンスが実行中または「停止状態」である可能性があります)。コマンドレットは、続行する前に確認を求めるプロンプトを表示します。プロンプトを表示しないようにするには、-Force スイッチを使用します。**
```
Remove-EC2Instance -InstanceId i-12345678
```
**出力:**
```
CurrentState InstanceId PreviousState
------------ ---------- -------------
Amazon.EC2.Model.InstanceState i-12345678 Amazon.EC2.Model.InstanceState
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[TerminateInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2InternetGateway`
次のコード例は、`Remove-EC2InternetGateway` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたインターネットゲートウェイを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2InternetGateway -InternetGatewayId igw-1a2b3c4d
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2InternetGateway (DeleteInternetGateway)" on Target "igw-1a2b3c4d".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteInternetGateway](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2KeyPair`
次のコード例は、`Remove-EC2KeyPair` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したキーペアを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2KeyPair -KeyName my-key-pair
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2KeyPair (DeleteKeyPair)" on Target "my-key-pair".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteKeyPair](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2NetworkAcl`
次のコード例は、`Remove-EC2NetworkAcl` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたネットワーク ACL を削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2NetworkAcl -NetworkAclId acl-12345678
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2NetworkAcl (DeleteNetworkAcl)" on Target "acl-12345678".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteNetworkAcl](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2NetworkAclEntry`
次のコード例は、`Remove-EC2NetworkAclEntry` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたネットワーク ACL から指定されたルールを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2NetworkAclEntry -NetworkAclId acl-12345678 -Egress $false -RuleNumber 100
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2NetworkAclEntry (DeleteNetworkAclEntry)" on Target "acl-12345678".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteNetworkAclEntry](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2NetworkInterface`
次のコード例は、`Remove-EC2NetworkInterface` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたネットワークインターフェイスを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2NetworkInterface -NetworkInterfaceId eni-12345678
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2NetworkInterface (DeleteNetworkInterface)" on Target "eni-12345678".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteNetworkInterface](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2PlacementGroup`
次のコード例は、`Remove-EC2PlacementGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたプレイスメントグループを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2PlacementGroup -GroupName my-placement-group
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2PlacementGroup (DeletePlacementGroup)" on Target "my-placement-group".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeletePlacementGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2Route`
次のコード例は、`Remove-EC2Route` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したルートテーブルから指定したルートを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2Route -RouteTableId rtb-1a2b3c4d -DestinationCidrBlock 0.0.0.0/0
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2Route (DeleteRoute)" on Target "rtb-1a2b3c4d".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteRoute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2RouteTable`
次のコード例は、`Remove-EC2RouteTable` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたルートテーブルを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2RouteTable -RouteTableId rtb-1a2b3c4d
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2RouteTable (DeleteRouteTable)" on Target "rtb-1a2b3c4d".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteRouteTable](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2SecurityGroup`
次のコード例は、`Remove-EC2SecurityGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、EC2-VPC の指定されたセキュリティグループを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2SecurityGroup -GroupId sg-12345678
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2SecurityGroup (DeleteSecurityGroup)" on Target "sg-12345678".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**例 2: この例では、EC2-Classic の指定されたセキュリティグループを削除します。**
```
Remove-EC2SecurityGroup -GroupName my-security-group -Force
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteSecurityGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2Snapshot`
次のコード例は、`Remove-EC2Snapshot` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: こので例は、指定したスナップショットを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2Snapshot -SnapshotId snap-12345678
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EC2Snapshot (DeleteSnapshot)" on target "snap-12345678".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteSnapshot](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2SpotDatafeedSubscription`
次のコード例は、`Remove-EC2SpotDatafeedSubscription` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、スポットインスタンスのデータフィードを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2SpotDatafeedSubscription
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2SpotDatafeedSubscription (DeleteSpotDatafeedSubscription)" on Target "".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteSpotDatafeedSubscription](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2Subnet`
次のコード例は、`Remove-EC2Subnet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したサブネットを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2Subnet -SubnetId subnet-1a2b3c4d
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2Subnet (DeleteSubnet)" on Target "subnet-1a2b3c4d".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteSubnet](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-EC2Tag`
次のコード例は、`Remove-EC2Tag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、タグ値に関係なく、指定されたリソースから指定されたタグを削除します。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
Remove-EC2Tag -Resource i-12345678 -Tag @{ Key="myTag" } -Force
```
**例 2: この例では、指定されたタグ値が一致する場合にのみ、指定されたリソースから指定されたタグを削除します。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
Remove-EC2Tag -Resource i-12345678 -Tag @{ Key="myTag";Value="myTagValue" } -Force
```
**例 3: この例では、タグ値に関係なく、指定されたリソースから指定されたタグを削除します。**
```
$tag = New-Object Amazon.EC2.Model.Tag
$tag.Key = "myTag"
Remove-EC2Tag -Resource i-12345678 -Tag $tag -Force
```
**例 4: この例では、指定されたタグ値が一致する場合にのみ、指定されたリソースから指定されたタグを削除します。**
```
$tag = New-Object Amazon.EC2.Model.Tag
$tag.Key = "myTag"
$tag.Value = "myTagValue"
Remove-EC2Tag -Resource i-12345678 -Tag $tag -Force
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2Volume`
次のコード例は、`Remove-EC2Volume` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたボリュームをデタッチします。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2Volume -VolumeId vol-12345678
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EC2Volume (DeleteVolume)" on target "vol-12345678".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteVolume](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2Vpc`
次のコード例は、`Remove-EC2Vpc` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した VPC を削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2Vpc -VpcId vpc-12345678
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2Vpc (DeleteVpc)" on Target "vpc-12345678".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteVpc](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2VpnConnection`
次のコード例は、`Remove-EC2VpnConnection` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された VPN 接続を削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2VpnConnection -VpnConnectionId vpn-12345678
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2VpnConnection (DeleteVpnConnection)" on Target "vpn-12345678".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteVpnConnection](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2VpnConnectionRoute`
次のコード例は、`Remove-EC2VpnConnectionRoute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された VPN 接続から指定された静的ルートを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2VpnConnectionRoute -VpnConnectionId vpn-12345678 -DestinationCidrBlock 11.12.0.0/16
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2VpnConnectionRoute (DeleteVpnConnectionRoute)" on Target "vpn-12345678".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteVpnConnectionRoute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EC2VpnGateway`
次のコード例は、`Remove-EC2VpnGateway` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された仮想プライベートゲートウェイを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-EC2VpnGateway -VpnGatewayId vgw-1a2b3c4d
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-EC2VpnGateway (DeleteVpnGateway)" on Target "vgw-1a2b3c4d".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteVpnGateway](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Request-EC2SpotFleet`
次のコード例は、`Request-EC2SpotFleet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したインスタンスタイプが最低価格のアベイラビリティーゾーンで、スポットフリートリクエストを作成します。アカウントが EC2-VPC のみをサポートしている場合、スポットフリートは、デフォルトのサブネットが存在する、最低料金のアベイラビリティーゾーンでインスタンスを起動します。アカウントが EC2-Classic をサポートしている場合、スポットフリートは、最低料金のアベイラビリティーゾーンの EC2-Classic でインスタンスを起動します。リクエストで指定したスポット料金を超えて課金されることはありません。**
```
$sg = New-Object Amazon.EC2.Model.GroupIdentifier
$sg.GroupId = "sg-12345678"
$lc = New-Object Amazon.EC2.Model.SpotFleetLaunchSpecification
$lc.ImageId = "ami-12345678"
$lc.InstanceType = "m3.medium"
$lc.SecurityGroups.Add($sg)
Request-EC2SpotFleet -SpotFleetRequestConfig_SpotPrice 0.04 `
-SpotFleetRequestConfig_TargetCapacity 2 `
-SpotFleetRequestConfig_IamFleetRole arn:aws:iam::123456789012:role/my-spot-fleet-role `
-SpotFleetRequestConfig_LaunchSpecification $lc
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の[RequestSpotFleet](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Request-EC2SpotInstance`
次のコード例は、`Request-EC2SpotInstance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたサブネットで 1 回限りのスポットインスタンスをリクエストします。セキュリティグループは、指定されたサブネットを含む VPC 用に作成する必要があり、ネットワークインターフェイスを使用して ID で指定する必要があります。ネットワークインターフェイスの指定時、ネットワークインターフェイスを使用してサブネット ID を含める必要があります。**
```
$n = New-Object Amazon.EC2.Model.InstanceNetworkInterfaceSpecification
$n.DeviceIndex = 0
$n.SubnetId = "subnet-12345678"
$n.Groups.Add("sg-12345678")
Request-EC2SpotInstance -InstanceCount 1 -SpotPrice 0.050 -Type one-time `
-IamInstanceProfile_Arn arn:aws:iam::123456789012:instance-profile/my-iam-role `
-LaunchSpecification_ImageId ami-12345678 `
-LaunchSpecification_InstanceType m3.medium `
-LaunchSpecification_NetworkInterface $n
```
**出力:**
```
ActualBlockHourlyPrice :
AvailabilityZoneGroup :
BlockDurationMinutes : 0
CreateTime : 12/26/2015 7:44:10 AM
Fault :
InstanceId :
LaunchedAvailabilityZone :
LaunchGroup :
LaunchSpecification : Amazon.EC2.Model.LaunchSpecification
ProductDescription : Linux/UNIX
SpotInstanceRequestId : sir-12345678
SpotPrice : 0.050000
State : open
Status : Amazon.EC2.Model.SpotInstanceStatus
Tags : {}
Type : one-time
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RequestSpotInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Reset-EC2ImageAttribute`
次のコード例は、`Reset-EC2ImageAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、「launchPermission」属性をデフォルト値にリセットします。デフォルトでは、AMI はプライベートです。**
```
Reset-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermission
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ResetImageAttribute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Reset-EC2InstanceAttribute`
次のコード例は、`Reset-EC2InstanceAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたインスタンスの「sriovNetSupport」属性をリセットします。**
```
Reset-EC2InstanceAttribute -InstanceId i-12345678 -Attribute sriovNetSupport
```
**例 2: この例では、指定されたインスタンスの「ebsOptimized」属性をリセットします。**
```
Reset-EC2InstanceAttribute -InstanceId i-12345678 -Attribute ebsOptimized
```
**例 3: この例では、指定されたインスタンスの「sourceDestCheck」属性をリセットします。**
```
Reset-EC2InstanceAttribute -InstanceId i-12345678 -Attribute sourceDestCheck
```
**例 4: この例では、指定されたインスタンスの「disableApiTermination」属性をリセットします。**
```
Reset-EC2InstanceAttribute -InstanceId i-12345678 -Attribute disableApiTermination
```
**例 5: この例では、指定されたインスタンスの「instanceInitiatedShutdownBehavior」属性をリセットします。**
```
Reset-EC2InstanceAttribute -InstanceId i-12345678 -Attribute instanceInitiatedShutdownBehavior
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ResetInstanceAttribute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Reset-EC2NetworkInterfaceAttribute`
次のコード例は、`Reset-EC2NetworkInterfaceAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたネットワークインターフェイスの送信元/送信先チェックをリセットします。**
```
Reset-EC2NetworkInterfaceAttribute -NetworkInterfaceId eni-1a2b3c4d -SourceDestCheck
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ResetNetworkInterfaceAttribute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Reset-EC2SnapshotAttribute`
次のコード例は、`Reset-EC2SnapshotAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したスナップショットに指定した属性を設定します。**
```
Reset-EC2SnapshotAttribute -SnapshotId snap-12345678 -Attribute CreateVolumePermission
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ResetSnapshotAttribute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Restart-EC2Instance`
次のコード例は、`Restart-EC2Instance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたインスタンスを再起動します。**
```
Restart-EC2Instance -InstanceId i-12345678
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RebootInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Revoke-EC2SecurityGroupEgress`
次のコード例は、`Revoke-EC2SecurityGroupEgress` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、EC2-VPC の指定されたセキュリティグループのルールを削除します。これにより、TCP ポート 80 で指定された IP アドレス範囲へのアクセスが取り消されます。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
$ip = @{ IpProtocol="tcp"; FromPort="80"; ToPort="80"; IpRanges="203.0.113.0/24" }
Revoke-EC2SecurityGroupEgress -GroupId sg-12345678 -IpPermission $ip
```
**例 2: PowerShell バージョン 2 では、New-Object を使用して IpPermission オブジェクトを作成する必要があります。**
```
$ip = New-Object Amazon.EC2.Model.IpPermission
$ip.IpProtocol = "tcp"
$ip.FromPort = 80
$ip.ToPort = 80
$ip.IpRanges.Add("203.0.113.0/24")
Revoke-EC2SecurityGroupEgress -GroupId sg-12345678 -IpPermission $ip
```
**例 3: この例では、TCP ポート 80 で指定されたソースセキュリティグループへのアクセスを取り消します。**
```
$ug = New-Object Amazon.EC2.Model.UserIdGroupPair
$ug.GroupId = "sg-1a2b3c4d"
$ug.UserId = "123456789012"
Revoke-EC2SecurityGroupEgress -GroupId sg-12345678 -IpPermission @( @{ IpProtocol="tcp"; FromPort="80"; ToPort="80"; UserIdGroupPairs=$ug } )
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RevokeSecurityGroupEgress](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Revoke-EC2SecurityGroupIngress`
次のコード例は、`Revoke-EC2SecurityGroupIngress` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、EC2-VPC の指定されたセキュリティグループに対して、指定されたアドレス範囲から TCP ポート 22 へのアクセスを取り消します。セキュリティグループの名前ではなく、セキュリティグループの ID を使用して、EC2-VPC のセキュリティグループを識別する必要があります。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
$ip = @{ IpProtocol="tcp"; FromPort="22"; ToPort="22"; IpRanges="203.0.113.0/24" }
Revoke-EC2SecurityGroupIngress -GroupId sg-12345678 -IpPermission $ip
```
**例 2: PowerShell バージョン 2 では、New-Object を使用して IpPermission オブジェクトを作成する必要があります。**
```
$ip = New-Object Amazon.EC2.Model.IpPermission
$ip.IpProtocol = "tcp"
$ip.FromPort = 22
$ip.ToPort = 22
$ip.IpRanges.Add("203.0.113.0/24")
Revoke-EC2SecurityGroupIngress -GroupId sg-12345678 -IpPermission $ip
```
**例 3: この例では、EC2-Classic の指定されたセキュリティグループに対して、指定されたアドレス範囲から TCP ポート 22 へのアクセスを取り消します。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
$ip = @{ IpProtocol="tcp"; FromPort="22"; ToPort="22"; IpRanges="203.0.113.0/24" }
Revoke-EC2SecurityGroupIngress -GroupName "my-security-group" -IpPermission $ip
```
**例 4: PowerShell バージョン 2 では、New-Object を使用して IpPermission オブジェクトを作成する必要があります。**
```
$ip = New-Object Amazon.EC2.Model.IpPermission
$ip.IpProtocol = "tcp"
$ip.FromPort = 22
$ip.ToPort = 22
$ip.IpRanges.Add("203.0.113.0/24")
Revoke-EC2SecurityGroupIngress -GroupName "my-security-group" -IpPermission $ip
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RevokeSecurityGroupIngress](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Send-EC2InstanceStatus`
次のコード例は、`Send-EC2InstanceStatus` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたインスタンスのステータスフィードバックを報告します。**
```
Send-EC2InstanceStatus -Instance i-12345678 -Status impaired -ReasonCode unresponsive
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ReportInstanceStatus](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Set-EC2NetworkAclAssociation`
次のコード例は、`Set-EC2NetworkAclAssociation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたネットワーク ACL を、指定されたネットワーク ACL 関連付けを持つサブネットに関連付けます。**
```
Set-EC2NetworkAclAssociation -NetworkAclId acl-12345678 -AssociationId aclassoc-1a2b3c4d
```
**出力:**
```
aclassoc-87654321
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ReplaceNetworkAclAssociation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Set-EC2NetworkAclEntry`
次のコード例は、`Set-EC2NetworkAclEntry` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたネットワーク ACL の指定されたエントリを置き換えます。新しいルールでは、指定されたアドレスから関連付けられた任意のサブネットへのインバウンドトラフィックが許可されます。**
```
Set-EC2NetworkAclEntry -NetworkAclId acl-12345678 -Egress $false -RuleNumber 100 -Protocol 17 -PortRange_From 53 -PortRange_To 53 -CidrBlock 203.0.113.12/24 -RuleAction allow
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ReplaceNetworkAclEntry](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Set-EC2Route`
次のコード例は、`Set-EC2Route` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したルートテーブルの指定したルートを置き換えます。新しいルートは、指定されたトラフィックを指定された仮想プライベートゲートウェイに送信します。**
```
Set-EC2Route -RouteTableId rtb-1a2b3c4d -DestinationCidrBlock 10.0.0.0/24 -GatewayId vgw-1a2b3c4d
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ReplaceRoute](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Set-EC2RouteTableAssociation`
次のコード例は、`Set-EC2RouteTableAssociation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたルートテーブルを、指定されたルートテーブルの関連付けを持つサブネットに関連付けます。**
```
Set-EC2RouteTableAssociation -RouteTableId rtb-1a2b3c4d -AssociationId rtbassoc-12345678
```
**出力:**
```
rtbassoc-87654321
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ReplaceRouteTableAssociation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Start-EC2Instance`
次のコード例は、`Start-EC2Instance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたインスタンスを開始します。**
```
Start-EC2Instance -InstanceId i-12345678
```
**出力:**
```
CurrentState InstanceId PreviousState
------------ ---------- -------------
Amazon.EC2.Model.InstanceState i-12345678 Amazon.EC2.Model.InstanceState
```
**例 2: この例では、指定されたインスタンスを開始します。**
```
@("i-12345678", "i-76543210") | Start-EC2Instance
```
**例 3: この例では、現在停止しているインスタンスのセットを開始します。Get-EC2Instance によって返されるインスタンスオブジェクトは、Start-EC2Instance にパイプされます。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
(Get-EC2Instance -Filter @{ Name="instance-state-name"; Values="stopped"}).Instances | Start-EC2Instance
```
**例 4: PowerShell バージョン 2 では、New-Object を使用してフィルターパラメータのフィルターを作成する必要があります。**
```
$filter = New-Object Amazon.EC2.Model.Filter
$filter.Name = "instance-state-name"
$filter.Values = "stopped"
(Get-EC2Instance -Filter $filter).Instances | Start-EC2Instance
```
**例 5: この例では、インスタンスを実際に開始せずに DryRun パラメータを使用して EC2 インスタンスを開始するためのアクセス許可を検証します。注: 成功すると例外がスローされますが、これは正常な動作です。**
```
Start-EC2Instance -InstanceId 'i-0abcdef123456' -Region 'us-west-1' -DryRun $true
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[StartInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Start-EC2InstanceMonitoring`
次のコード例は、`Start-EC2InstanceMonitoring` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたインスタンスの詳細モニタリングを有効にします。**
```
Start-EC2InstanceMonitoring -InstanceId i-12345678
```
**出力:**
```
InstanceId Monitoring
---------- ----------
i-12345678 Amazon.EC2.Model.Monitoring
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[MonitorInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Stop-EC2ImportTask`
次のコード例は、`Stop-EC2ImportTask` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたインポートタスク (スナップショットまたはイメージのインポート) をキャンセルします。必要に応じて、`-CancelReason` パラメータを使用して理由を指定できます。**
```
Stop-EC2ImportTask -ImportTaskId import-ami-abcdefgh
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CancelImportTask](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Stop-EC2Instance`
次のコード例は、`Stop-EC2Instance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたインスタンスを停止します。**
```
Stop-EC2Instance -InstanceId i-12345678
```
**出力:**
```
CurrentState InstanceId PreviousState
------------ ---------- -------------
Amazon.EC2.Model.InstanceState i-12345678 Amazon.EC2.Model.InstanceState
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[StopInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Stop-EC2InstanceMonitoring`
次のコード例は、`Stop-EC2InstanceMonitoring` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたインスタンスの詳細モニタリングを無効にします。**
```
Stop-EC2InstanceMonitoring -InstanceId i-12345678
```
**出力:**
```
InstanceId Monitoring
---------- ----------
i-12345678 Amazon.EC2.Model.Monitoring
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UnmonitorInstances](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Stop-EC2SpotFleetRequest`
次のコード例は、`Stop-EC2SpotFleetRequest` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたスポットフリートリクエストをキャンセルし、関連付けられたスポットインスタンスを終了します。**
```
Stop-EC2SpotFleetRequest -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE -TerminateInstance $true
```
**例 2: この例では、関連付けられたスポットインスタンスを終了せずに、指定されたスポットフリートリクエストをキャンセルします。**
```
Stop-EC2SpotFleetRequest -SpotFleetRequestId sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE -TerminateInstance $false
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CancelSpotFleetRequests](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Stop-EC2SpotInstanceRequest`
次のコード例は、`Stop-EC2SpotInstanceRequest` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたスポットインスタンスリクエストをキャンセルします。**
```
Stop-EC2SpotInstanceRequest -SpotInstanceRequestId sir-12345678
```
**出力:**
```
SpotInstanceRequestId State
--------------------- -----
sir-12345678 cancelled
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CancelSpotInstanceRequests](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Unregister-EC2Address`
次のコード例は、`Unregister-EC2Address` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、VPC 内の指定されたインスタンスから指定された Elastic IP アドレスの関連付けを解除します。**
```
Unregister-EC2Address -AssociationId eipassoc-12345678
```
**例 2: この例では、EC2-Classic 内の指定されたインスタンスから指定された Elastic IP アドレスの関連付けを解除します。**
```
Unregister-EC2Address -PublicIp 203.0.113.17
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DisassociateAddress](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Unregister-EC2Image`
次のコード例は、`Unregister-EC2Image` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された AMI の登録を解除します。**
```
Unregister-EC2Image -ImageId ami-12345678
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeregisterImage](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Unregister-EC2PrivateIpAddress`
次のコード例は、`Unregister-EC2PrivateIpAddress` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたネットワークインターフェイスから指定されたプライベート IP アドレスの割り当てを解除します。**
```
Unregister-EC2PrivateIpAddress -NetworkInterfaceId eni-1a2b3c4d -PrivateIpAddress 10.0.0.82
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UnassignPrivateIpAddresses](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Unregister-EC2RouteTable`
次のコード例は、`Unregister-EC2RouteTable` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ルートテーブルとサブネット間の指定された関連付けを削除します。**
```
Unregister-EC2RouteTable -AssociationId rtbassoc-1a2b3c4d
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DisassociateRouteTable](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-EC2SecurityGroupRuleIngressDescription`
次のコード例は、`Update-EC2SecurityGroupRuleIngressDescription` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 進入 (受信) セキュリティグループルールの説明を更新します。**
```
$existingInboundRule = Get-EC2SecurityGroupRule -SecurityGroupRuleId "sgr-1234567890"
$ruleWithUpdatedDescription = [Amazon.EC2.Model.SecurityGroupRuleDescription]@{
"SecurityGroupRuleId" = $existingInboundRule.SecurityGroupRuleId
"Description" = "Updated rule description"
}
Update-EC2SecurityGroupRuleIngressDescription -GroupId $existingInboundRule.GroupId -SecurityGroupRuleDescription $ruleWithUpdatedDescription
```
**例 2: 既存の進入 (受信) セキュリティグループルールの説明を削除します (リクエストでパラメータを省略)。**
```
$existingInboundRule = Get-EC2SecurityGroupRule -SecurityGroupRuleId "sgr-1234567890"
$ruleWithoutDescription = [Amazon.EC2.Model.SecurityGroupRuleDescription]@{
"SecurityGroupRuleId" = $existingInboundRule.SecurityGroupRuleId
}
Update-EC2SecurityGroupRuleIngressDescription -GroupId $existingInboundRule.GroupId -SecurityGroupRuleDescription $ruleWithoutDescription
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateSecurityGroupRuleDescriptionsIngress](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した Amazon ECR の例
次のコード例は、Amazon ECR で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Get-ECRLoginCommand`
次のコード例は、`Get-ECRLoginCommand` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: IAM プリンシパルがアクセスできる Amazon ECR レジストリへの認証に使用できるログイン情報を含む PSObject を返します。認証トークンを取得するための呼び出しに必要な認証情報とリージョンエンドポイントは、シェルのデフォルト (`Set-AWSCredential/Set-DefaultAWSRegion` または `Initialize-AWSDefaultConfiguration` のコマンドレットによって設定される) から取得されます。Invoke-Expression で コマンドプロパティを使用すると、指定レジストリにログインしたり、返された認証情報をログインを必要とする他のツールで使用したりできます。**
```
Get-ECRLoginCommand
```
**出力:**
```
Username : AWS
Password : eyJwYXlsb2Fk...kRBVEFfS0VZIn0=
ProxyEndpoint : https://123456789012.dkr.ecr.us-west-2.amazonaws.com
Endpoint : https://123456789012.dkr.ecr.us-west-2.amazonaws.com
ExpiresAt : 9/26/2017 6:08:23 AM
Command : docker login --username AWS --password eyJwYXlsb2Fk...kRBVEFfS0VZIn0= https://123456789012.dkr.ecr.us-west-2.amazonaws.com
```
**例 2: Docker ログインコマンドへの入力として使用するログイン情報を含む PSObject を取得します。IAM プリンシパルがそのレジストリにアクセスできる限り、認証する任意の Amazon ECR レジストリ URI を指定できます。**
```
(Get-ECRLoginCommand).Password | docker login --username AWS --password-stdin 012345678910.dkr.ecr.us-east-1.amazonaws.com
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[Get-ECRLoginCommand](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した Amazon ECS の例
次のコード例は、Amazon ECS で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Get-ECSClusterDetail`
次のコード例は、`Get-ECSClusterDetail` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットでは、1 つ以上の ECS クラスターを記述します。**
```
Get-ECSClusterDetail -Cluster "LAB-ECS-CL" -Include SETTINGS | Select-Object *
```
**出力:**
```
LoggedAt : 12/27/2019 9:27:41 PM
Clusters : {LAB-ECS-CL}
Failures : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 396
HttpStatusCode : OK
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeClusters](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ECSClusterList`
次のコード例は、`Get-ECSClusterList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、既存の ECS クラスターのリストを返します。**
```
Get-ECSClusterList
```
**出力:**
```
arn:aws:ecs:us-west-2:012345678912:cluster/LAB-ECS-CL
arn:aws:ecs:us-west-2:012345678912:cluster/LAB-ECS
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListClusters](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ECSClusterService`
次のコード例は、`Get-ECSClusterService` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、デフォルトのクラスターで実行されているすべてのサービスを一覧表示します。**
```
Get-ECSClusterService
```
**例 2: この例では、指定されたクラスターで実行されているすべてのサービスを一覧表示します。**
```
Get-ECSClusterService -Cluster myCluster
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListServices](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ECSService`
次のコード例は、`Get-ECSService` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、デフォルトのクラスターから特定のサービスの詳細を取得する方法を示します。**
```
Get-ECSService -Service my-hhtp-service
```
**例 2: この例では、名前付きクラスターで実行されている特定のサービスの詳細を取得する方法を示します。**
```
Get-ECSService -Cluster myCluster -Service my-hhtp-service
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeServices](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-ECSCluster`
次のコード例は、`New-ECSCluster` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは新しい Amazon ECS クラスターを作成します。**
```
New-ECSCluster -ClusterName "LAB-ECS-CL" -Setting @{Name="containerInsights"; Value="enabled"}
```
**出力:**
```
ActiveServicesCount : 0
Attachments : {}
AttachmentsStatus :
CapacityProviders : {}
ClusterArn : arn:aws:ecs:us-west-2:012345678912:cluster/LAB-ECS-CL
ClusterName : LAB-ECS-CL
DefaultCapacityProviderStrategy : {}
PendingTasksCount : 0
RegisteredContainerInstancesCount : 0
RunningTasksCount : 0
Settings : {containerInsights}
Statistics : {}
Status : ACTIVE
Tags : {}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateCluster](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-ECSService`
次のコード例は、`New-ECSService` を使用する方法を示しています。
**Tools for PowerShell V5**
例 1: このコマンド例では、デフォルトのクラスターに「ecs-simple-service」というサービスを作成します。このサービスは `ecs-demo` タスク定義を使用し、そのタスクのインスタンスを 10 個保持します。
```
New-ECSService -ServiceName ecs-simple-service -TaskDefinition ecs-demo -DesiredCount 10
```
例 2: このコマンド例では、デフォルトクラスター内で、ロードバランサーの背後に「ecs-simple-service」という名前のサービスを作成します。このサービスは `ecs-demo` タスク定義を使用し、そのタスクのインスタンスを 10 個保持します。
```
$lb = @{
LoadBalancerName = "EC2Contai-EcsElast-S06278JGSJCM"
ContainerName = "simple-demo"
ContainerPort = 80
}
New-ECSService -ServiceName ecs-simple-service -TaskDefinition ecs-demo -DesiredCount 10 -LoadBalancer $lb
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateService](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-ECSCluster`
次のコード例は、`Remove-ECSCluster` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、指定された ECS クラスターを削除します。削除する前に、このクラスターからすべてのコンテナインスタンスを登録解除する必要があります。**
```
Remove-ECSCluster -Cluster "LAB-ECS"
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ECSCluster (DeleteCluster)" on target "LAB-ECS".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteCluster](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-ECSService`
次のコード例は、`Remove-ECSService` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: デフォルトクラスターで「my-http-service」という名前のサービスを削除します。サービスを削除する前に、必要数と実行中の数が 0 である必要があります。コマンドを続行する前に確認を求められます。確認を省略するには、-Force スイッチを追加します。**
```
Remove-ECSService -Service my-http-service
```
**例 2: 名前付きクラスターで「my-http-service」という名前のサービスを削除します。**
```
Remove-ECSService -Cluster myCluster -Service my-http-service
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteService](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-ECSClusterSetting`
次のコード例は、`Update-ECSClusterSetting` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、ECS クラスターに使用する設定を変更します。**
```
Update-ECSClusterSetting -Cluster "LAB-ECS-CL" -Setting @{Name="containerInsights"; Value="disabled"}
```
**出力:**
```
ActiveServicesCount : 0
Attachments : {}
AttachmentsStatus :
CapacityProviders : {}
ClusterArn : arn:aws:ecs:us-west-2:012345678912:cluster/LAB-ECS-CL
ClusterName : LAB-ECS-CL
DefaultCapacityProviderStrategy : {}
PendingTasksCount : 0
RegisteredContainerInstancesCount : 0
RunningTasksCount : 0
Settings : {containerInsights}
Statistics : {}
Status : ACTIVE
Tags : {}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateClusterSettings](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-ECSService`
次のコード例は、`Update-ECSService` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンド例では、「my-http-service」サービスを更新して「amazon-ecs-sample」タスク定義を使用します。**
```
Update-ECSService -Service my-http-service -TaskDefinition amazon-ecs-sample
```
**例 2: このコマンド例では、`my-http-service` サービスの必要数を 10 に更新します。**
```
Update-ECSService -Service my-http-service -DesiredCount 10
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateService](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した Amazon EFS の例
次のコード例は、Amazon EFS で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Edit-EFSMountTargetSecurityGroup`
次のコード例は、`Edit-EFSMountTargetSecurityGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたマウントターゲットに対して有効なセキュリティグループを更新します。「sg-xxxxxxxx」の形式で最大 5 つ指定できます。**
```
Edit-EFSMountTargetSecurityGroup -MountTargetId fsmt-1a2b3c4d -SecurityGroup sg-group1,sg-group3
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifyMountTargetSecurityGroups](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EFSFileSystem`
次のコード例は、`Get-EFSFileSystem` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: リージョン内の発信者のアカウントが所有するすべてのファイルシステムのコレクションを返します。**
```
Get-EFSFileSystem
```
**出力:**
```
CreationTime : 5/26/2015 4:02:38 PM
CreationToken : 1a2bff54-85e0-4747-bd95-7bc172c4f555
FileSystemId : fs-1a2b3c4d
LifeCycleState : available
Name :
NumberOfMountTargets : 0
OwnerId : 123456789012
SizeInBytes : Amazon.ElasticFileSystem.Model.FileSystemSize
CreationTime : 5/26/2015 4:06:23 PM
CreationToken : 2b4daa14-85e0-4747-bd95-7bc172c4f555
FileSystemId : fs-4d3c2b1a
...
```
**例 2: 指定されたファイルシステムの詳細を返します。**
```
Get-EFSFileSystem -FileSystemId fs-1a2b3c4d
```
**例 3: ファイルシステムの作成時に指定されたべき等性作成トークンを使用して、ファイルシステムの詳細を返します。**
```
Get-EFSFileSystem -CreationToken 1a2bff54-85e0-4747-bd95-7bc172c4f555
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeFileSystems](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EFSMountTarget`
次のコード例は、`Get-EFSMountTarget` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたファイルシステムに関連付けられたマウントターゲットのコレクションを返します。**
```
Get-EFSMountTarget -FileSystemId fs-1a2b3c4d
```
**出力:**
```
FileSystemId : fs-1a2b3c4d
IpAddress : 10.0.0.131
LifeCycleState : available
MountTargetId : fsmt-1a2b3c4d
NetworkInterfaceId : eni-1a2b3c4d
OwnerId : 123456789012
SubnetId : subnet-1a2b3c4d
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeMountTargets](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EFSMountTargetSecurityGroup`
次のコード例は、`Get-EFSMountTargetSecurityGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: マウントターゲットに関連付けられたネットワークインターフェイスに現在割り当てられているセキュリティグループの ID を返します。**
```
Get-EFSMountTargetSecurityGroup -MountTargetId fsmt-1a2b3c4d
```
**出力:**
```
sg-1a2b3c4d
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeMountTargetSecurityGroups](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EFSTag`
次のコード例は、`Get-EFSTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたファイルシステムに現在関連付けられているタグのコレクションを返します。**
```
Get-EFSTag -FileSystemId fs-1a2b3c4d
```
**出力:**
```
Key Value
--- -----
Name My File System
tagkey1 tagvalue1
tagkey2 tagvalue2
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-EFSFileSystem`
次のコード例は、`New-EFSFileSystem` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 新しい空のファイルシステムを作成します。作成のべき等性を保証するために使用されるトークンは自動的に生成され、返されたオブジェクトの `CreationToken` メンバーからアクセスできます。**
```
New-EFSFileSystem
```
**出力:**
```
CreationTime : 5/26/2015 4:02:38 PM
CreationToken : 1a2bff54-85e0-4747-bd95-7bc172c4f555
FileSystemId : fs-1a2b3c4d
LifeCycleState : creating
Name :
NumberOfMountTargets : 0
OwnerId : 123456789012
SizeInBytes : Amazon.ElasticFileSystem.Model.FileSystemSize
```
**例 2: カスタムトークンを使用して新しい空のファイルシステムを作成し、作成のべき等性を保証します。**
```
New-EFSFileSystem -CreationToken "MyUniqueToken"
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateFileSystem](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EFSMountTarget`
次のコード例は、`New-EFSMountTarget` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: ファイルシステムのマウントターゲットを新規に作成します。指定されたサブネットを使用して、マウントターゲットが作成される仮想プライベートクラウド (VPC) と、(サブネットのアドレス範囲から) 自動割り当てされる IP アドレスを決定します。割り当てられた IP アドレスを使用して、このファイルシステムを Amazon EC2 インスタンスにマウントできます。セキュリティグループが指定されていないため、ターゲット用に作成されたネットワークインターフェイスは、サブネットの VPC のデフォルトのセキュリティグループに関連付けられます。**
```
New-EFSMountTarget -FileSystemId fs-1a2b3c4d -SubnetId subnet-1a2b3c4d
```
**出力:**
```
FileSystemId : fs-1a2b3c4d
IpAddress : 10.0.0.131
LifeCycleState : creating
MountTargetId : fsmt-1a2b3c4d
NetworkInterfaceId : eni-1a2b3c4d
OwnerId : 123456789012
SubnetId : subnet-1a2b3c4d
```
**例 2: 自動割り当て IP アドレスを使用して、指定されたファイルシステムの新しいマウントターゲットを作成します。マウントターゲット用に作成されたネットワークインターフェイスは、指定されたセキュリティグループに関連付けられます (「sg-xxxxxxxx」の形式で最大 5 つまで指定できます)。**
```
New-EFSMountTarget -FileSystemId fs-1a2b3c4d -SubnetId subnet-1a2b3c4d -SecurityGroup sg-group1,sg-group2,sg-group3
```
**例 3: 指定された IP アドレスを使用して、指定されたファイルシステムの新しいマウントターゲットを作成します。**
```
New-EFSMountTarget -FileSystemId fs-1a2b3c4d -SubnetId subnet-1a2b3c4d -IpAddress 10.0.0.131
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateMountTarget](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EFSTag`
次のコード例は、`New-EFSTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定ファイルシステムにタグのコレクションを適用します。指定キーを持つタグが既にファイルシステムに存在する場合、タグの値は更新されます。**
```
New-EFSTag -FileSystemId fs-1a2b3c4d -Tag @{Key="tagkey1";Value="tagvalue1"},@{Key="tagkey2";Value="tagvalue2"}
```
**例 2: 指定ファイルシステムの名前タグを設定します。この値は、Get-EFSFileSystem コマンドレットを使用するときに、他のファイルシステムの詳細とともに返されます。**
```
New-EFSTag -FileSystemId fs-1a2b3c4d -Tag @{Key="Name";Value="My File System"}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EFSFileSystem`
次のコード例は、`Remove-EFSFileSystem` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 使用されなくなった指定ファイルシステムを削除します (ファイルシステムにマウントターゲットがある場合は、最初に削除する必要があります)。コマンドレットが続行される前に確認を求めるプロンプトが表示されます。プロンプトを表示しないようにするには、`-Force` スイッチを使用します。**
```
Remove-EFSFileSystem -FileSystemId fs-1a2b3c4d
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteFileSystem](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EFSMountTarget`
次のコード例は、`Remove-EFSMountTarget` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたマウントターゲットを削除します。操作を続行する前に確認画面が表示されます。プロンプトを表示しないようにするには、`-Force` スイッチを使用します。このオペレーションでは、ターゲットを介してファイルシステムのマウントが強制的に中断されることに注意してください。可能であれば、このコマンドを実行する前にファイルシステムのアンマウントを検討してください。**
```
Remove-EFSMountTarget -MountTargetId fsmt-1a2b3c4d
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteMountTarget](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EFSTag`
次のコード例は、`Remove-EFSTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: ファイルシステムから 1 つ以上のタグのコレクションを削除します。コマンドレットが続行される前に確認を求めるプロンプトが表示されます。プロンプトを表示しないようにするには、`-Force` スイッチを使用します。**
```
Remove-EFSTag -FileSystemId fs-1a2b3c4d -TagKey "tagkey1","tagkey2"
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した Amazon EKS の例
次のコード例は、Amazon EKS で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-EKSResourceTag`
次のコード例は、`Add-EKSResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、指定されたタグを、指定された resourceArn を持つリソースに関連付けます。**
```
Add-EKSResourceTag -ResourceArn "arn:aws:eks:us-west-2:012345678912:cluster/PROD" -Tag @{Name = "EKSPRODCLUSTER"}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[TagResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EKSCluster`
次のコード例は、`Get-EKSCluster` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、Amazon EKS クラスターに関する詳細情報を返します。**
```
Get-EKSCluster -Name "PROD"
```
**出力:**
```
Arn : arn:aws:eks:us-west-2:012345678912:cluster/PROD
CertificateAuthority : Amazon.EKS.Model.Certificate
ClientRequestToken :
CreatedAt : 12/25/2019 6:46:17 AM
Endpoint : https://669608765450FBBE54D1D78A3D71B72C.gr8.us-west-2.eks.amazonaws.com
Identity : Amazon.EKS.Model.Identity
Logging : Amazon.EKS.Model.Logging
Name : PROD
PlatformVersion : eks.7
ResourcesVpcConfig : Amazon.EKS.Model.VpcConfigResponse
RoleArn : arn:aws:iam::012345678912:role/eks-iam-role
Status : ACTIVE
Tags : {}
Version : 1.14
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeCluster](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EKSClusterList`
次のコード例は、`Get-EKSClusterList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、指定されたリージョン AWS アカウント の にある Amazon EKS クラスターを一覧表示します。**
```
Get-EKSClusterList
```
**出力:**
```
PROD
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListClusters](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EKSFargateProfile`
次のコード例は、`Get-EKSFargateProfile` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、 AWS Fargate プロファイルに関する説明情報を返します。**
```
Get-EKSFargateProfile -FargateProfileName "EKSFargate" -ClusterName "TEST"
```
**出力:**
```
ClusterName : TEST
CreatedAt : 12/26/2019 12:34:47 PM
FargateProfileArn : arn:aws:eks:us-east-2:012345678912:fargateprofile/TEST/EKSFargate/42b7a119-e16b-a279-ce97-bdf303adec92
FargateProfileName : EKSFargate
PodExecutionRoleArn : arn:aws:iam::012345678912:role/AmazonEKSFargatePodExecutionRole
Selectors : {Amazon.EKS.Model.FargateProfileSelector}
Status : ACTIVE
Subnets : {subnet-0cd976f08d5fbfaae, subnet-02f6ff500ff2067a0}
Tags : {}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeFargateProfile](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EKSFargateProfileList`
次のコード例は、`Get-EKSFargateProfileList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、指定されたリージョンの 内の指定されたクラスターに関連付けられた AWS Fargate プロファイル AWS アカウント を一覧表示します。**
```
Get-EKSFargateProfileList -ClusterName "TEST"
```
**出力:**
```
EKSFargate
EKSFargateProfile
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListFargateProfiles](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EKSNodegroup`
次のコード例は、`Get-EKSNodegroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、Amazon EKS ノードグループに関する詳細情報を返します。**
```
Get-EKSNodegroup -NodegroupName "ProdEKSNodeGroup" -ClusterName "PROD"
```
**出力:**
```
AmiType : AL2_x86_64
ClusterName : PROD
CreatedAt : 12/25/2019 10:16:45 AM
DiskSize : 40
Health : Amazon.EKS.Model.NodegroupHealth
InstanceTypes : {t3.large}
Labels : {}
ModifiedAt : 12/25/2019 10:16:45 AM
NodegroupArn : arn:aws:eks:us-west-2:012345678912:nodegroup/PROD/ProdEKSNodeGroup/7eb79e47-82b6-04d9-e984-95110db6fa85
NodegroupName : ProdEKSNodeGroup
NodeRole : arn:aws:iam::012345678912:role/NodeInstanceRole
ReleaseVersion : 1.14.7-20190927
RemoteAccess :
Resources :
ScalingConfig : Amazon.EKS.Model.NodegroupScalingConfig
Status : CREATING
Subnets : {subnet-0d1a9fff35efa7691, subnet-0a3f4928edbc224d4}
Tags : {}
Version : 1.14
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeNodegroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EKSNodegroupList`
次のコード例は、`Get-EKSNodegroupList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、指定されたリージョンの 内の指定されたクラスターに関連付けられた Amazon EKS ノードグループ AWS アカウント を一覧表示します。 **
```
Get-EKSNodegroupList -ClusterName PROD
```
**出力:**
```
ProdEKSNodeGroup
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListNodegroups](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EKSResourceTag`
次のコード例は、`Get-EKSResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、Amazon EKS リソースのタグを一覧表示します。 **
```
Get-EKSResourceTag -ResourceArn "arn:aws:eks:us-west-2:012345678912:cluster/PROD"
```
**出力:**
```
Key Value
--- -----
Name EKSPRODCLUSTER
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-EKSUpdate`
次のコード例は、`Get-EKSUpdate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、Amazon EKS クラスターまたは関連するマネージドノードグループに対する更新に関する詳細情報を返します。**
```
Get-EKSUpdate -Name "PROD" -UpdateId "ee708232-7d2e-4ed7-9270-d0b5176f0726"
```
**出力:**
```
CreatedAt : 12/25/2019 5:03:07 PM
Errors : {}
Id : ee708232-7d2e-4ed7-9270-d0b5176f0726
Params : {Amazon.EKS.Model.UpdateParam}
Status : Successful
Type : LoggingUpdate
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeUpdate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-EKSUpdateList`
次のコード例は、`Get-EKSUpdateList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、指定されたリージョンの 内の Amazon EKS クラスターまたはマネージドノードグループに関連付けられた更新 AWS アカウントを一覧表示します。**
```
Get-EKSUpdateList -Name "PROD"
```
**出力:**
```
ee708232-7d2e-4ed7-9270-d0b5176f0726
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ListUpdates](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EKSCluster`
次のコード例は、`New-EKSCluster` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、「prod」という新しいクラスターを作成します。**
```
New-EKSCluster -Name prod -ResourcesVpcConfig @{SubnetIds=@("subnet-0a1b2c3d","subnet-3a2b1c0d");SecurityGroupIds="sg-6979fe18"} -RoleArn "arn:aws:iam::012345678901:role/eks-service-role"
```
**出力:**
```
Arn : arn:aws:eks:us-west-2:012345678901:cluster/prod
CertificateAuthority : Amazon.EKS.Model.Certificate
ClientRequestToken :
CreatedAt : 12/10/2018 9:25:31 PM
Endpoint :
Name : prod
PlatformVersion : eks.3
ResourcesVpcConfig : Amazon.EKS.Model.VpcConfigResponse
RoleArn : arn:aws:iam::012345678901:role/eks-service-role
Status : CREATING
Version : 1.10
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateCluster](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EKSFargateProfile`
次のコード例は、`New-EKSFargateProfile` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、Amazon EKS クラスターの AWS Fargate プロファイルを作成します。Fargate インフラストラクチャでポッドをスケジュールできるようにするには、クラスター内に少なくとも 1 つの Fargate プロファイルが必要です。**
```
New-EKSFargateProfile -FargateProfileName EKSFargateProfile -ClusterName TEST -Subnet "subnet-02f6ff500ff2067a0", "subnet-0cd976f08d5fbfaae" -PodExecutionRoleArn arn:aws:iam::012345678912:role/AmazonEKSFargatePodExecutionRole -Selector @{Namespace="default"}
```
**出力:**
```
ClusterName : TEST
CreatedAt : 12/26/2019 12:38:21 PM
FargateProfileArn : arn:aws:eks:us-east-2:012345678912:fargateprofile/TEST/EKSFargateProfile/20b7a11b-8292-41c1-bc56-ffa5e60f6224
FargateProfileName : EKSFargateProfile
PodExecutionRoleArn : arn:aws:iam::012345678912:role/AmazonEKSFargatePodExecutionRole
Selectors : {Amazon.EKS.Model.FargateProfileSelector}
Status : CREATING
Subnets : {subnet-0cd976f08d5fbfaae, subnet-02f6ff500ff2067a0}
Tags : {}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateFargateProfile](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-EKSNodeGroup`
次のコード例は、`New-EKSNodeGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、Amazon EKS クラスターのマネージド型ワーカーノードグループを作成します。クラスターの現在の Kubernetes バージョンと同じクラスター対してのみノードグループを作成できます。すべてのノードグループは、クラスターのそれぞれのマイナー Kubernetes バージョンの最新の AMI リリースバージョンで作成されます。**
```
New-EKSNodeGroup -NodeGroupName "ProdEKSNodeGroup" -AmiType "AL2_x86_64" -DiskSize 40 -ClusterName "PROD" -ScalingConfig_DesiredSize 2 -ScalingConfig_MinSize 2 -ScalingConfig_MaxSize 5 -InstanceType t3.large -NodeRole "arn:aws:iam::012345678912:role/NodeInstanceRole" -Subnet "subnet-0d1a9fff35efa7691","subnet-0a3f4928edbc224d4"
```
**出力:**
```
AmiType : AL2_x86_64
ClusterName : PROD
CreatedAt : 12/25/2019 10:16:45 AM
DiskSize : 40
Health : Amazon.EKS.Model.NodegroupHealth
InstanceTypes : {t3.large}
Labels : {}
ModifiedAt : 12/25/2019 10:16:45 AM
NodegroupArn : arn:aws:eks:us-west-2:012345678912:nodegroup/PROD/ProdEKSNodeGroup/7eb79e47-82b6-04d9-e984-95110db6fa85
NodegroupName : ProdEKSNodeGroup
NodeRole : arn:aws:iam::012345678912:role/NodeInstanceRole
ReleaseVersion : 1.14.7-20190927
RemoteAccess :
Resources :
ScalingConfig : Amazon.EKS.Model.NodegroupScalingConfig
Status : CREATING
Subnets : {subnet-0d1a9fff35efa7691, subnet-0a3f4928edbc224d4}
Tags : {}
Version : 1.14
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateNodegroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EKSCluster`
次のコード例は、`Remove-EKSCluster` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、Amazon EKS クラスターコントロールプレーンを削除します。**
```
Remove-EKSCluster -Name "DEV-KUBE-CL"
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EKSCluster (DeleteCluster)" on target "DEV-KUBE-CL".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
Arn : arn:aws:eks:us-west-2:012345678912:cluster/DEV-KUBE-CL
CertificateAuthority : Amazon.EKS.Model.Certificate
ClientRequestToken :
CreatedAt : 12/25/2019 9:33:25 AM
Endpoint : https://02E6D31E3E4F8C15D7BE7F58D527776A.yl4.us-west-2.eks.amazonaws.com
Identity : Amazon.EKS.Model.Identity
Logging : Amazon.EKS.Model.Logging
Name : DEV-KUBE-CL
PlatformVersion : eks.7
ResourcesVpcConfig : Amazon.EKS.Model.VpcConfigResponse
RoleArn : arn:aws:iam::012345678912:role/eks-iam-role
Status : DELETING
Tags : {}
Version : 1.14
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteCluster](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EKSFargateProfile`
次のコード例は、`Remove-EKSFargateProfile` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは AWS Fargate プロファイルを削除します。Fargate プロファイルを削除すると、そのプロファイルで Fargate で作成された Fargate 上で実行中のポッドは削除されます。**
```
Remove-EKSFargateProfile -FargateProfileName "EKSFargate" -ClusterName "TEST"
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EKSFargateProfile (DeleteFargateProfile)" on target "EKSFargate".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
ClusterName : TEST
CreatedAt : 12/26/2019 12:34:47 PM
FargateProfileArn : arn:aws:eks:us-east-2:012345678912:fargateprofile/TEST/EKSFargate/42b7a119-e16b-a279-ce97-bdf303adec92
FargateProfileName : EKSFargate
PodExecutionRoleArn : arn:aws:iam::012345678912:role/AmazonEKSFargatePodExecutionRole
Selectors : {Amazon.EKS.Model.FargateProfileSelector}
Status : DELETING
Subnets : {subnet-0cd976f08d5fbfaae, subnet-02f6ff500ff2067a0}
Tags : {}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteFargateProfile](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EKSNodegroup`
次のコード例は、`Remove-EKSNodegroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、クラスターの Amazon EKS ノードグループを削除します。**
```
Remove-EKSNodegroup -NodegroupName "ProdEKSNodeGroup" -ClusterName "PROD"
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EKSNodegroup (DeleteNodegroup)" on target "ProdEKSNodeGroup".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
AmiType : AL2_x86_64
ClusterName : PROD
CreatedAt : 12/25/2019 10:16:45 AM
DiskSize : 40
Health : Amazon.EKS.Model.NodegroupHealth
InstanceTypes : {t3.large}
Labels : {}
ModifiedAt : 12/25/2019 11:01:16 AM
NodegroupArn : arn:aws:eks:us-west-2:012345678912:nodegroup/PROD/ProdEKSNodeGroup/7eb79e47-82b6-04d9-e984-95110db6fa85
NodegroupName : ProdEKSNodeGroup
NodeRole : arn:aws:iam::012345678912:role/NodeInstanceRole
ReleaseVersion : 1.14.7-20190927
RemoteAccess :
Resources : Amazon.EKS.Model.NodegroupResources
ScalingConfig : Amazon.EKS.Model.NodegroupScalingConfig
Status : DELETING
Subnets : {subnet-0d1a9fff35efa7691, subnet-0a3f4928edbc224d4}
Tags : {}
Version : 1.14
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteNodegroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-EKSResourceTag`
次のコード例は、`Remove-EKSResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、EKS リソースから指定されたタグを削除します。**
```
Remove-EKSResourceTag -ResourceArn "arn:aws:eks:us-west-2:012345678912:cluster/PROD" -TagKey "Name"
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-EKSResourceTag (UntagResource)" on target "arn:aws:eks:us-west-2:012345678912:cluster/PROD".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UntagResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-EKSClusterConfig`
次のコード例は、`Update-EKSClusterConfig` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: Amazon EKS クラスター設定を更新します。更新中もクラスターは引き続き機能します。**
```
Update-EKSClusterConfig -Name "PROD" -Logging_ClusterLogging @{Types="api","audit","authenticator","controllerManager","scheduler",Enabled="True"}
```
**出力:**
```
CreatedAt : 12/25/2019 5:03:07 PM
Errors : {}
Id : ee708232-7d2e-4ed7-9270-d0b5176f0726
Params : {Amazon.EKS.Model.UpdateParam}
Status : InProgress
Type : LoggingUpdate
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateClusterConfig](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Update-EKSClusterVersion`
次のコード例は、`Update-EKSClusterVersion` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドレットは、Amazon EKS クラスターを指定された Kubernetes バージョンに更新します。更新中もクラスターは引き続き機能します。**
```
Update-EKSClusterVersion -Name "PROD-KUBE-CL" -Version 1.14
```
**出力:**
```
CreatedAt : 12/26/2019 9:50:37 AM
Errors : {}
Id : ef186eff-3b3a-4c25-bcfc-3dcdf9e898a8
Params : {Amazon.EKS.Model.UpdateParam, Amazon.EKS.Model.UpdateParam}
Status : InProgress
Type : VersionUpdate
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[UpdateClusterVersion](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した Elastic Load Balancing - バージョン 1 の例
次のコード例は、Elastic Load Balancing - バージョン 1 で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-ELBLoadBalancerToSubnet`
次のコード例は、`Add-ELBLoadBalancerToSubnet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーに設定された一連のサブネットのセットに、指定されたサブネットを追加します。出力にはサブネットの完全なリストが含まれます。**
```
Add-ELBLoadBalancerToSubnet -LoadBalancerName my-load-balancer -Subnet subnet-12345678
```
**出力:**
```
subnet-12345678
subnet-87654321
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AttachLoadBalancerToSubnets](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Add-ELBResourceTag`
次のコード例は、`Add-ELBResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーにタグを追加します。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
Add-ELBResourceTag -LoadBalancerName my-load-balancer -Tag @{ Key="project";Value="lima" },@{ Key="department";Value="digital-media" }
```
**例 2: PowerShell バージョン 2 では、New-Object を使用してタグパラメータのタグを作成する必要があります。**
```
$tag = New-Object Amazon.ElasticLoadBalancing.Model.Tag
$tag.Key = "project"
$tag.Value = "lima"
Add-ELBResourceTag -LoadBalancerName my-load-balancer -Tag $tag
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AddTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Disable-ELBAvailabilityZoneForLoadBalancer`
次のコード例は、`Disable-ELBAvailabilityZoneForLoadBalancer` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーからを指定されたアベイラビリティーゾーンを削除します。出力には残りのアベイラビリティーゾーンが含まれます。**
```
Disable-ELBAvailabilityZoneForLoadBalancer -LoadBalancerName my-load-balancer -AvailabilityZone us-west-2a
```
**出力:**
```
us-west-2b
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DisableAvailabilityZonesForLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Dismount-ELBLoadBalancerFromSubnet`
次のコード例は、`Dismount-ELBLoadBalancerFromSubnet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーに設定されたサブネットのセットから、指定されたサブネットを削除します。出力には残りのサブネットが含まれます。**
```
Dismount-ELBLoadBalancerFromSubnet -LoadBalancerName my-load-balancer -Subnet subnet-12345678
```
**出力:**
```
subnet-87654321
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DetachLoadBalancerFromSubnets](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-ELBLoadBalancerAttribute`
次のコード例は、`Edit-ELBLoadBalancerAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーのクロスゾーン負荷分散を有効にします。**
```
Edit-ELBLoadBalancerAttribute -LoadBalancerName my-load-balancer -CrossZoneLoadBalancing_Enabled $true
```
**例 2: この例では、指定されたロードバランサーの Connection Draining を無効にします。**
```
Edit-ELBLoadBalancerAttribute -LoadBalancerName my-load-balancer -ConnectionDraining_Enabled $false
```
**例 3: この例では、指定されたロードバランサーのアクセスログ記録を有効にします。**
```
Edit-ELBLoadBalancerAttribute -LoadBalancerName my-load-balancer `
>> -AccessLog_Enabled $true `
>> -AccessLog_S3BucketName amzn-s3-demo-logging-bucket `
>> -AccessLog_S3BucketPrefix my-app/prod `
>> -AccessLog_EmitInterval 60
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifyLoadBalancerAttributes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Enable-ELBAvailabilityZoneForLoadBalancer`
次のコード例は、`Enable-ELBAvailabilityZoneForLoadBalancer` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアベイラビリティーゾーンを指定されたロードバランサーに追加します。出力には、アベイラビリティーゾーンの完全なリストが含まれます。**
```
Enable-ELBAvailabilityZoneForLoadBalancer -LoadBalancerName my-load-balancer -AvailabilityZone us-west-2a
```
**出力:**
```
us-west-2a
us-west-2b
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[EnableAvailabilityZonesForLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ELBInstanceHealth`
次のコード例は、`Get-ELBInstanceHealth` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーに登録されているインスタンスの状態を記述します。**
```
Get-ELBInstanceHealth -LoadBalancerName my-load-balancer
```
**出力:**
```
Description InstanceId ReasonCode State
----------- ---------- ---------- -----
N/A i-87654321 N/A InService
Instance has failed at lea... i-12345678 Instance OutOfService
```
**例 2: この例では、指定されたロードバランサーに登録されている指定されたインスタンスの状態を記述します。**
```
Get-ELBInstanceHealth -LoadBalancerName my-load-balancer -Instance i-12345678
```
**例 3: この例では、指定されたインスタンスの状態の完全な説明を表示します。**
```
(Get-ELBInstanceHealth -LoadBalancerName my-load-balancer -Instance i-12345678).Description
```
**出力:**
```
Instance has failed at least the UnhealthyThreshold number of health checks consecutively.
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeInstanceHealth](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ELBLoadBalancer`
次のコード例は、`Get-ELBLoadBalancer` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ロードバランサーの名前を一覧表示します。**
```
Get-ELBLoadBalancer | format-table -property LoadBalancerName
```
**出力:**
```
LoadBalancerName
----------------
my-load-balancer
my-other-load-balancer
my-internal-load-balancer
```
**例 2: この例では、指定されたロードバランサーを記述します。**
```
Get-ELBLoadBalancer -LoadBalancerName my-load-balancer
```
**出力:**
```
AvailabilityZones : {us-west-2a, us-west-2b}
BackendServerDescriptions : {Amazon.ElasticLoadBalancing.Model.BackendServerDescription}
CanonicalHostedZoneName : my-load-balancer-1234567890.us-west-2.elb.amazonaws.com
CanonicalHostedZoneNameID : Z3DZXE0EXAMPLE
CreatedTime : 4/11/2015 12:12:45 PM
DNSName : my-load-balancer-1234567890.us-west-2.elb.amazonaws.com
HealthCheck : Amazon.ElasticLoadBalancing.Model.HealthCheck
Instances : {i-207d9717, i-afefb49b}
ListenerDescriptions : {Amazon.ElasticLoadBalancing.Model.ListenerDescription}
LoadBalancerName : my-load-balancer
Policies : Amazon.ElasticLoadBalancing.Model.Policies
Scheme : internet-facing
SecurityGroups : {sg-a61988c3}
SourceSecurityGroup : Amazon.ElasticLoadBalancing.Model.SourceSecurityGroup
Subnets : {subnet-15aaab61}
VPCId : vpc-a01106c2
```
**例 3: この例では、現在の AWS リージョンのすべてのロードバランサーについて説明します。**
```
Get-ELBLoadBalancer
```
**例 4: この例では、使用可能なすべての AWS リージョンのすべてのロードバランサーを記述します。**
```
Get-AWSRegion | % { Get-ELBLoadBalancer -Region $_ }
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeLoadBalancers](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-ELBLoadBalancerAttribute`
次のコード例は、`Get-ELBLoadBalancerAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーの属性を記述します。**
```
Get-ELBLoadBalancerAttribute -LoadBalancerName my-load-balancer
```
**出力:**
```
AccessLog : Amazon.ElasticLoadBalancing.Model.AccessLog
AdditionalAttributes : {}
ConnectionDraining : Amazon.ElasticLoadBalancing.Model.ConnectionDraining
ConnectionSettings : Amazon.ElasticLoadBalancing.Model.ConnectionSettings
CrossZoneLoadBalancing : Amazon.ElasticLoadBalancing.Model.CrossZoneLoadBalancing
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeLoadBalancerAttributes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-ELBLoadBalancerPolicy`
次のコード例は、`Get-ELBLoadBalancerPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーに関連付けられたポリシーを記述します。**
```
Get-ELBLoadBalancerPolicy -LoadBalancerName my-load-balancer
```
**出力:**
```
PolicyAttributeDescriptions PolicyName PolicyTypeName
--------------------------- ---------- --------------
{ProxyProtocol} my-ProxyProtocol-policy ProxyProtocolPolicyType
{CookieName} my-app-cookie-policy AppCookieStickinessPolicyType
```
**例 2: この例では、指定されたポリシーの属性を記述します。**
```
(Get-ELBLoadBalancerPolicy -LoadBalancerName my-load-balancer -PolicyName my-ProxyProtocol-policy).PolicyAttributeDescriptions
```
**出力:**
```
AttributeName AttributeValue
------------- --------------
ProxyProtocol true
```
**例 3: この例では、サンプルポリシーを含む事前定義されたポリシーを記述します。サンプルポリシーの名前には ELBSample- プレフィックスが付いています。**
```
Get-ELBLoadBalancerPolicy
```
**出力:**
```
PolicyAttributeDescriptions PolicyName PolicyTypeName
--------------------------- ---------- --------------
{Protocol-SSLv2, Protocol-TLSv1, Pro... ELBSecurityPolicy-2015-05 SSLNegotiationPolicyType
{Protocol-SSLv2, Protocol-TLSv1, Pro... ELBSecurityPolicy-2015-03 SSLNegotiationPolicyType
{Protocol-SSLv2, Protocol-TLSv1, Pro... ELBSecurityPolicy-2015-02 SSLNegotiationPolicyType
{Protocol-SSLv2, Protocol-TLSv1, Pro... ELBSecurityPolicy-2014-10 SSLNegotiationPolicyType
{Protocol-SSLv2, Protocol-TLSv1, Pro... ELBSecurityPolicy-2014-01 SSLNegotiationPolicyType
{Protocol-SSLv2, Protocol-TLSv1, Pro... ELBSecurityPolicy-2011-08 SSLNegotiationPolicyType
{Protocol-SSLv2, Protocol-TLSv1, Pro... ELBSample-ELBDefaultCipherPolicy SSLNegotiationPolicyType
{Protocol-SSLv2, Protocol-TLSv1, Pro... ELBSample-OpenSSLDefaultCipherPolicy SSLNegotiationPolicyType
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeLoadBalancerPolicies](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ELBLoadBalancerPolicyType`
次のコード例は、`Get-ELBLoadBalancerPolicyType` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Elastic Load Balancing でサポートされているポリシータイプを取得します。**
```
Get-ELBLoadBalancerPolicyType
```
**出力:**
```
Description PolicyAttributeTypeDescriptions PolicyTypeName
----------- ------------------------------- --------------
Stickiness policy with session lifet... {CookieExpirationPeriod} LBCookieStickinessPolicyType
Policy that controls authentication ... {PublicKeyPolicyName} BackendServerAuthenticationPolicyType
Listener policy that defines the cip... {Protocol-SSLv2, Protocol-TLSv1, Pro... SSLNegotiationPolicyType
Policy containing a list of public k... {PublicKey} PublicKeyPolicyType
Stickiness policy with session lifet... {CookieName} AppCookieStickinessPolicyType
Policy that controls whether to incl... {ProxyProtocol} ProxyProtocolPolicyType
```
**例 2: この例では、指定されたポリシータイプを記述します。**
```
Get-ELBLoadBalancerPolicyType -PolicyTypeName ProxyProtocolPolicyType
```
**出力:**
```
Description PolicyAttributeTypeDescriptions PolicyTypeName
----------- ------------------------------- --------------
Policy that controls whether to incl... {ProxyProtocol} ProxyProtocolPolicyType
```
**例 3: この例では、指定されたポリシータイプの完全な説明を表示します。**
```
(Get-ELBLoadBalancerPolicyType -PolicyTypeName).Description
```
**出力:**
```
Policy that controls whether to include the IP address and port of the originating request for TCP messages.
This policy operates on TCP/SSL listeners only
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeLoadBalancerPolicyTypes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ELBResourceTag`
次のコード例は、`Get-ELBResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーのタグを一覧表示します。**
```
Get-ELBResourceTag -LoadBalancerName @("my-load-balancer","my-internal-load-balancer")
```
**出力:**
```
LoadBalancerName Tags
---------------- ----
my-load-balancer {project, department}
my-internal-load-balancer {project, department}
```
**例 2: この例では、指定されたロードバランサーのタグを記述します。**
```
(Get-ELBResourceTag -LoadBalancerName my-load-balancer).Tags
```
**出力:**
```
Key Value
--- -----
project lima
department digital-media
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Join-ELBSecurityGroupToLoadBalancer`
次のコード例は、`Join-ELBSecurityGroupToLoadBalancer` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーの現在のセキュリティグループを、指定されたセキュリティグループに置き換えます。**
```
Join-ELBSecurityGroupToLoadBalancer -LoadBalancerName my-load-balancer -SecurityGroup sg-87654321
```
**出力:**
```
sg-87654321
```
**例 2: 現在のセキュリティグループを保持し、追加のセキュリティグループを指定するには、既存のセキュリティグループと新しいセキュリティグループの両方を指定します。**
```
Join-ELBSecurityGroupToLoadBalancer -LoadBalancerName my-load-balancer -SecurityGroup @("sg-12345678", "sg-87654321")
```
**出力:**
```
sg-12345678
sg-87654321
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ApplySecurityGroupsToLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-ELBAppCookieStickinessPolicy`
次のコード例は、`New-ELBAppCookieStickinessPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたアプリケーション生成 Cookie のスティッキーセッション存続期間に従うスティッキーポリシーを生成します。**
```
New-ELBAppCookieStickinessPolicy -LoadBalancerName my-load-balancer -PolicyName my-app-cookie-policy -CookieName my-app-cookie
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateAppCookieStickinessPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-ELBLBCookieStickinessPolicy`
次のコード例は、`New-ELBLBCookieStickinessPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された有効期間 (秒) によって制御されたスティッキーセッションの存続期間を持つスティッキーポリシーを生成します。**
```
New-ELBLBCookieStickinessPolicy -LoadBalancerName my-load-balancer -PolicyName my-duration-cookie-policy -CookieExpirationPeriod 60
```
**例 2: この例では、ブラウザ (user-agent) の有効期間によって制御されるスティッキーセッションの有効期間を持つスティッキーポリシーを作成します。**
```
New-ELBLBCookieStickinessPolicy -LoadBalancerName my-load-balancer -PolicyName my-duration-cookie-policy
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateLbCookieStickinessPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-ELBLoadBalancer`
次のコード例は、`New-ELBLoadBalancer` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、VPC に HTTP リスナーを持つロードバランサーを作成します。**
```
$httpListener = New-Object Amazon.ElasticLoadBalancing.Model.Listener
$httpListener.Protocol = "http"
$httpListener.LoadBalancerPort = 80
$httpListener.InstanceProtocol = "http"
$httpListener.InstancePort = 80
New-ELBLoadBalancer -LoadBalancerName my-vpc-load-balancer -SecurityGroup sg-a61988c3 -Subnet subnet-15aaab61 -Listener $httpListener
my-vpc-load-balancer-1234567890.us-west-2.elb.amazonaws.com
```
**例 2: この例では、EC2-Classic に HTTP リスナーを持つロードバランサーを作成します。**
```
New-ELBLoadBalancer -LoadBalancerName my-classic-load-balancer -AvailabilityZone us-west-2a` -Listener $httpListener
```
**出力:**
```
my-classic-load-balancer-123456789.us-west-2.elb.amazonaws.com
```
**例 3: この例では、HTTP リスナーを持つロードバランサーを作成します。**
```
$httpsListener = New-Object Amazon.ElasticLoadBalancing.Model.Listener
$httpsListener.Protocol = "https"
$httpsListener.LoadBalancerPort = 443
$httpsListener.InstanceProtocol = "http"
$httpsListener.InstancePort = 80
$httpsListener.SSLCertificateId="arn:aws:iam::123456789012:server-certificate/my-server-cert"
New-ELBLoadBalancer -LoadBalancerName my-load-balancer -AvailabilityZone us-west-2a -Listener $httpsListener
my-load-balancer-123456789.us-west-2.elb.amazonaws.com
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-ELBLoadBalancerListener`
次のコード例は、`New-ELBLoadBalancerListener` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したロードバランサーに HTTPS リスナーを追加します。**
```
$httpsListener = New-Object Amazon.ElasticLoadBalancing.Model.Listener
$httpsListener.Protocol = "https"
$httpsListener.LoadBalancerPort = 443
$httpsListener.InstanceProtocol = "https"
$httpsListener.InstancePort = 443
$httpsListener.SSLCertificateId="arn:aws:iam::123456789012:server-certificate/my-server-cert"
New-ELBLoadBalancerListener -LoadBalancerName my-load-balancer -Listener $httpsListener
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateLoadBalancerListeners](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-ELBLoadBalancerPolicy`
次のコード例は、`New-ELBLoadBalancerPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーのプロキシプロトコルポリシーを作成します。**
```
$attribute = New-Object Amazon.ElasticLoadBalancing.Model.PolicyAttribute -Property @{
AttributeName="ProxyProtocol"
AttributeValue="True"
}
New-ELBLoadBalancerPolicy -LoadBalancerName my-load-balancer -PolicyName my-ProxyProtocol-policy -PolicyTypeName ProxyProtocolPolicyType -PolicyAttribute $attribute
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[CreateLoadBalancerPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Register-ELBInstanceWithLoadBalancer`
次のコード例は、`Register-ELBInstanceWithLoadBalancer` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された EC2 インスタンスを指定されたロードバランサーに登録します。**
```
Register-ELBInstanceWithLoadBalancer -LoadBalancerName my-load-balancer -Instance i-12345678
```
**出力:**
```
InstanceId
----------
i-12345678
i-87654321
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RegisterInstancesWithLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-ELBInstanceFromLoadBalancer`
次のコード例は、`Remove-ELBInstanceFromLoadBalancer` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーから指定された EC2 インスタンスを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-ELBInstanceFromLoadBalancer -LoadBalancerName my-load-balancer -Instance i-12345678
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ELBInstanceFromLoadBalancer (DeregisterInstancesFromLoadBalancer)" on Target
"Amazon.ElasticLoadBalancing.Model.Instance".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
InstanceId
----------
i-87654321
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)*の「[DeregisterInstancesFromLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-ELBLoadBalancer`
次のコード例は、`Remove-ELBLoadBalancer` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-ELBLoadBalancer -LoadBalancerName my-load-balancer
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ELBLoadBalancer (DeleteLoadBalancer)" on Target "my-load-balancer".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-ELBLoadBalancerListener`
次のコード例は、`Remove-ELBLoadBalancerListener` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーのポート 80 のリスナーを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-ELBLoadBalancerListener -LoadBalancerName my-load-balancer -LoadBalancerPort 80
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ELBLoadBalancerListener (DeleteLoadBalancerListeners)" on Target "80".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteLoadBalancerListeners](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-ELBLoadBalancerPolicy`
次のコード例は、`Remove-ELBLoadBalancerPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーから指定されたポリシーを削除します。Force パラメータも指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。**
```
Remove-ELBLoadBalancerPolicy -LoadBalancerName my-load-balancer -PolicyName my-duration-cookie-policy
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing operation "Remove-ELBLoadBalancerPolicy (DeleteLoadBalancerPolicy)" on Target "my-duration-cookie-policy".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DeleteLoadBalancerPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-ELBResourceTag`
次のコード例は、`Remove-ELBResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーから指定されたタグを削除します。Force パラメータを指定しない限り、操作を続行する前に確認を求めるプロンプトが表示されます。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
Remove-ELBResourceTag -LoadBalancerName my-load-balancer -Tag @{ Key="project" }
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ELBResourceTag (RemoveTags)" on target "Amazon.ElasticLoadBalancing.Model.TagKeyOnly".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
```
**例 2: PowerShell バージョン 2 では、New-Object を使用してタグパラメータのタグを作成する必要があります。**
```
$tag = New-Object Amazon.ElasticLoadBalancing.Model.TagKeyOnly
$tag.Key = "project"
Remove-ELBResourceTag -Tag $tag -Force
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[RemoveTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Set-ELBHealthCheck`
次のコード例は、`Set-ELBHealthCheck` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーのヘルスチェック設定を構成します。**
```
Set-ELBHealthCheck -LoadBalancerName my-load-balancer `
>> -HealthCheck_HealthyThreshold 2 `
>> -HealthCheck_UnhealthyThreshold 2 `
>> -HealthCheck_Target "HTTP:80/ping" `
>> -HealthCheck_Interval 30 `
>> -HealthCheck_Timeout 3
```
**出力:**
```
HealthyThreshold : 2
Interval : 30
Target : HTTP:80/ping
Timeout : 3
UnhealthyThreshold : 2
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ConfigureHealthCheck](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Set-ELBLoadBalancerListenerSSLCertificate`
次のコード例は、`Set-ELBLoadBalancerListenerSSLCertificate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリスナーの SSL 接続を終了する証明書を置き換えます。**
```
Set-ELBLoadBalancerListenerSSLCertificate -LoadBalancerName my-load-balancer `
>> -LoadBalancerPort 443 `
>> -SSLCertificateId "arn:aws:iam::123456789012:server-certificate/new-server-cert"
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* 「[SetLoadBalancerListenerSslCertificate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Set-ELBLoadBalancerPolicyForBackendServer`
次のコード例は、`Set-ELBLoadBalancerPolicyForBackendServer` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたポートのポリシーを指定されたポリシーに置き換えます。**
```
Set-ELBLoadBalancerPolicyForBackendServer -LoadBalancerName my-load-balancer -InstancePort 80 -PolicyName my-ProxyProtocol-policy
```
**例 2: この例では、指定されたポートに関連付けられているすべてのポリシーを削除します。**
```
Set-ELBLoadBalancerPolicyForBackendServer -LoadBalancerName my-load-balancer -InstancePort 80
```
+ API の詳細については、AWS Tools for PowerShell コマンドリファレンス (V5) の「[SetLoadBalancerPoliciesForBackendServer](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Set-ELBLoadBalancerPolicyOfListener`
次のコード例は、`Set-ELBLoadBalancerPolicyOfListener` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリスナーのポリシーを指定されたポリシーに置き換えます。**
```
Set-ELBLoadBalancerPolicyOfListener -LoadBalancerName my-load-balancer -LoadBalancerPort 443 -PolicyName my-SSLNegotiation-policy
```
**例 2: この例では、指定されたリスナーに関連付けられているすべてのポリシーを削除します。**
```
Set-ELBLoadBalancerPolicyOfListener -LoadBalancerName my-load-balancer -LoadBalancerPort 443
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[SetLoadBalancerPoliciesOfListener](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# Tools for PowerShell V5 を使用した Elastic Load Balancing - バージョン 2 の例
次のコード例は、Elastic Load Balancing - バージョン 2 で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-ELB2ListenerCertificate`
次のコード例は、`Add-ELB2ListenerCertificate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリスナーに証明書を追加します。**
```
Add-ELB2ListenerCertificate -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/3873f123b98f7618' -Certificate @{CertificateArn = 'arn:aws:acm:us-east-1:123456789012:certificate/19478bd5-491d-47d4-b1d7-5217feba1d97'}
```
**出力:**
```
CertificateArn IsDefault
-------------- ---------
arn:aws:acm:us-east-1:123456789012:certificate/19478bd5-491d-47d4-b1d7-5217feba1d97 False
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AddListenerCertificates](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Add-ELB2Tag`
次のコード例は、`Add-ELB2Tag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された `AWS.Tools.ElasticLoadBalancingV2` リソースに新しいタグを追加します。**
```
Add-ELB2Tag -ResourceArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f' -Tag @{Key = 'productVersion'; Value = '1.0.0'}
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[AddTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-ELB2Listener`
次のコード例は、`Edit-ELB2Listener` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリスナーのデフォルトアクションを固定レスポンスに変更します。**
```
$newDefaultAction = [Amazon.ElasticLoadBalancingV2.Model.Action]@{
"FixedResponseConfig" = @{
"ContentType" = "text/plain"
"MessageBody" = "Hello World"
"StatusCode" = "200"
}
"Type" = [Amazon.ElasticLoadBalancingV2.ActionTypeEnum]::FixedResponse
}
Edit-ELB2Listener -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/testALB/3e2f03b558e19676/d19f2f14974db685' -Port 8080 -DefaultAction $newDefaultAction
```
**出力:**
```
Certificates : {}
DefaultActions : {Amazon.ElasticLoadBalancingV2.Model.Action}
ListenerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/testALB/3e2f03b558e19676/d19f2f14974db685
LoadBalancerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/testALB/3e2f03b558e19676
Port : 8080
Protocol : HTTP
SslPolicy :
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifyListener](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-ELB2LoadBalancerAttribute`
次のコード例は、`Edit-ELB2LoadBalancerAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーの属性を変更します。**
```
Edit-ELB2LoadBalancerAttribute -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f' -Attribute @{Key = 'deletion_protection.enabled'; Value = 'true'}
```
**出力:**
```
Key Value
--- -----
deletion_protection.enabled true
access_logs.s3.enabled false
access_logs.s3.bucket
access_logs.s3.prefix
idle_timeout.timeout_seconds 60
routing.http2.enabled true
routing.http.drop_invalid_header_fields.enabled false
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifyLoadBalancerAttributes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-ELB2Rule`
次のコード例は、`Edit-ELB2Rule` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリスナールール設定を変更します。**
```
$newRuleCondition = [Amazon.ElasticLoadBalancingV2.Model.RuleCondition]@{
"PathPatternConfig" = @{
"Values" = "/login1","/login2","/login3"
}
"Field" = "path-pattern"
}
Edit-ELB2Rule -RuleArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/testALB/3e2f03b558e19676/1c84f02aec143e80/f4f51dfaa033a8cc' -Condition $newRuleCondition
```
**出力:**
```
Actions : {Amazon.ElasticLoadBalancingV2.Model.Action}
Conditions : {Amazon.ElasticLoadBalancingV2.Model.RuleCondition}
IsDefault : False
Priority : 10
RuleArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/testALB/3e2f03b558e19676/1c84f02aec143e80/f4f51dfaa033a8cc
```
+ API の詳細については、AWS Tools for PowerShell * コマンドレットリファレンス (V5)* の「[ModifyRule](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-ELB2TargetGroup`
次のコード例は、`Edit-ELB2TargetGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたターゲットグループのプロパティを変更します。**
```
Edit-ELB2TargetGroup -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970' -HealthCheckIntervalSecond 60 -HealthCheckPath '/index.html' -HealthCheckPort 8080
```
**出力:**
```
HealthCheckEnabled : True
HealthCheckIntervalSeconds : 60
HealthCheckPath : /index.html
HealthCheckPort : 8080
HealthCheckProtocol : HTTP
HealthCheckTimeoutSeconds : 5
HealthyThresholdCount : 5
LoadBalancerArns : {}
Matcher : Amazon.ElasticLoadBalancingV2.Model.Matcher
Port : 80
Protocol : HTTP
TargetGroupArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970
TargetGroupName : test-tg
TargetType : instance
UnhealthyThresholdCount : 2
VpcId : vpc-2cfd7000
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifyTargetGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-ELB2TargetGroupAttribute`
次のコード例は、`Edit-ELB2TargetGroupAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたターゲットグループの deregistration\$1delay 属性を変更します。**
```
Edit-ELB2TargetGroupAttribute -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970' -Attribute @{Key = 'deregistration_delay.timeout_seconds'; Value = 600}
```
**出力:**
```
Key Value
--- -----
stickiness.enabled false
deregistration_delay.timeout_seconds 600
stickiness.type lb_cookie
stickiness.lb_cookie.duration_seconds 86400
slow_start.duration_seconds 0
load_balancing.algorithm.type round_robin
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[ModifyTargetGroupAttributes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ELB2AccountLimit`
次のコード例は、`Get-ELB2AccountLimit` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、特定のリージョンの ELB2 アカウント制限を一覧表示します。**
```
Get-ELB2AccountLimit
```
**出力:**
```
Max Name
--- ----
3000 target-groups
1000 targets-per-application-load-balancer
50 listeners-per-application-load-balancer
100 rules-per-application-load-balancer
50 network-load-balancers
3000 targets-per-network-load-balancer
500 targets-per-availability-zone-per-network-load-balancer
50 listeners-per-network-load-balancer
5 condition-values-per-alb-rule
5 condition-wildcards-per-alb-rule
100 target-groups-per-application-load-balancer
5 target-groups-per-action-on-application-load-balancer
1 target-groups-per-action-on-network-load-balancer
50 application-load-balancers
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeAccountLimits](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ELB2Listener`
次のコード例は、`Get-ELB2Listener` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された ALB/NLB のリスナーを記述します。**
```
Get-ELB2Listener -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f'
```
**出力:**
```
Certificates : {}
DefaultActions : {Amazon.ElasticLoadBalancingV2.Model.Action}
ListenerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/1dac07c21187d41e
LoadBalancerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f
Port : 80
Protocol : HTTP
SslPolicy :
Certificates : {Amazon.ElasticLoadBalancingV2.Model.Certificate}
DefaultActions : {Amazon.ElasticLoadBalancingV2.Model.Action}
ListenerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b
LoadBalancerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f
Port : 443
Protocol : HTTPS
SslPolicy : ELBSecurityPolicy-2016-08
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeListeners](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ELB2ListenerCertificate`
次のコード例は、`Get-ELB2ListenerCertificate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリスナーの証明書を記述します。**
```
Get-ELB2ListenerCertificate -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b'
```
**出力:**
```
CertificateArn IsDefault
-------------- ---------
arn:aws:acm:us-east-1:123456789012:certificate/5fc7c092-68bf-4862-969c-22fd48b6e17c True
```
+ API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V5)* の「[DescribeListenerCertificates](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-ELB2LoadBalancer`
次のコード例は、`Get-ELB2LoadBalancer` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このサンプルは、指定されたリージョンのすべてのロードバランサーを表示します。**
```
Get-ELB2LoadBalancer
```
**出力:**
```
AvailabilityZones : {us-east-1c}
CanonicalHostedZoneId : Z26RNL4JYFTOTI
CreatedTime : 6/22/18 11:21:50 AM
DNSName : test-elb1234567890-238d34ad8d94bc2e.elb.us-east-1.amazonaws.com
IpAddressType : ipv4
LoadBalancerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/test-elb1234567890/238d34ad8d94bc2e
LoadBalancerName : test-elb1234567890
Scheme : internet-facing
SecurityGroups : {}
State : Amazon.ElasticLoadBalancingV2.Model.LoadBalancerState
Type : network
VpcId : vpc-2cf00000
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeLoadBalancers](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-ELB2LoadBalancerAttribute`
次のコード例は、`Get-ELB2LoadBalancerAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定されたロードバランサーの属性を記述します。**
```
Get-ELB2LoadBalancerAttribute -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/test-elb/238d34ad8d94bc2e'
```
**出力:**
```
Key Value
--- -----
access_logs.s3.enabled false
load_balancing.cross_zone.enabled true
access_logs.s3.prefix
deletion_protection.enabled false
access_logs.s3.bucket
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeLoadBalancerAttributes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-ELB2Rule`
次のコード例は、`Get-ELB2Rule` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリスナー ARN のリスナールールを記述します。**
```
Get-ELB2Rule -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b'
```
**出力:**
```
Actions : {Amazon.ElasticLoadBalancingV2.Model.Action}
Conditions : {Amazon.ElasticLoadBalancingV2.Model.RuleCondition}
IsDefault : False
Priority : 1
RuleArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b/2286fff5055e0f79
Actions : {Amazon.ElasticLoadBalancingV2.Model.Action}
Conditions : {Amazon.ElasticLoadBalancingV2.Model.RuleCondition}
IsDefault : False
Priority : 2
RuleArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b/14e7b036567623ba
Actions : {Amazon.ElasticLoadBalancingV2.Model.Action}
Conditions : {}
IsDefault : True
Priority : default
RuleArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b/853948cf3aa9b2bf
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeRules](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-ELB2SSLPolicy`
次のコード例は、`Get-ELB2SSLPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ElasticLoadBalancingV2 で使用可能なすべてのリスナーポリシーを一覧表示します。**
```
Get-ELB2SSLPolicy
```
**出力:**
```
Ciphers Name SslProtocols
------- ---- ------------
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-2016-08 {TLSv1, TLSv1.1, TLSv1.2}
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-TLS-1-2-2017-01 {TLSv1.2}
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-TLS-1-1-2017-01 {TLSv1.1, TLSv1.2}
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-TLS-1-2-Ext-2018-06 {TLSv1.2}
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-FS-2018-06 {TLSv1, TLSv1.1, TLSv1.2}
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-2015-05 {TLSv1, TLSv1.1, TLSv1.2}
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-TLS-1-0-2015-04 {TLSv1, TLSv1.1, TLSv1.2}
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-FS-1-2-Res-2019-08 {TLSv1.2}
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-FS-1-1-2019-08 {TLSv1.1, TLSv1.2}
{ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES128-SHA256, ECDHE-RSA-AES128-SHA256} ELBSecurityPolicy-FS-1-2-2019-08 {TLSv1.2}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeSslPolicies](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-ELB2Tag`
次のコード例は、`Get-ELB2Tag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリソースのタグを一覧表示します。**
```
Get-ELB2Tag -ResourceArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f'
```
**出力:**
```
ResourceArn Tags
----------- ----
arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f {stage, internalName, version}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-ELB2TargetGroup`
次のコード例は、`Get-ELB2TargetGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたターゲットグループを記述します。**
```
Get-ELB2TargetGroup -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970'
```
**出力:**
```
HealthCheckEnabled : True
HealthCheckIntervalSeconds : 30
HealthCheckPath : /
HealthCheckPort : traffic-port
HealthCheckProtocol : HTTP
HealthCheckTimeoutSeconds : 5
HealthyThresholdCount : 5
LoadBalancerArns : {arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f}
Matcher : Amazon.ElasticLoadBalancingV2.Model.Matcher
Port : 80
Protocol : HTTP
TargetGroupArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970
TargetGroupName : test-tg
TargetType : instance
UnhealthyThresholdCount : 2
VpcId : vpc-2cfd7000
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeTargetGroups](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-ELB2TargetGroupAttribute`
次のコード例は、`Get-ELB2TargetGroupAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたターゲットグループの属性を記述します。**
```
Get-ELB2TargetGroupAttribute -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970'
```
**出力:**
```
Key Value
--- -----
stickiness.enabled false
deregistration_delay.timeout_seconds 300
stickiness.type lb_cookie
stickiness.lb_cookie.duration_seconds 86400
slow_start.duration_seconds 0
load_balancing.algorithm.type round_robin
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeTargetGroupAttributes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-ELB2TargetHealth`
次のコード例は、`Get-ELB2TargetHealth` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたターゲットグループに存在するターゲットのヘルスステータスを返します。**
```
Get-ELB2TargetHealth -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970'
```
**出力:**
```
HealthCheckPort Target TargetHealth
--------------- ------ ------------
80 Amazon.ElasticLoadBalancingV2.Model.TargetDescription Amazon.ElasticLoadBalancingV2.Model.TargetHealth
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeTargetHealth](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-ELB2Listener`
次のコード例は、`New-ELB2Listener` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたターゲットグループにトラフィックを送信するデフォルトのアクション「Forward」を持つ新しい ALB リスナーを作成します。**
```
$defaultAction = [Amazon.ElasticLoadBalancingV2.Model.Action]@{
ForwardConfig = @{
TargetGroups = @(
@{ TargetGroupArn = "arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/testAlbTG/3d61c2f20aa5bccb" }
)
TargetGroupStickinessConfig = @{
DurationSeconds = 900
Enabled = $true
}
}
Type = "Forward"
}
New-ELB2Listener -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/testALB/3e2f03b558e19676' -Port 8001 -Protocol "HTTP" -DefaultAction $defaultAction
```
**出力:**
```
Certificates : {}
DefaultActions : {Amazon.ElasticLoadBalancingV2.Model.Action}
ListenerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/testALB/3e2f03b558e19676/1c84f02aec143e80
LoadBalancerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/testALB/3e2f03b558e19676
Port : 8001
Protocol : HTTP
SslPolicy :
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateListener](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-ELB2LoadBalancer`
次のコード例は、`New-ELB2LoadBalancer` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、2 つのサブネットを持つインターネット向けの新しい Application Load Balancer を作成します。**
```
New-ELB2LoadBalancer -Type application -Scheme internet-facing -IpAddressType ipv4 -Name 'New-Test-ALB' -SecurityGroup 'sg-07c3414abb8811cbd' -subnet 'subnet-c37a67a6','subnet-fc02eea0'
```
**出力:**
```
AvailabilityZones : {us-east-1b, us-east-1a}
CanonicalHostedZoneId : Z35SXDOTRQ7X7K
CreatedTime : 12/28/19 2:58:03 PM
DNSName : New-Test-ALB-1391502222.us-east-1.elb.amazonaws.com
IpAddressType : ipv4
LoadBalancerArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/New-Test-ALB/dab2e4d90eb51493
LoadBalancerName : New-Test-ALB
Scheme : internet-facing
SecurityGroups : {sg-07c3414abb8811cbd}
State : Amazon.ElasticLoadBalancingV2.Model.LoadBalancerState
Type : application
VpcId : vpc-2cfd7000
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-ELB2Rule`
次のコード例は、`New-ELB2Rule` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリスナーに対し、顧客ヘッダー値に基づいた固定レスポンスアクションを持つ新しいリスナールールを作成します。**
```
$newRuleAction = [Amazon.ElasticLoadBalancingV2.Model.Action]@{
"FixedResponseConfig" = @{
"ContentType" = "text/plain"
"MessageBody" = "Hello World"
"StatusCode" = "200"
}
"Type" = [Amazon.ElasticLoadBalancingV2.ActionTypeEnum]::FixedResponse
}
$newRuleCondition = [Amazon.ElasticLoadBalancingV2.Model.RuleCondition]@{
"httpHeaderConfig" = @{
"HttpHeaderName" = "customHeader"
"Values" = "header2","header1"
}
"Field" = "http-header"
}
New-ELB2Rule -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/testALB/3e2f03b558e19676/1c84f02aec143e80' -Action $newRuleAction -Condition $newRuleCondition -Priority 10
```
**出力:**
```
Actions : {Amazon.ElasticLoadBalancingV2.Model.Action}
Conditions : {Amazon.ElasticLoadBalancingV2.Model.RuleCondition}
IsDefault : False
Priority : 10
RuleArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/testALB/3e2f03b558e19676/1c84f02aec143e80/f4f51dfaa033a8cc
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateRule](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-ELB2TargetGroup`
次のコード例は、`New-ELB2TargetGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたパラメータを使用して新しいターゲットグループを作成します。**
```
New-ELB2TargetGroup -HealthCheckEnabled 1 -HealthCheckIntervalSeconds 30 -HealthCheckPath '/index.html' -HealthCheckPort 80 -HealthCheckTimeoutSecond 5 -HealthyThresholdCount 2 -UnhealthyThresholdCount 5 -Port 80 -Protocol 'HTTP' -TargetType instance -VpcId 'vpc-2cfd7000' -Name 'NewTargetGroup'
```
**出力:**
```
HealthCheckEnabled : True
HealthCheckIntervalSeconds : 30
HealthCheckPath : /index.html
HealthCheckPort : 80
HealthCheckProtocol : HTTP
HealthCheckTimeoutSeconds : 5
HealthyThresholdCount : 2
LoadBalancerArns : {}
Matcher : Amazon.ElasticLoadBalancingV2.Model.Matcher
Port : 80
Protocol : HTTP
TargetGroupArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/NewTargetGroup/534e484681d801bf
TargetGroupName : NewTargetGroup
TargetType : instance
UnhealthyThresholdCount : 5
VpcId : vpc-2cfd7000
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateTargetGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Register-ELB2Target`
次のコード例は、`Register-ELB2Target` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、「i-0672a4c4cdeae3111」インスタンスを指定されたターゲットグループに登録します。**
```
Register-ELB2Target -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970' -Target @{Port = 80; Id = 'i-0672a4c4cdeae3111'}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[RegisterTargets](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-ELB2Listener`
次のコード例は、`Remove-ELB2Listener` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリスナーを削除します。**
```
Remove-ELB2Listener -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b'
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ELB2Listener (DeleteListener)" on target "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/66e10e3aaf5b6d9b".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y
```
**例 2: この例では、ロードバランサーから指定されたリスナーを削除します。**
```
Remove-ELB2Listener -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/3873f123b98f7618'
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ELB2Listener (DeleteListener)" on target "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/3873f123b98f7618".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteListener](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-ELB2ListenerCertificate`
次のコード例は、`Remove-ELB2ListenerCertificate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したターゲットグループから指定した証明書を削除します。**
```
Remove-ELB2ListenerCertificate -Certificate @{CertificateArn = 'arn:aws:acm:us-east-1:123456789012:certificate/19478bd5-491d-47d4-b1d7-5217feba1d97'} -ListenerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/3873f123b98f7618'
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ELB2ListenerCertificate (RemoveListenerCertificates)" on target "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/test-alb/3651b4394dd9a24f/3873f123b98f7618".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[RemoveListenerCertificates](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-ELB2LoadBalancer`
次のコード例は、`Remove-ELB2LoadBalancer` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーを削除します。**
```
Remove-ELB2LoadBalancer -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f'
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ELB2LoadBalancer (DeleteLoadBalancer)" on target "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteLoadBalancer](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-ELB2Rule`
次のコード例は、`Remove-ELB2Rule` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、リスナーから指定されたルールを削除します。**
```
Remove-ELB2Rule -RuleArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/test-alb/3651b4394dd9a24f/3873f123b98f7618/4b25eb10a42e33ab'
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ELB2Rule (DeleteRule)" on target "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/test-alb/3651b4394dd9a24f/3873f123b98f7618/4b25eb10a42e33ab".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteRule](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-ELB2Tag`
次のコード例は、`Remove-ELB2Tag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたキーのタグを削除します。**
```
Remove-ELB2Tag -ResourceArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f' -TagKey 'productVersion'
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ELB2Tag (RemoveTags)" on target "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[RemoveTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-ELB2TargetGroup`
次のコード例は、`Remove-ELB2TargetGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたターゲットグループを削除します。**
```
Remove-ELB2TargetGroup -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/testsssss/4e0b6076bc6483a7'
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-ELB2TargetGroup (DeleteTargetGroup)" on target "arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/testsssss/4e0b6076bc6483a7".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteTargetGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Set-ELB2IpAddressType`
次のコード例は、`Set-ELB2IpAddressType` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ロードバランサーの IP アドレスタイプを「IPv4」から「DualStack」に変更します。**
```
Set-ELB2IpAddressType -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f' -IpAddressType dualstack
```
**出力:**
```
Value
-----
dualstack
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[SetIpAddressType](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Set-ELB2RulePriority`
次のコード例は、`Set-ELB2RulePriority` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリスナールールの優先度を変更します。**
```
Set-ELB2RulePriority -RulePriority -RulePriority @{Priority = 11; RuleArn = 'arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/test-alb/3651b4394dd9a24f/a4eb199fa5046f80/dbf4c6dcef3ec6f8'}
```
**出力:**
```
Actions : {Amazon.ElasticLoadBalancingV2.Model.Action}
Conditions : {Amazon.ElasticLoadBalancingV2.Model.RuleCondition}
IsDefault : False
Priority : 11
RuleArn : arn:aws:elasticloadbalancing:us-east-1:123456789012:listener-rule/app/test-alb/3651b4394dd9a24f/a4eb199fa5046f80/dbf4c6dcef3ec6f8
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[SetRulePriorities](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Set-ELB2SecurityGroup`
次のコード例は、`Set-ELB2SecurityGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、セキュリティグループ「sg-07c3414abb8811cbd」を指定されたロードバランサーに追加します。**
```
Set-ELB2SecurityGroup -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f' -SecurityGroup 'sg-07c3414abb8811cbd'
```
**出力:**
```
sg-07c3414abb8811cbd
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[SetSecurityGroups](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Set-ELB2Subnet`
次のコード例は、`Set-ELB2Subnet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたロードバランサーのサブネットを変更します。**
```
Set-ELB2Subnet -LoadBalancerArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/test-alb/3651b4394dd9a24f' -Subnet 'subnet-7d8a0a51','subnet-c37a67a6'
```
**出力:**
```
LoadBalancerAddresses SubnetId ZoneName
--------------------- -------- --------
{} subnet-7d8a0a51 us-east-1c
{} subnet-c37a67a6 us-east-1b
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[SetSubnets](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Unregister-ELB2Target`
次のコード例は、`Unregister-ELB2Target` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インスタンス「i-0672a4c4cdeae3111」を指定されたターゲットグループから登録解除します。**
```
$targetDescription = New-Object Amazon.ElasticLoadBalancingV2.Model.TargetDescription
$targetDescription.Id = 'i-0672a4c4cdeae3111'
Unregister-ELB2Target -Target $targetDescription -TargetGroupArn 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/test-tg/a4e04b3688be1970'
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeregisterTargets](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用した Amazon FSx の例
次のコード例は、Amazon FSx で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-FSXResourceTag`
次のコード例は、`Add-FSXResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定リソースにタグを追加します。**
```
Add-FSXResourceTag -ResourceARN "arn:aws:fsx:eu-west-1:123456789012:file-system/fs-01cd23bc4bdf5678a" -Tag @{Key="Users";Value="Test"}
```
**出力:**
```
arn:aws:fsx:eu-west-1:123456789012:file-system/fs-01cd23bc4bdf5678a
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[TagResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-FSXBackup`
次のコード例は、`Get-FSXBackup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定ファイルシステム ID に対して昨日以降に作成されたバックアップを取得します。**
```
Get-FSXBackup -Filter @{Name="file-system-id";Values=$fsx.FileSystemId} | Where-Object CreationTime -gt (Get-Date).AddDays(-1)
```
**出力:**
```
BackupId : backup-01dac234e56782bcc
CreationTime : 6/14/2019 3:35:14 AM
FailureDetails :
FileSystem : Amazon.FSx.Model.FileSystem
KmsKeyId : arn:aws:kms:eu-west-1:123456789012:key/f1af23c4-1b23-1bde-a1f1-e1234c5af123
Lifecycle : AVAILABLE
ProgressPercent : 100
ResourceARN : arn:aws:fsx:eu-west-1:123456789012:backup/backup-01dac234e56782bcc
Tags : {}
Type : AUTOMATIC
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeBackups](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-FSXFileSystem`
次のコード例は、`Get-FSXFileSystem` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定の filesystemId の説明を返します。**
```
Get-FSXFileSystem -FileSystemId fs-01cd23bc4bdf5678a
```
**出力:**
```
CreationTime : 1/17/2019 9:55:30 AM
DNSName : fs-01cd23bc4bdf5678a.ktmsad.local
FailureDetails :
FileSystemId : fs-01cd23bc4bdf5678a
FileSystemType : WINDOWS
KmsKeyId : arn:aws:kms:eu-west-1:123456789012:key/f1af23c4-5b67-8bde-a9f0-e1234c5af678
Lifecycle : AVAILABLE
LustreConfiguration :
NetworkInterfaceIds : {eni-07d1dda1322b7e209}
OwnerId : 123456789012
ResourceARN : arn:aws:fsx:eu-west-1:123456789012:file-system/fs-01cd23bc4bdf5678a
StorageCapacity : 300
SubnetIds : {subnet-7d123456}
Tags : {FSx-Service}
VpcId : vpc-41cf2b3f
WindowsConfiguration : Amazon.FSx.Model.WindowsFileSystemConfiguration
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeFileSystems](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-FSXResourceTagList`
次のコード例は、`Get-FSXResourceTagList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定リソース ARN のタグを一覧表示します。**
```
Get-FSXResourceTagList -ResourceARN $fsx.ResourceARN
```
**出力:**
```
Key Value
--- -----
FSx-Service Windows
Users Dev
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-FSXBackup`
次のコード例は、`New-FSXBackup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定ファイルシステムのバックアップを作成します。**
```
New-FSXBackup -FileSystemId fs-0b1fac2345623456ba
```
**出力:**
```
BackupId : backup-0b1fac2345623456ba
CreationTime : 6/14/2019 5:37:17 PM
FailureDetails :
FileSystem : Amazon.FSx.Model.FileSystem
KmsKeyId : arn:aws:kms:eu-west-1:123456789012:key/f1af23c4-1b23-1bde-a1f3-e1234c5af678
Lifecycle : CREATING
ProgressPercent : 0
ResourceARN : arn:aws:fsx:eu-west-1:123456789012:backup/backup-0b1fac2345623456ba
Tags : {}
Type : USER_INITIATED
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateBackup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-FSXFileSystem`
次のコード例は、`New-FSXFileSystem` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定サブネットからのアクセスを許可し、1 秒あたり最大 8 メガバイトのスループットをサポートする新しい 300GB のWindows ファイルシステムを作成します。新しいファイルシステムは、指定の Microsoft Active Directory に自動的に結合されます。**
```
New-FSXFileSystem -FileSystemType WINDOWS -StorageCapacity 300 -SubnetId subnet-1a2b3c4d5e6f -WindowsConfiguration @{ThroughputCapacity=8;ActiveDirectoryId='d-1a2b3c4d'}
```
**出力:**
```
CreationTime : 12/10/2018 6:06:59 PM
DNSName : fs-abcdef01234567890.example.com
FailureDetails :
FileSystemId : fs-abcdef01234567890
FileSystemType : WINDOWS
KmsKeyId : arn:aws:kms:us-west-2:123456789012:key/a1234567-252c-45e9-afaa-123456789abc
Lifecycle : CREATING
LustreConfiguration :
NetworkInterfaceIds : {}
OwnerId : 123456789012
ResourceARN : arn:aws:fsx:us-west-2:123456789012:file-system/fs-abcdef01234567890
StorageCapacity : 300
SubnetIds : {subnet-1a2b3c4d5e6f}
Tags : {}
VpcId : vpc-1a2b3c4d5e6f
WindowsConfiguration : Amazon.FSx.Model.WindowsFileSystemConfiguration
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateFileSystem](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-FSXFileSystemFromBackup`
次のコード例は、`New-FSXFileSystemFromBackup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、既存の Amazon FSx for Windows File Server バックアップから新しい Amazon FSx ファイルシステムを作成します。**
```
New-FSXFileSystemFromBackup -BackupId $backupID -Tag @{Key="tag:Name";Value="from-manual-backup"} -SubnetId $SubnetID -SecurityGroupId $SG_ID -WindowsConfiguration @{ThroughputCapacity=8;ActiveDirectoryId=$DirectoryID}
```
**出力:**
```
CreationTime : 8/8/2019 12:59:58 PM
DNSName : fs-012ff34e56789120.ktmsad.local
FailureDetails :
FileSystemId : fs-012ff34e56789120
FileSystemType : WINDOWS
KmsKeyId : arn:aws:kms:eu-west-1:123456789012:key/f1af23c4-5b67-1bde-a2f3-e4567c8a9321
Lifecycle : CREATING
LustreConfiguration :
NetworkInterfaceIds : {}
OwnerId : 933303704102
ResourceARN : arn:aws:fsx:eu-west-1:123456789012:file-system/fs-012ff34e56789120
StorageCapacity : 300
SubnetIds : {subnet-fa1ae23c}
Tags : {tag:Name}
VpcId : vpc-12cf3b4f
WindowsConfiguration : Amazon.FSx.Model.WindowsFileSystemConfiguration
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateFileSystemFromBackup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-FSXBackup`
次のコード例は、`Remove-FSXBackup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定 backup-id を削除します。**
```
Remove-FSXBackup -BackupId $backupID
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-FSXBackup (DeleteBackup)" on target "backup-0bbca1e2345678e12".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
BackupId Lifecycle
-------- ---------
backup-0bbca1e2345678e12 DELETED
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteBackup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-FSXFileSystem`
次のコード例は、`Remove-FSXFileSystem` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定 FSX ファイルシステム ID を削除します。**
```
Remove-FSXFileSystem -FileSystemId fs-012ff34e567890120
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-FSXFileSystem (DeleteFileSystem)" on target "fs-012ff34e567890120".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
FileSystemId Lifecycle WindowsResponse
------------ --------- ---------------
fs-012ff34e567890120 DELETING Amazon.FSx.Model.DeleteFileSystemWindowsResponse
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteFileSystem](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-FSXResourceTag`
次のコード例は、`Remove-FSXResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定 FSX ファイルシステムリソース ARN のリソースタグを削除します。**
```
Remove-FSXResourceTag -ResourceARN $FSX.ResourceARN -TagKey Users
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-FSXResourceTag (UntagResource)" on target "arn:aws:fsx:eu-west-1:933303704102:file-system/fs-07cd45bc6bdf2674a".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UntagResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-FSXFileSystem`
次のコード例は、`Update-FSXFileSystem` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、UpdateFileSystemWindowsConfiguration を介して FSX ファイルシステムの自動バックアップ保持日数を更新します。**
```
$UpdateFSXWinConfig = [Amazon.FSx.Model.UpdateFileSystemWindowsConfiguration]::new()
$UpdateFSXWinConfig.AutomaticBackupRetentionDays = 35
Update-FSXFileSystem -FileSystemId $FSX.FileSystemId -WindowsConfiguration $UpdateFSXWinConfig
```
**出力:**
```
CreationTime : 1/17/2019 9:55:30 AM
DNSName : fs-01cd23bc4bdf5678a.ktmsad.local
FailureDetails :
FileSystemId : fs-01cd23bc4bdf5678a
FileSystemType : WINDOWS
KmsKeyId : arn:aws:kms:eu-west-1:123456789012:key/f1af23c4-1b23-1bde-a1f2-e1234c5af678
Lifecycle : AVAILABLE
LustreConfiguration :
NetworkInterfaceIds : {eni-01cd23bc4bdf5678a}
OwnerId : 933303704102
ResourceARN : arn:aws:fsx:eu-west-1:933303704102:file-system/fs-07cd45bc6bdf2674a
StorageCapacity : 300
SubnetIds : {subnet-1d234567}
Tags : {FSx-Service}
VpcId : vpc-23cf4b5f
WindowsConfiguration : Amazon.FSx.Model.WindowsFileSystemConfiguration
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateFileSystem](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用した Amazon Glacier の例
次のコード例は、Amazon Glacier で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Get-GLCJob`
次のコード例は、`Get-GLCJob` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定したジョブの詳細を返します。ジョブが正常に完了したら、Read-GCJobOutput コマンドレットを使用して、ジョブの内容 (アーカイブまたはインベントリのリスト) をローカルファイルシステムに取得できます。**
```
Get-GLCJob -VaultName myvault -JobId "op1x...JSbthM"
```
**出力:**
```
Action : ArchiveRetrieval
ArchiveId : o9O9j...X-TpIhQJw
ArchiveSHA256TreeHash : 79f3ea754c02f58...dc57bf4395b
ArchiveSizeInBytes : 38034480
Completed : False
CompletionDate : 1/1/0001 12:00:00 AM
CreationDate : 12/13/2018 11:00:14 AM
InventoryRetrievalParameters :
InventorySizeInBytes : 0
JobDescription :
JobId : op1x...JSbthM
JobOutputPath :
OutputLocation :
RetrievalByteRange : 0-38034479
SelectParameters :
SHA256TreeHash : 79f3ea754c02f58...dc57bf4395b
SNSTopic :
StatusCode : InProgress
StatusMessage :
Tier : Standard
VaultARN : arn:aws:glacier:us-west-2:012345678912:vaults/test
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeJob](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-GLCVault`
次のコード例は、`New-GLCVault` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: ユーザーアカウント用に新しいボールトを作成します。-AccountId パラメータに値が指定されていないため、コマンドレットは現在のアカウントを示すデフォルトの「-」を使用します。**
```
New-GLCVault -VaultName myvault
```
**出力:**
```
/01234567812/vaults/myvault
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateVault](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Read-GLCJobOutput`
次のコード例は、`Read-GLCJobOutput` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定したジョブで取得がスケジュールされているアーカイブコンテンツをダウンロードし、コンテンツをディスク上のファイルに保存します。ダウンロード時に、チェックサムがある場合は自動的に検証されます。必要に応じて `-Select '*'` を指定すると、チェックサムを含むレスポンス全体を返すことができます。**
```
Read-GLCJobOutput -VaultName myvault -JobId "HSWjArc...Zq2XLiW" -FilePath "c:\temp\blue.bin"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetJobOutput](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Start-GLCJob`
次のコード例は、`Start-GLCJob` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定したユーザー所有のボールトからアーカイブを取得するジョブを開始します。ジョブのステータスは、Get-GLCJob コマンドレットを使用して確認できます。ジョブが正常に完了したら、Read-GCJobOutput コマンドレットを使用して、アーカイブの内容をローカルファイルシステムに取得できます。**
```
Start-GLCJob -VaultName myvault -JobType "archive-retrieval" -JobDescription "archive retrieval" -ArchiveId "o9O9j...TX-TpIhQJw"
```
**出力:**
```
JobId JobOutputPath Location
----- ------------- --------
op1x...JSbthM /012345678912/vaults/test/jobs/op1xe...I4HqCHkSJSbthM
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[InitiateJob](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Write-GLCArchive`
次のコード例は、`Write-GLCArchive` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定したボールトに単一のファイルをアップロードし、アーカイブ ID と計算されたチェックサムを返します。**
```
Write-GLCArchive -VaultName myvault -FilePath c:\temp\blue.bin
```
**出力:**
```
FilePath ArchiveId Checksum
-------- --------- --------
C:\temp\blue.bin o9O9jUUs...TTX-TpIhQJw 79f3e...f4395b
```
**例 2: フォルダ階層の内容を、ユーザーアカウント内の指定したボールトにアップロードします。アップロードされたファイルごとに、コマンドレットはファイル名、対応するアーカイブ ID、アーカイブの計算されたチェックサムを出力します。**
```
Write-GLCArchive -VaultName myvault -FolderPath . -Recurse
```
**出力:**
```
FilePath ArchiveId Checksum
-------- --------- --------
C:\temp\blue.bin o9O9jUUs...TTX-TpIhQJw 79f3e...f4395b
C:\temp\green.bin qXAfOdSG...czo729UHXrw d50a1...9184b9
C:\temp\lum.bin 39aNifP3...q9nb8nZkFIg 28886...5c3e27
C:\temp\red.bin vp7E6rU_...Ejk_HhjAxKA e05f7...4e34f5
C:\temp\Folder1\file1.txt _eRINlip...5Sxy7dD2BaA d0d2a...c8a3ba
C:\temp\Folder2\file2.iso -Ix3jlmu...iXiDh-XfOPA 7469e...3e86f1
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[UploadArchive](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# AWS Glue Tools for PowerShell V5 を使用した の例
次のコード例は、 で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています AWS Glue。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `New-GLUEJob`
次のコード例は、`New-GLUEJob` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 Glue AWS で新しいジョブを作成します。コマンド名の値は常に です`glueetl`。 AWS Glue は Python または Scala で記述されたジョブスクリプトの実行をサポートしています。この例では、ジョブスクリプト (MyTestGlueJob.py) は Python で記述されています。Python パラメータは `$DefArgs` 変数で指定され、ハッシュテーブルを受け入れる `DefaultArguments` パラメータで PowerShell コマンドに渡されます。`$JobParams`変数のパラメータは、 Glue API リファレンスのジョブ (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html) トピックに記載されている CreateJob API AWS から取得されます。**
```
$Command = New-Object Amazon.Glue.Model.JobCommand
$Command.Name = 'glueetl'
$Command.ScriptLocation = 's3://amzn-s3-demo-source-bucket/admin/MyTestGlueJob.py'
$Command
$Source = "source_test_table"
$Target = "target_test_table"
$Connections = $Source, $Target
$DefArgs = @{
'--TempDir' = 's3://amzn-s3-demo-bucket/admin'
'--job-bookmark-option' = 'job-bookmark-disable'
'--job-language' = 'python'
}
$DefArgs
$ExecutionProp = New-Object Amazon.Glue.Model.ExecutionProperty
$ExecutionProp.MaxConcurrentRuns = 1
$ExecutionProp
$JobParams = @{
"AllocatedCapacity" = "5"
"Command" = $Command
"Connections_Connection" = $Connections
"DefaultArguments" = $DefArgs
"Description" = "This is a test"
"ExecutionProperty" = $ExecutionProp
"MaxRetries" = "1"
"Name" = "MyOregonTestGlueJob"
"Role" = "Amazon-GlueServiceRoleForSSM"
"Timeout" = "20"
}
New-GlueJob @JobParams
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateJob](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# AWS Health Tools for PowerShell V5 を使用した の例
次のコード例は、 で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています AWS Health。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Get-HLTHEvent`
次のコード例は、`Get-HLTHEvent` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは AWS Personal Health Dashboard からイベントを返します。ユーザーは -Region パラメータを追加して、米国東部 (バージニア北部) リージョンでサービスに対して使用可能なイベントを表示しますが、-Filter\$1Region パラメータは、欧州 (ロンドン) および米国西部 (オレゴン) リージョン (eu-west-2 および us-west-2) でログされたイベントをフィルタリングします。-Filter\$1StartTime パラメータはイベントが開始できる時間の範囲をフィルタリングし、-Filter\$1EndTime パラメータはイベントが終了する時間の範囲をフィルタリングします。その結果、指定された -Filter\$1StartTime 範囲内で開始し、スケジュールされた -Filter\$1EndTime 範囲内で終了する RDS の定期メンテナンスイベントが表示されます。**
```
Get-HLTHEvent -Region us-east-1 -Filter_Region "eu-west-2","us-west-2" -Filter_StartTime @{from="3/14/2019 6:30:00AM";to="3/15/2019 5:00:00PM"} -Filter_EndTime @{from="3/21/2019 7:00:00AM";to="3/21/2019 5:00:00PM"}
```
**出力:**
```
Arn : arn:aws:health:us-west-2::event/RDS/AWS_RDS_HARDWARE_MAINTENANCE_SCHEDULED/AWS_RDS_HARDWARE_MAINTENANCE_SCHEDULED_USW2_20190314_20190321
AvailabilityZone :
EndTime : 3/21/2019 2:00:00 PM
EventTypeCategory : scheduledChange
EventTypeCode : AWS_RDS_HARDWARE_MAINTENANCE_SCHEDULED
LastUpdatedTime : 2/28/2019 2:26:07 PM
Region : us-west-2
Service : RDS
StartTime : 3/14/2019 2:00:00 PM
StatusCode : open
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeEvents](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用した IAM の例
次のコード例は、IAM で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-IAMClientIDToOpenIDConnectProvider`
次のコード例は、`Add-IAMClientIDToOpenIDConnectProvider` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、クライアント ID (または対象者) `my-application-ID` を `server.example.com` という名前の既存の OIDC プロバイダーに追加します。**
```
Add-IAMClientIDToOpenIDConnectProvider -ClientID "my-application-ID" -OpenIDConnectProviderARN "arn:aws:iam::123456789012:oidc-provider/server.example.com"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[AddClientIdToOpenIdConnectProvider](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Add-IAMRoleTag`
次のコード例は、`Add-IAMRoleTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ID 管理サービスのロールにタグを追加します。**
```
Add-IAMRoleTag -RoleName AdminRoleacess -Tag @{ Key = 'abac'; Value = 'testing'}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[TagRole](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Add-IAMRoleToInstanceProfile`
次のコード例は、`Add-IAMRoleToInstanceProfile` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、`S3Access` という名前のロールを `webserver` という名前の既存のインスタンスプロファイルに追加します。インスタンスプロファイルを作成するには、`New-IAMInstanceProfile` コマンドを使用します。このコマンドを使用してインスタンスプロファイルを作成し、ロールに関連付けると、EC2 インスタンスにアタッチできます。そのためには、`New-EC2Instance` コマンドレットを `InstanceProfile_Arn` または `InstanceProfile-Name` パラメータと共に使用して、新しいインスタンスを起動します。**
```
Add-IAMRoleToInstanceProfile -RoleName "S3Access" -InstanceProfileName "webserver"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[AddRoleToInstanceProfile](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Add-IAMUserTag`
次のコード例は、`Add-IAMUserTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ID 管理サービスのユーザーにタグを追加します。**
```
Add-IAMUserTag -UserName joe -Tag @{ Key = 'abac'; Value = 'testing'}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[TagUser](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Add-IAMUserToGroup`
次のコード例は、`Add-IAMUserToGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、`Bob` という名前のユーザーを `Admins` という名前のグループに追加します。**
```
Add-IAMUserToGroup -UserName "Bob" -GroupName "Admins"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[AddUserToGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Disable-IAMMFADevice`
次のコード例は、`Disable-IAMMFADevice` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、シリアル番号 `123456789012` を持つユーザー `Bob` に関連付けられているハードウェア MFA デバイスを無効にします。**
```
Disable-IAMMFADevice -UserName "Bob" -SerialNumber "123456789012"
```
**例 2: このコマンドは、ARN `arn:aws:iam::210987654321:mfa/David` を持つユーザー `David` に関連付けられている仮想 MFA デバイスを無効にします。仮想 MFA デバイスはアカウントから削除されないことに注意してください。仮想デバイスはまだ存在し、`Get-IAMVirtualMFADevice` コマンドの出力に表示されます。同じユーザーに対して新しい仮想 MFA デバイスを作成する前に、`Remove-IAMVirtualMFADevice` コマンドを使用して、古い仮想 MFA デバイスを削除する必要があります。**
```
Disable-IAMMFADevice -UserName "David" -SerialNumber "arn:aws:iam::210987654321:mfa/David"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeactivateMfaDevice](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Edit-IAMPassword`
次のコード例は、`Edit-IAMPassword` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、コマンドを実行しているユーザーのパスワードを変更します。このコマンドは、IAM ユーザーのみが呼び出すことができます。 AWS アカウント (ルート) 認証情報でサインインしたときにこのコマンドが呼び出された場合、コマンドは`InvalidUserType`エラーを返します。**
```
Edit-IAMPassword -OldPassword "MyOldP@ssw0rd" -NewPassword "MyNewP@ssw0rd"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ChangePassword](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Enable-IAMMFADevice`
次のコード例は、`Enable-IAMMFADevice` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、シリアル番号 `987654321098` を持つハードウェア MFA デバイスを有効にし、このデバイスをユーザー `Bob` に関連付けます。また、このコマンドは、デバイスからの最初の 2 つのコードを順番に含めます。**
```
Enable-IAMMFADevice -UserName "Bob" -SerialNumber "987654321098" -AuthenticationCode1 "12345678" -AuthenticationCode2 "87654321"
```
**例 2: この例では、仮想 MFA デバイスを作成して有効にします。最初のコマンドは仮想デバイスを作成し、そのデバイスのオブジェクト表現を変数 `$MFADevice` に返します。`.Base32StringSeed` または `QRCodePng` プロパティを使用して、ユーザーのソフトウェアアプリケーションを設定できます。最後のコマンドはデバイスをユーザー `David` に割り当て、デバイスをシリアル番号で識別します。コマンドは、仮想 MFA デバイスからの最初の 2 つのコードを順番に含める AWS ことで、デバイスを と同期します。**
```
$MFADevice = New-IAMVirtualMFADevice -VirtualMFADeviceName "MyMFADevice"
# see example for New-IAMVirtualMFADevice to see how to configure the software program with PNG or base32 seed code
Enable-IAMMFADevice -UserName "David" -SerialNumber -SerialNumber $MFADevice.SerialNumber -AuthenticationCode1 "24681357" -AuthenticationCode2 "13572468"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[EnableMfaDevice](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMAccessKey`
次のコード例は、`Get-IAMAccessKey` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、`Bob` という名前の IAM ユーザーのアクセスキーを一覧表示します。IAM ユーザーのシークレットアクセスキーを一覧表示できないことに注意してください。シークレットアクセスキーを紛失した場合は、`New-IAMAccessKey` コマンドレットを使用して新しいアクセスキーを作成する必要があります。**
```
Get-IAMAccessKey -UserName "Bob"
```
**出力:**
```
AccessKeyId CreateDate Status UserName
----------- ---------- ------ --------
AKIAIOSFODNN7EXAMPLE 12/3/2014 10:53:41 AM Active Bob
AKIAI44QH8DHBEXAMPLE 6/6/2013 8:42:26 PM Inactive Bob
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListAccessKeys](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMAccessKeyLastUsed`
次のコード例は、`Get-IAMAccessKeyLastUsed` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたアクセスキーの所有ユーザー名と最終使用情報を返します。**
```
Get-IAMAccessKeyLastUsed -AccessKeyId ABCDEXAMPLE
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetAccessKeyLastUsed](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMAccountAlias`
次のコード例は、`Get-IAMAccountAlias` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、 AWS アカウントのアカウントエイリアスを返します。**
```
Get-IAMAccountAlias
```
**出力:**
```
ExampleCo
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListAccountAliases](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMAccountAuthorizationDetail`
次のコード例は、`Get-IAMAccountAuthorizationDetail` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 AWS アカウント内の ID に関する認可の詳細を取得し、返されたオブジェクトの要素リスト (ユーザー、グループ、ロールを含む) を表示します。例えば、`UserDetailList` プロパティには、ユーザーに関する詳細が表示されます。同様の情報は、`RoleDetailList` および `GroupDetailList` プロパティで入手可能です。**
```
$Details=Get-IAMAccountAuthorizationDetail
$Details
```
**出力:**
```
GroupDetailList : {Administrators, Developers, Testers, Backup}
IsTruncated : False
Marker :
RoleDetailList : {TestRole1, AdminRole, TesterRole, clirole...}
UserDetailList : {Administrator, Bob, BackupToS3, }
```
```
$Details.UserDetailList
```
**出力:**
```
Arn : arn:aws:iam::123456789012:user/Administrator
CreateDate : 10/16/2014 9:03:09 AM
GroupList : {Administrators}
Path : /
UserId : AIDACKCEVSQ6CEXAMPLE1
UserName : Administrator
UserPolicyList : {}
Arn : arn:aws:iam::123456789012:user/Bob
CreateDate : 4/6/2015 12:54:42 PM
GroupList : {Developers}
Path : /
UserId : AIDACKCEVSQ6CEXAMPLE2
UserName : bab
UserPolicyList : {}
Arn : arn:aws:iam::123456789012:user/BackupToS3
CreateDate : 1/27/2015 10:15:08 AM
GroupList : {Backup}
Path : /
UserId : AIDACKCEVSQ6CEXAMPLE3
UserName : BackupToS3
UserPolicyList : {BackupServicePermissionsToS3Buckets}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetAccountAuthorizationDetails](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMAccountPasswordPolicy`
次のコード例は、`Get-IAMAccountPasswordPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、現在のアカウントのパスワードポリシーに関する詳細を返します。アカウントのためにパスワードポリシーが定義されていない場合、コマンドは `NoSuchEntity` エラーを返します。**
```
Get-IAMAccountPasswordPolicy
```
**出力:**
```
AllowUsersToChangePassword : True
ExpirePasswords : True
HardExpiry : False
MaxPasswordAge : 90
MinimumPasswordLength : 8
PasswordReusePrevention : 20
RequireLowercaseCharacters : True
RequireNumbers : True
RequireSymbols : False
RequireUppercaseCharacters : True
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetAccountPasswordPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMAccountSummary`
次のコード例は、`Get-IAMAccountSummary` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 AWS アカウント内の現在の IAM エンティティの使用状況と現在の IAM エンティティのクォータに関する情報を返します。**
```
Get-IAMAccountSummary
```
**出力:**
```
Key Value
Users 7
GroupPolicySizeQuota 5120
PolicyVersionsInUseQuota 10000
ServerCertificatesQuota 20
AccountSigningCertificatesPresent 0
AccountAccessKeysPresent 0
Groups 3
UsersQuota 5000
RolePolicySizeQuota 10240
UserPolicySizeQuota 2048
GroupsPerUserQuota 10
AssumeRolePolicySizeQuota 2048
AttachedPoliciesPerGroupQuota 2
Roles 9
VersionsPerPolicyQuota 5
GroupsQuota 100
PolicySizeQuota 5120
Policies 5
RolesQuota 250
ServerCertificates 0
AttachedPoliciesPerRoleQuota 2
MFADevicesInUse 2
PoliciesQuota 1000
AccountMFAEnabled 1
Providers 2
InstanceProfilesQuota 100
MFADevices 4
AccessKeysPerUserQuota 2
AttachedPoliciesPerUserQuota 2
SigningCertificatesPerUserQuota 2
PolicyVersionsInUse 4
InstanceProfiles 1
...
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetAccountSummary](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMAttachedGroupPolicyList`
次のコード例は、`Get-IAMAttachedGroupPolicyList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、 AWS アカウント`Admins`内の という名前の IAM グループにアタッチされている管理ポリシーの名前と ARNs を返します。グループに埋め込まれているインラインポリシーのリストを表示するには、`Get-IAMGroupPolicyList` コマンドを使用します。**
```
Get-IAMAttachedGroupPolicyList -GroupName "Admins"
```
**出力:**
```
PolicyArn PolicyName
--------- ----------
arn:aws:iam::aws:policy/SecurityAudit SecurityAudit
arn:aws:iam::aws:policy/AdministratorAccess AdministratorAccess
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListAttachedGroupPolicies](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMAttachedRolePolicyList`
次のコード例は、`Get-IAMAttachedRolePolicyList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、 AWS アカウントの `SecurityAuditRole` という名前の IAM ロールにアタッチされている管理ポリシーの名前と ARN を返します。ロールに埋め込まれているインラインポリシーのリストを表示するには、`Get-IAMRolePolicyList` コマンドを使用します。**
```
Get-IAMAttachedRolePolicyList -RoleName "SecurityAuditRole"
```
**出力:**
```
PolicyArn PolicyName
--------- ----------
arn:aws:iam::aws:policy/SecurityAudit SecurityAudit
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListAttachedRolePolicies](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMAttachedUserPolicyList`
次のコード例は、`Get-IAMAttachedUserPolicyList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、 AWS アカウント`Bob`で という名前の IAM ユーザー用の管理ポリシーの名前と ARNs を返します。IAM ユーザーに埋め込まれているインラインポリシーのリストを表示するには、`Get-IAMUserPolicyList` コマンドを使用します。**
```
Get-IAMAttachedUserPolicyList -UserName "Bob"
```
**出力:**
```
PolicyArn PolicyName
--------- ----------
arn:aws:iam::aws:policy/TesterPolicy TesterPolicy
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListAttachedUserPolicies](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMContextKeysForCustomPolicy`
次のコード例は、`Get-IAMContextKeysForCustomPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、提供されたポリシー JSON に含まれるすべてのコンテキストキーを取得します。複数のポリシーを指定するには、値のカンマ区切りリストとして指定できます。**
```
$policy1 = '{"Version":"2012-10-17", "Statement":{"Effect":"Allow","Action":"dynamodb:*","Resource":"arn:aws:dynamodb:us-west-2:123456789012:table/","Condition":{"DateGreaterThan":{"aws:CurrentTime":"2015-08-16T12:00:00Z"}}}}'
$policy2 = '{"Version":"2012-10-17", "Statement":{"Effect":"Allow","Action":"dynamodb:*","Resource":"arn:aws:dynamodb:us-west-2:123456789012:table/"}}'
Get-IAMContextKeysForCustomPolicy -PolicyInputList $policy1,$policy2
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetContextKeysForCustomPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMContextKeysForPrincipalPolicy`
次のコード例は、`Get-IAMContextKeysForPrincipalPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、提供されたポリシー JSON に含まれるすべてのコンテキストキーと IAM エンティティ (ユーザー/ロールなど) にアタッチされたポリシーを取得します。-PolicyInputList では、複数の値リストをカンマ区切り値として指定できます。**
```
$policy1 = '{"Version":"2012-10-17", "Statement":{"Effect":"Allow","Action":"dynamodb:*","Resource":"arn:aws:dynamodb:us-west-2:123456789012:table/","Condition":{"DateGreaterThan":{"aws:CurrentTime":"2015-08-16T12:00:00Z"}}}}'
$policy2 = '{"Version":"2012-10-17", "Statement":{"Effect":"Allow","Action":"dynamodb:*","Resource":"arn:aws:dynamodb:us-west-2:123456789012:table/"}}'
Get-IAMContextKeysForPrincipalPolicy -PolicyInputList $policy1,$policy2 -PolicySourceArn arn:aws:iam::852640994763:user/TestUser
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetContextKeysForPrincipalPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMCredentialReport`
次のコード例は、`Get-IAMCredentialReport` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、返されたレポートを開き、それをテキスト行の配列としてパイプラインに出力します。最初の行は、カンマで区切られた列名のヘッダーです。連続する各行は 1 人のユーザーの詳細行で、各フィールドはカンマで区切られています。レポートを表示するには、`Request-IAMCredentialReport` コマンドレットを使用してレポートを生成する必要があります。レポートを 1 つの文字列として取得するには、`-AsTextArray` ではなく `-Raw` を使用します。`-AsTextArray` スイッチには、エイリアス `-SplitLines` も使用できます。出力の列の完全なリストについては、サービス API リファレンスを参照してください。`-AsTextArray` または `-SplitLines` を使用しない場合は、.NET `StreamReader` クラスを使用して、`.Content` プロパティからテキストを抽出する必要があることに注意してください。**
```
Request-IAMCredentialReport
```
**出力:**
```
Description State
----------- -----
No report exists. Starting a new report generation task STARTED
```
```
Get-IAMCredentialReport -AsTextArray
```
**出力:**
```
user,arn,user_creation_time,password_enabled,password_last_used,password_last_changed,password_next_rotation,mfa_active,access_key_1_active,access_key_1_last_rotated,access_key_2_active,access_key_2_last_rotated,cert_1_active,cert_1_last_rotated,cert_2_active,cert_2_last_rotated root_account,arn:aws:iam::123456789012:root,2014-10-15T16:31:25+00:00,not_supported,2015-04-20T17:41:10+00:00,not_supported,not_supported,true,false,N/A,false,N/A,false,N/A,false,N/A
Administrator,arn:aws:iam::123456789012:user/Administrator,2014-10-16T16:03:09+00:00,true,2015-04-20T15:18:32+00:00,2014-10-16T16:06:00+00:00,N/A,false,true,2014-12-03T18:53:41+00:00,true,2015-03-25T20:38:14+00:00,false,N/A,false,N/A
Bill,arn:aws:iam::123456789012:user/Bill,2015-04-15T18:27:44+00:00,false,N/A,N/A,N/A,false,false,N/A,false,N/A,false,2015-04-20T20:00:12+00:00,false,N/A
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetCredentialReport](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMEntitiesForPolicy`
次のコード例は、`Get-IAMEntitiesForPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ポリシー `arn:aws:iam::123456789012:policy/TestPolicy` がアタッチされている IAM グループ、ロール、ユーザーのリストを返します。**
```
Get-IAMEntitiesForPolicy -PolicyArn "arn:aws:iam::123456789012:policy/TestPolicy"
```
**出力:**
```
IsTruncated : False
Marker :
PolicyGroups : {}
PolicyRoles : {testRole}
PolicyUsers : {Bob, Theresa}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListEntitiesForPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMGroup`
次のコード例は、`Get-IAMGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、グループに属するすべての IAM ユーザーのコレクションを含む、IAM グループ `Testers` に関する詳細を返します。**
```
$results = Get-IAMGroup -GroupName "Testers"
$results
```
**出力:**
```
Group IsTruncated Marker Users
----- ----------- ------ -----
Amazon.IdentityManagement.Model.Group False {Theresa, David}
```
```
$results.Group
```
**出力:**
```
Arn : arn:aws:iam::123456789012:group/Testers
CreateDate : 12/10/2014 3:39:11 PM
GroupId : 3RHNZZGQJ7QHMAEXAMPLE1
GroupName : Testers
Path : /
```
```
$results.Users
```
**出力:**
```
Arn : arn:aws:iam::123456789012:user/Theresa
CreateDate : 12/10/2014 3:39:27 PM
PasswordLastUsed : 1/1/0001 12:00:00 AM
Path : /
UserId : 4OSVDDJJTF4XEEXAMPLE2
UserName : Theresa
Arn : arn:aws:iam::123456789012:user/David
CreateDate : 12/10/2014 3:39:27 PM
PasswordLastUsed : 3/19/2015 8:44:04 AM
Path : /
UserId : Y4FKWQCXTA52QEXAMPLE3
UserName : David
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMGroupForUser`
次のコード例は、`Get-IAMGroupForUser` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、IAM ユーザー `David` が属する IAM グループのリストを返します。**
```
Get-IAMGroupForUser -UserName David
```
**出力:**
```
Arn : arn:aws:iam::123456789012:group/Administrators
CreateDate : 10/20/2014 10:06:24 AM
GroupId : 6WCH4TRY3KIHIEXAMPLE1
GroupName : Administrators
Path : /
Arn : arn:aws:iam::123456789012:group/Testers
CreateDate : 12/10/2014 3:39:11 PM
GroupId : RHNZZGQJ7QHMAEXAMPLE2
GroupName : Testers
Path : /
Arn : arn:aws:iam::123456789012:group/Developers
CreateDate : 12/10/2014 3:38:55 PM
GroupId : ZU2EOWMK6WBZOEXAMPLE3
GroupName : Developers
Path : /
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListGroupsForUser](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMGroupList`
次のコード例は、`Get-IAMGroupList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、現在の で定義されているすべての IAM グループのコレクションを返します AWS アカウント。**
```
Get-IAMGroupList
```
**出力:**
```
Arn : arn:aws:iam::123456789012:group/Administrators
CreateDate : 10/20/2014 10:06:24 AM
GroupId : 6WCH4TRY3KIHIEXAMPLE1
GroupName : Administrators
Path : /
Arn : arn:aws:iam::123456789012:group/Developers
CreateDate : 12/10/2014 3:38:55 PM
GroupId : ZU2EOWMK6WBZOEXAMPLE2
GroupName : Developers
Path : /
Arn : arn:aws:iam::123456789012:group/Testers
CreateDate : 12/10/2014 3:39:11 PM
GroupId : RHNZZGQJ7QHMAEXAMPLE3
GroupName : Testers
Path : /
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListGroups](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMGroupPolicy`
次のコード例は、`Get-IAMGroupPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、グループ `Testers` の `PowerUserAccess-Testers` という名前の埋め込みインラインポリシーに関する詳細を返します。`PolicyDocument` プロパティは URL エンコードされています。この例では、`UrlDecode` .NET メソッドを使用してデコードされています。**
```
$results = Get-IAMGroupPolicy -GroupName Testers -PolicyName PowerUserAccess-Testers
$results
```
**出力:**
```
GroupName PolicyDocument PolicyName
--------- -------------- ----------
Testers %7B%0A%20%20%22Version%22%3A%20%222012-10-17%22%2C%0A%20... PowerUserAccess-Testers
[System.Reflection.Assembly]::LoadWithPartialName("System.Web.HttpUtility")
[System.Web.HttpUtility]::UrlDecode($results.PolicyDocument)
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"ec2:DescribeInstances"
],
"Resource": [
"arn:aws:ec2:us-east-1:555555555555:instance/i-b188560f"
]
}
]
}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetGroupPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMGroupPolicyList`
次のコード例は、`Get-IAMGroupPolicyList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、グループ `Testers` に埋め込まれているインラインポリシーのリストを返します。グループにアタッチされている管理ポリシーを取得するには、コマンド `Get-IAMAttachedGroupPolicyList` を使用します。**
```
Get-IAMGroupPolicyList -GroupName Testers
```
**出力:**
```
Deny-Assume-S3-Role-In-Production
PowerUserAccess-Testers
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListGroupPolicies](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMInstanceProfile`
次のコード例は、`Get-IAMInstanceProfile` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、現在の AWS アカウントで定義されている `ec2instancerole` という名前のインスタンスプロファイルの詳細を返します。**
```
Get-IAMInstanceProfile -InstanceProfileName ec2instancerole
```
**出力:**
```
Arn : arn:aws:iam::123456789012:instance-profile/ec2instancerole
CreateDate : 2/17/2015 2:49:04 PM
InstanceProfileId : HH36PTZQJUR32EXAMPLE1
InstanceProfileName : ec2instancerole
Path : /
Roles : {ec2instancerole}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetInstanceProfile](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMInstanceProfileForRole`
次のコード例は、`Get-IAMInstanceProfileForRole` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ロール `ec2instancerole` に関連付けられているインスタンスプロファイルの詳細を返します。**
```
Get-IAMInstanceProfileForRole -RoleName ec2instancerole
```
**出力:**
```
Arn : arn:aws:iam::123456789012:instance-profile/ec2instancerole
CreateDate : 2/17/2015 2:49:04 PM
InstanceProfileId : HH36PTZQJUR32EXAMPLE1
InstanceProfileName : ec2instancerole
Path : /
Roles : {ec2instancerole}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListInstanceProfilesForRole](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMInstanceProfileList`
次のコード例は、`Get-IAMInstanceProfileList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、現在の で定義されているインスタンスプロファイルのコレクションを返します AWS アカウント。**
```
Get-IAMInstanceProfileList
```
**出力:**
```
Arn : arn:aws:iam::123456789012:instance-profile/ec2instancerole
CreateDate : 2/17/2015 2:49:04 PM
InstanceProfileId : HH36PTZQJUR32EXAMPLE1
InstanceProfileName : ec2instancerole
Path : /
Roles : {ec2instancerole}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListInstanceProfiles](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMLoginProfile`
次のコード例は、`Get-IAMLoginProfile` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、パスワードの作成日と、IAM ユーザー `David` のパスワードのリセットが必要かどうかを返します。**
```
Get-IAMLoginProfile -UserName David
```
**出力:**
```
CreateDate PasswordResetRequired UserName
---------- --------------------- --------
12/10/2014 3:39:44 PM False David
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetLoginProfile](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMMFADevice`
次のコード例は、`Get-IAMMFADevice` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、IAM ユーザー `David` に割り当てられた MFA デバイスに関する詳細を返します。この例では、`SerialNumber` は物理デバイスの実際のシリアル番号ではなく ARN であるため、仮想デバイスであることがわかります。**
```
Get-IAMMFADevice -UserName David
```
**出力:**
```
EnableDate SerialNumber UserName
---------- ------------ --------
4/8/2015 9:41:10 AM arn:aws:iam::123456789012:mfa/David David
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListMfaDevices](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMOpenIDConnectProvider`
次のコード例は、`Get-IAMOpenIDConnectProvider` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ARN が `arn:aws:iam::123456789012:oidc-provider/accounts.google.com` である OpenID Connect プロバイダーに関する詳細を返します。`ClientIDList` プロパティは、このプロバイダーに定義されているすべてのクライアント ID を含むコレクションです。**
```
Get-IAMOpenIDConnectProvider -OpenIDConnectProviderArn arn:aws:iam::123456789012:oidc-provider/oidc.example.com
```
**出力:**
```
ClientIDList CreateDate ThumbprintList Url
------------ ---------- -------------- ---
{MyOIDCApp} 2/3/2015 3:00:30 PM {12345abcdefghijk67890lmnopqrst98765uvwxy} oidc.example.com
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetOpenIdConnectProvider](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMOpenIDConnectProviderList`
次のコード例は、`Get-IAMOpenIDConnectProviderList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、現在の AWS アカウントで定義されているすべての OpenID Connect プロバイダーの ARN のリストを返します。**
```
Get-IAMOpenIDConnectProviderList
```
**出力:**
```
Arn
---
arn:aws:iam::123456789012:oidc-provider/server.example.com
arn:aws:iam::123456789012:oidc-provider/another.provider.com
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListOpenIdConnectProviders](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMPolicy`
次のコード例は、`Get-IAMPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ARN が `arn:aws:iam::123456789012:policy/MySamplePolicy` である管理ポリシーに関する詳細を返します。**
```
Get-IAMPolicy -PolicyArn arn:aws:iam::123456789012:policy/MySamplePolicy
```
**出力:**
```
Arn : arn:aws:iam::aws:policy/MySamplePolicy
AttachmentCount : 0
CreateDate : 2/6/2015 10:40:08 AM
DefaultVersionId : v1
Description :
IsAttachable : True
Path : /
PolicyId : Z27SI6FQMGNQ2EXAMPLE1
PolicyName : MySamplePolicy
UpdateDate : 2/6/2015 10:40:08 AM
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[GetPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-IAMPolicyList`
次のコード例は、`Get-IAMPolicyList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、現在の AWS アカウントで使用できる最初の 3 つの管理ポリシーのコレクションを返します。`-scope`が指定されていないため、デフォルトで に設定`all`され、 AWS 管理ポリシーとカスタマー管理ポリシーの両方が含まれます。**
```
Get-IAMPolicyList -MaxItem 3
```
**出力:**
```
Arn : arn:aws:iam::aws:policy/AWSDirectConnectReadOnlyAccess
AttachmentCount : 0
CreateDate : 2/6/2015 10:40:08 AM
DefaultVersionId : v1
Description :
IsAttachable : True
Path : /
PolicyId : Z27SI6FQMGNQ2EXAMPLE1
PolicyName : AWSDirectConnectReadOnlyAccess
UpdateDate : 2/6/2015 10:40:08 AM
Arn : arn:aws:iam::aws:policy/AmazonGlacierReadOnlyAccess
AttachmentCount : 0
CreateDate : 2/6/2015 10:40:27 AM
DefaultVersionId : v1
Description :
IsAttachable : True
Path : /
PolicyId : NJKMU274MET4EEXAMPLE2
PolicyName : AmazonGlacierReadOnlyAccess
UpdateDate : 2/6/2015 10:40:27 AM
Arn : arn:aws:iam::aws:policy/AWSMarketplaceFullAccess
AttachmentCount : 0
CreateDate : 2/11/2015 9:21:45 AM
DefaultVersionId : v1
Description :
IsAttachable : True
Path : /
PolicyId : 5ULJSO2FYVPYGEXAMPLE3
PolicyName : AWSMarketplaceFullAccess
UpdateDate : 2/11/2015 9:21:45 AM
```
**例 2: この例では、現在の AWS アカウントで使用できる最初の 2 つのカスタマー管理ポリシーのコレクションを返します。`-Scope local` を使用して、出力をカスタマー管理ポリシーのみに制限します。**
```
Get-IAMPolicyList -Scope local -MaxItem 2
```
**出力:**
```
Arn : arn:aws:iam::123456789012:policy/MyLocalPolicy
AttachmentCount : 0
CreateDate : 2/12/2015 9:39:09 AM
DefaultVersionId : v2
Description :
IsAttachable : True
Path : /
PolicyId : SQVCBLC4VAOUCEXAMPLE4
PolicyName : MyLocalPolicy
UpdateDate : 2/12/2015 9:39:53 AM
Arn : arn:aws:iam::123456789012:policy/policyforec2instancerole
AttachmentCount : 1
CreateDate : 2/17/2015 2:51:38 PM
DefaultVersionId : v11
Description :
IsAttachable : True
Path : /
PolicyId : X5JPBLJH2Z2SOEXAMPLE5
PolicyName : policyforec2instancerole
UpdateDate : 2/18/2015 8:52:31 AM
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListPolicies](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMPolicyVersion`
次のコード例は、`Get-IAMPolicyVersion` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ARN が `arn:aws:iam::123456789012:policy/MyManagedPolicy` であるポリシーの `v2` バージョンのポリシードキュメントを返します。`Document` プロパティ内のポリシードキュメントは URL でエンコードされ、この例では `UrlDecode` .NET メソッドを使用してデコードされます。**
```
$results = Get-IAMPolicyVersion -PolicyArn arn:aws:iam::123456789012:policy/MyManagedPolicy -VersionId v2
$results
```
**出力:**
```
CreateDate Document IsDefaultVersion VersionId
---------- -------- ---------------- ---------
2/12/2015 9:39:53 AM %7B%0A%20%20%22Version%22%3A%20%222012-10... True v2
[System.Reflection.Assembly]::LoadWithPartialName("System.Web.HttpUtility")
$policy = [System.Web.HttpUtility]::UrlDecode($results.Document)
$policy
{
"Version":"2012-10-17",
"Statement":
{
"Effect": "Allow",
"Action": [
"ec2:DescribeInstances"
],
"Resource": [
"arn:aws:ec2:us-east-1:555555555555:instance/i-b188560f"
]
}
}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetPolicyVersion](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMPolicyVersionList`
次のコード例は、`Get-IAMPolicyVersionList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ARN が `arn:aws:iam::123456789012:policy/MyManagedPolicy` であるポリシーの使用可能なバージョンのリストを返します。特定のバージョンのポリシードキュメントを取得するには、`Get-IAMPolicyVersion` コマンドを使用して、必要なバージョンの `VersionId` を指定します。**
```
Get-IAMPolicyVersionList -PolicyArn arn:aws:iam::123456789012:policy/MyManagedPolicy
```
**出力:**
```
CreateDate Document IsDefaultVersion VersionId
---------- -------- ---------------- ---------
2/12/2015 9:39:53 AM True v2
2/12/2015 9:39:09 AM False v1
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListPolicyVersions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMRole`
次のコード例は、`Get-IAMRole` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`lamda_exec_role` の詳細を返します。これには、このロールの引き受け先を指定する信頼ポリシードキュメントが含まれています。ポリシードキュメントは URL でエンコードされており、.NET `UrlDecode` メソッドを使用してデコードできます。この例では、元のポリシーは、ポリシーにアップロードされる前にすべての空白が削除されています。ロールを引き受けるユーザーが実行できる操作を決定するアクセス許可ポリシードキュメントを確認するには、インラインポリシーには `Get-IAMRolePolicy` を使用し、アタッチされた管理ポリシーには `Get-IAMPolicyVersion` を使用します。**
```
$results = Get-IamRole -RoleName lambda_exec_role
$results | Format-List
```
**出力:**
```
Arn : arn:aws:iam::123456789012:role/lambda_exec_role
AssumeRolePolicyDocument : %7B%22Version%22%3A%222012-10-17%22%2C%22Statement%22%3A%5B%7B%22Sid%22
%3A%22%22%2C%22Effect%22%3A%22Allow%22%2C%22Principal%22%3A%7B%22Service
%22%3A%22lambda.amazonaws.com%22%7D%2C%22Action%22%3A%22sts%3AAssumeRole
%22%7D%5D%7D
CreateDate : 4/2/2015 9:16:11 AM
Path : /
RoleId : 2YBIKAIBHNKB4EXAMPLE1
RoleName : lambda_exec_role
```
```
$policy = [System.Web.HttpUtility]::UrlDecode($results.AssumeRolePolicyDocument)
$policy
```
**出力:**
```
{"Version":"2012-10-17", "Statement":[{"Sid":"","Effect":"Allow","Principal":{"Service":"lambda.amazonaws.com"},"Action":"sts:AssumeRole"}]}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetRole](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMRoleList`
次のコード例は、`Get-IAMRoleList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 AWS アカウント内のすべての IAM ロールのリストを取得します。**
```
Get-IAMRoleList
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListRoles](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMRolePolicy`
次のコード例は、`Get-IAMRolePolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、IAM ロール `lamda_exec_role` に埋め込まれている `oneClick_lambda_exec_role_policy` という名前のポリシーのアクセス許可ポリシードキュメントを返します。結果のポリシードキュメントは URL エンコードされます。この例では、`UrlDecode` .NET メソッドを使用してデコードされています。**
```
$results = Get-IAMRolePolicy -RoleName lambda_exec_role -PolicyName oneClick_lambda_exec_role_policy
$results
```
**出力:**
```
PolicyDocument PolicyName UserName
-------------- ---------- --------
%7B%0A%20%20%22Version%22%3A%20%222012-10-17%22%2C%... oneClick_lambda_exec_role_policy lambda_exec_role
```
```
[System.Reflection.Assembly]::LoadWithPartialName("System.Web.HttpUtility")
[System.Web.HttpUtility]::UrlDecode($results.PolicyDocument)
```
**出力:**
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"logs:*"
],
"Resource": "arn:aws:logs:us-east-1:555555555555:log-group:/aws/lambda/aws-example-function:*"
},
{
"Effect": "Allow",
"Action": [
"s3:GetObject",
"s3:PutObject"
],
"Resource": [
"arn:aws:s3:::amzn-s3-demo-bucket/*"
]
}
]
}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetRolePolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMRolePolicyList`
次のコード例は、`Get-IAMRolePolicyList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、IAM ロール `lamda_exec_role` に埋め込まれているインラインポリシーの名前のリストを返します。インラインポリシーの詳細を表示するには、`Get-IAMRolePolicy` コマンドを使用します。**
```
Get-IAMRolePolicyList -RoleName lambda_exec_role
```
**出力:**
```
oneClick_lambda_exec_role_policy
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListRolePolicies](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMRoleTagList`
次のコード例は、`Get-IAMRoleTagList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ロールに関連付けられているタグを取得します。**
```
Get-IAMRoleTagList -RoleName MyRoleName
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListRoleTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMSAMLProvider`
次のコード例は、`Get-IAMSAMLProvider` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ARM が arn:aws:iam::123456789012:saml-provider/SAMLADFS である SAML 2.0 プロバイダーに関する詳細を取得します。レスポンスには、SAML プロバイダーエンティティを作成するために ID AWS プロバイダーから取得したメタデータドキュメントと、作成日と有効期限が含まれます。**
```
Get-IAMSAMLProvider -SAMLProviderArn arn:aws:iam::123456789012:saml-provider/SAMLADFS
```
**出力:**
```
CreateDate SAMLMetadataDocument ValidUntil
---------- -------------------- ----------
12/23/2014 12:16:55 PM
次のコード例は、`Get-IAMSAMLProviderList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、現在の AWS アカウントで作成された SAML 2.0 プロバイダーのリストを取得します。これは、各 SAML プロバイダーの ARN、作成日、有効期限を返します。**
```
Get-IAMSAMLProviderList
```
**出力:**
```
Arn CreateDate ValidUntil
--- ---------- ----------
arn:aws:iam::123456789012:saml-provider/SAMLADFS 12/23/2014 12:16:55 PM 12/23/2114 12:16:54 PM
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListSAMLProviders](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMServerCertificate`
次のコード例は、`Get-IAMServerCertificate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`MyServerCertificate` という名前のサーバー証明書に関する詳細を取得します。証明書の詳細は、`CertificateBody` および `ServerCertificateMetadata` プロパティで確認できます。**
```
$result = Get-IAMServerCertificate -ServerCertificateName MyServerCertificate
$result | format-list
```
**出力:**
```
CertificateBody : -----BEGIN CERTIFICATE-----
MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC
VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6
b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd
BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN
MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD
VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z
b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt
YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ
21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T
rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE
Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4
nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb
FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb
NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=
-----END CERTIFICATE-----
CertificateChain :
ServerCertificateMetadata : Amazon.IdentityManagement.Model.ServerCertificateMetadata
```
```
$result.ServerCertificateMetadata
```
**出力:**
```
Arn : arn:aws:iam::123456789012:server-certificate/Org1/Org2/MyServerCertificate
Expiration : 1/14/2018 9:52:36 AM
Path : /Org1/Org2/
ServerCertificateId : ASCAJIFEXAMPLE17HQZYW
ServerCertificateName : MyServerCertificate
UploadDate : 4/21/2015 11:14:16 AM
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetServerCertificate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMServerCertificateList`
次のコード例は、`Get-IAMServerCertificateList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、現在の AWS アカウントにアップロードされたサーバー証明書のリストを取得します。**
```
Get-IAMServerCertificateList
```
**出力:**
```
Arn : arn:aws:iam::123456789012:server-certificate/Org1/Org2/MyServerCertificate
Expiration : 1/14/2018 9:52:36 AM
Path : /Org1/Org2/
ServerCertificateId : ASCAJIFEXAMPLE17HQZYW
ServerCertificateName : MyServerCertificate
UploadDate : 4/21/2015 11:14:16 AM
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListServerCertificates](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMServiceLastAccessedDetail`
次のコード例は、`Get-IAMServiceLastAccessedDetail` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、リクエスト呼び出しに関連付けられた IAM エンティティ (ユーザー、グループ、ロール、またはポリシー) が最後にアクセスしたサービスの詳細が表示されます。**
```
Request-IAMServiceLastAccessedDetail -Arn arn:aws:iam::123456789012:user/TestUser
```
**出力:**
```
f0b7a819-eab0-929b-dc26-ca598911cb9f
```
```
Get-IAMServiceLastAccessedDetail -JobId f0b7a819-eab0-929b-dc26-ca598911cb9f
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetServiceLastAccessedDetails](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMServiceLastAccessedDetailWithEntity`
次のコード例は、`Get-IAMServiceLastAccessedDetailWithEntity` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、それぞれの IAM エンティティによるリクエスト内のサービスの最終アクセスタイムスタンプを提供します。**
```
$results = Get-IAMServiceLastAccessedDetailWithEntity -JobId f0b7a819-eab0-929b-dc26-ca598911cb9f -ServiceNamespace ec2
$results
```
**出力:**
```
EntityDetailsList : {Amazon.IdentityManagement.Model.EntityDetails}
Error :
IsTruncated : False
JobCompletionDate : 12/29/19 11:19:31 AM
JobCreationDate : 12/29/19 11:19:31 AM
JobStatus : COMPLETED
Marker :
```
```
$results.EntityDetailsList
```
**出力:**
```
EntityInfo LastAuthenticated
---------- -----------------
Amazon.IdentityManagement.Model.EntityInfo 11/16/19 3:47:00 PM
```
```
$results.EntityInfo
```
**出力:**
```
Arn : arn:aws:iam::123456789012:user/TestUser
Id : AIDA4NBK5CXF5TZHU1234
Name : TestUser
Path : /
Type : USER
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetServiceLastAccessedDetailsWithEntities](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMSigningCertificate`
次のコード例は、`Get-IAMSigningCertificate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`Bob` という名前のユーザーに関連付けられている署名証明書に関する詳細を取得します。**
```
Get-IAMSigningCertificate -UserName Bob
```
**出力:**
```
CertificateBody : -----BEGIN CERTIFICATE-----
MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC
VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6
b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd
BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN
MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD
VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z
b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt
YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ
21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T
rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE
Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4
nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb
FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb
NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=
-----END CERTIFICATE-----
CertificateId : Y3EK7RMEXAMPLESV33FCREXAMPLEMJLU
Status : Active
UploadDate : 4/20/2015 1:26:01 PM
UserName : Bob
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListSigningCertificates](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMUser`
次のコード例は、`Get-IAMUser` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`David` という名前のユーザーに関する詳細を取得します。**
```
Get-IAMUser -UserName David
```
**出力:**
```
Arn : arn:aws:iam::123456789012:user/David
CreateDate : 12/10/2014 3:39:27 PM
PasswordLastUsed : 3/19/2015 8:44:04 AM
Path : /
UserId : Y4FKWQCXTA52QEXAMPLE1
UserName : David
```
**例 2: この例では、現在サインインしている IAM ユーザーに関する詳細を取得します。**
```
Get-IAMUser
```
**出力:**
```
Arn : arn:aws:iam::123456789012:user/Bob
CreateDate : 10/16/2014 9:03:09 AM
PasswordLastUsed : 3/4/2015 12:12:33 PM
Path : /
UserId : 7K3GJEANSKZF2EXAMPLE2
UserName : Bob
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetUser](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMUserList`
次のコード例は、`Get-IAMUserList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、現在の のユーザーのコレクションを取得します AWS アカウント。**
```
Get-IAMUserList
```
**出力:**
```
Arn : arn:aws:iam::123456789012:user/Administrator
CreateDate : 10/16/2014 9:03:09 AM
PasswordLastUsed : 3/4/2015 12:12:33 PM
Path : /
UserId : 7K3GJEANSKZF2EXAMPLE1
UserName : Administrator
Arn : arn:aws:iam::123456789012:user/Bob
CreateDate : 4/6/2015 12:54:42 PM
PasswordLastUsed : 1/1/0001 12:00:00 AM
Path : /
UserId : L3EWNONDOM3YUEXAMPLE2
UserName : bab
Arn : arn:aws:iam::123456789012:user/David
CreateDate : 12/10/2014 3:39:27 PM
PasswordLastUsed : 3/19/2015 8:44:04 AM
Path : /
UserId : Y4FKWQCXTA52QEXAMPLE3
UserName : David
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListUsers](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMUserPolicy`
次のコード例は、`Get-IAMUserPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`David` という名前の IAM ユーザーに埋め込まれている `Davids_IAM_Admin_Policy` という名前のインラインポリシーの詳細を取得します。ポリシードキュメントは URL エンコードされています。**
```
$results = Get-IAMUserPolicy -PolicyName Davids_IAM_Admin_Policy -UserName David
$results
```
**出力:**
```
PolicyDocument PolicyName UserName
-------------- ---------- --------
%7B%0A%20%20%22Version%22%3A%20%222012-10-17%22%2C%... Davids_IAM_Admin_Policy David
[System.Reflection.Assembly]::LoadWithPartialName("System.Web.HttpUtility")
[System.Web.HttpUtility]::UrlDecode($results.PolicyDocument)
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"iam:GetUser",
"iam:ListUsers"
],
"Resource": [
"arn:aws:iam::111122223333:user/*"
]
}
]
}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetUserPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMUserPolicyList`
次のコード例は、`Get-IAMUserPolicyList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`David` という名前の IAM ユーザーに埋め込まれているインラインポリシーの名前のリストを取得します。**
```
Get-IAMUserPolicyList -UserName David
```
**出力:**
```
Davids_IAM_Admin_Policy
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListUserPolicies](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMUserTagList`
次のコード例は、`Get-IAMUserTagList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ユーザーに関連付けられているタグを取得します。**
```
Get-IAMUserTagList -UserName joe
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListUserTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-IAMVirtualMFADevice`
次のコード例は、`Get-IAMVirtualMFADevice` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 AWS アカウントのユーザーに割り当てられた仮想 MFA デバイスのコレクションを取得します。それぞれの `User` プロパティは、デバイスが割り当てられている IAM ユーザーの詳細を含むオブジェクトです。**
```
Get-IAMVirtualMFADevice -AssignmentStatus Assigned
```
**出力:**
```
Base32StringSeed :
EnableDate : 4/13/2015 12:03:42 PM
QRCodePNG :
SerialNumber : arn:aws:iam::123456789012:mfa/David
User : Amazon.IdentityManagement.Model.User
Base32StringSeed :
EnableDate : 4/13/2015 12:06:41 PM
QRCodePNG :
SerialNumber : arn:aws:iam::123456789012:mfa/root-account-mfa-device
User : Amazon.IdentityManagement.Model.User
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListVirtualMfaDevices](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-IAMAccessKey`
次のコード例は、`New-IAMAccessKey` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、新しいアクセスキーとシークレットアクセスキーのペアを作成し、それをユーザー `David` に割り当てます。`SecretAccessKey` を取得できるのはこのときだけなので、`AccessKeyId` と `SecretAccessKey` の値は必ずファイルに保存してください。後で取得することはできません。シークレットアクセスキーを紛失した場合は、新しいアクセスキーペアを作成する必要があります。**
```
New-IAMAccessKey -UserName David
```
**出力:**
```
AccessKeyId : AKIAIOSFODNN7EXAMPLE
CreateDate : 4/13/2015 1:00:42 PM
SecretAccessKey : wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Status : Active
UserName : David
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateAccessKey](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-IAMAccountAlias`
次のコード例は、`New-IAMAccountAlias` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、アカウントのアカウントエイリアス AWS を に変更します`mycompanyaws`。ユーザーログオンページのアドレスが、https://mycompanyaws.signin.aws.amazon.com/console に変わります。エイリアスの代わりにアカウント ID 番号を使用する元の URL (https://.signin.aws.amazon.com/console) は引き続き機能します。ただし、以前に定義したエイリアスベースの URL は機能しなくなります。**
```
New-IAMAccountAlias -AccountAlias mycompanyaws
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateAccountAlias](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-IAMGroup`
次のコード例は、`New-IAMGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`Developers` という名前の新しい IAM グループを作成します。**
```
New-IAMGroup -GroupName Developers
```
**出力:**
```
Arn : arn:aws:iam::123456789012:group/Developers
CreateDate : 4/14/2015 11:21:31 AM
GroupId : QNEJ5PM4NFSQCEXAMPLE1
GroupName : Developers
Path : /
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-IAMInstanceProfile`
次のコード例は、`New-IAMInstanceProfile` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`ProfileForDevEC2Instance` という名前の新しい IAM インスタンスプロファイルを作成します。`Add-IAMRoleToInstanceProfile` コマンドを個別に実行して、インスタンスにアクセス許可を与える既存の IAM ロールにインスタンスプロファイルを関連付ける必要があります。最後に、EC2 インスタンスを起動する際に、インスタンスプロファイルを EC2 インスタンスにアタッチします。そのためには、`New-EC2Instance` コマンドレットを `InstanceProfile_Arn` または `InstanceProfile_Name` パラメータと共に使用します。**
```
New-IAMInstanceProfile -InstanceProfileName ProfileForDevEC2Instance
```
**出力:**
```
Arn : arn:aws:iam::123456789012:instance-profile/ProfileForDevEC2Instance
CreateDate : 4/14/2015 11:31:39 AM
InstanceProfileId : DYMFXL556EY46EXAMPLE1
InstanceProfileName : ProfileForDevEC2Instance
Path : /
Roles : {}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateInstanceProfile](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-IAMLoginProfile`
次のコード例は、`New-IAMLoginProfile` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Bob という名前の IAM ユーザーの (一時的な) パスワードを作成し、次回 `Bob` がサインインしたときに、ユーザーにパスワードを変更するように要求するフラグを設定しています。**
```
New-IAMLoginProfile -UserName Bob -Password P@ssw0rd -PasswordResetRequired $true
```
**出力:**
```
CreateDate PasswordResetRequired UserName
---------- --------------------- --------
4/14/2015 12:26:30 PM True Bob
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateLoginProfile](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-IAMOpenIDConnectProvider`
次のコード例は、`New-IAMOpenIDConnectProvider` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、URL `https://example.oidcprovider.com` とクライアント ID `my-testapp-1` にある OIDC 互換プロバイダーサービスに関連付けられた IAM OIDC プロバイダーを作成します。OIDC プロバイダーがサムプリントを提供します。サムプリントを認証するには、http://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc-obtain-thumbprint.html にある手順に従ってください。**
```
New-IAMOpenIDConnectProvider -Url https://example.oidcprovider.com -ClientIDList my-testapp-1 -ThumbprintList 990F419EXAMPLEECF12DDEDA5EXAMPLE52F20D9E
```
**出力:**
```
arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateOpenIdConnectProvider](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-IAMPolicy`
次のコード例は、`New-IAMPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 という名前の現在の AWS アカウントに新しい IAM `MySamplePolicy` ポリシーを作成します。 ファイルはポリシーコンテンツ`MySamplePolicy.json`を提供します。JSON ポリシーファイルを正常に処理するには、`-Raw` switch パラメータを使用する必要があることに注意してください。**
```
New-IAMPolicy -PolicyName MySamplePolicy -PolicyDocument (Get-Content -Raw MySamplePolicy.json)
```
**出力:**
```
Arn : arn:aws:iam::123456789012:policy/MySamplePolicy
AttachmentCount : 0
CreateDate : 4/14/2015 2:45:59 PM
DefaultVersionId : v1
Description :
IsAttachable : True
Path : /
PolicyId : LD4KP6HVFE7WGEXAMPLE1
PolicyName : MySamplePolicy
UpdateDate : 4/14/2015 2:45:59 PM
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreatePolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-IAMPolicyVersion`
次のコード例は、`New-IAMPolicyVersion` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ARN が `arn:aws:iam::123456789012:policy/MyPolicy` である IAM ポリシーの新しい「v2」バージョンを作成し、それをデフォルトのバージョンにします。`NewPolicyVersion.json` ファイルは、ポリシーの内容を提供します。JSON ポリシーファイルを正常に処理するには、`-Raw` switch パラメータを使用する必要があることに注意してください。**
```
New-IAMPolicyVersion -PolicyArn arn:aws:iam::123456789012:policy/MyPolicy -PolicyDocument (Get-content -Raw NewPolicyVersion.json) -SetAsDefault $true
```
**出力:**
```
CreateDate Document IsDefaultVersion VersionId
---------- -------- ---------------- ---------
4/15/2015 10:54:54 AM True v2
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreatePolicyVersion](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-IAMRole`
次のコード例は、`New-IAMRole` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`MyNewRole` という名前の新しいロールを作成し、`NewRoleTrustPolicy.json` ファイルにあるポリシーをそのロールにアタッチします。JSON ポリシーファイルを正常に処理するには、`-Raw` switch パラメータを使用する必要があることに注意してください。出力に表示されるポリシードキュメントは、URL でエンコードされています。この例では、`UrlDecode` .NET メソッドを使用してデコードされています。**
```
$results = New-IAMRole -AssumeRolePolicyDocument (Get-Content -raw NewRoleTrustPolicy.json) -RoleName MyNewRole
$results
```
**出力:**
```
Arn : arn:aws:iam::123456789012:role/MyNewRole
AssumeRolePolicyDocument : %7B%0D%0A%20%20%22Version%22%3A%20%222012-10-17%22%2C%0D%0A%20%20%22Statement%22
%3A%20%5B%0D%0A%20%20%20%20%7B%0D%0A%20%20%20%20%20%20%22Sid%22%3A%20%22%22%2C
%0D%0A%20%20%20%20%20%20%22Effect%22%3A%20%22Allow%22%2C%0D%0A%20%20%20%20%20%20
%22Principal%22%3A%20%7B%0D%0A%20%20%20%20%20%20%20%20%22AWS%22%3A%20%22arn%3Aaws
%3Aiam%3A%3A123456789012%3ADavid%22%0D%0A%20%20%20%20%20%20%7D%2C%0D%0A%20%20%20
%20%20%20%22Action%22%3A%20%22sts%3AAssumeRole%22%0D%0A%20%20%20%20%7D%0D%0A%20
%20%5D%0D%0A%7D
CreateDate : 4/15/2015 11:04:23 AM
Path : /
RoleId : V5PAJI2KPN4EAEXAMPLE1
RoleName : MyNewRole
[System.Reflection.Assembly]::LoadWithPartialName("System.Web.HttpUtility")
[System.Web.HttpUtility]::UrlDecode($results.AssumeRolePolicyDocument)
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "",
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::123456789012:David"
},
"Action": "sts:AssumeRole"
}
]
}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateRole](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-IAMSAMLProvider`
次のコード例は、`New-IAMSAMLProvider` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、IAM に新しい SAML プロバイダーエンティティを作成します。これは `MySAMLProvider` という名前で、SAML サービスプロバイダーのウェブサイトから個別にダウンロードされた `SAMLMetaData.xml` ファイルにある SAML メタデータドキュメントによって記述されます。**
```
New-IAMSAMLProvider -Name MySAMLProvider -SAMLMetadataDocument (Get-Content -Raw SAMLMetaData.xml)
```
**出力:**
```
arn:aws:iam::123456789012:saml-provider/MySAMLProvider
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateSAMLProvider](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-IAMServiceLinkedRole`
次のコード例は、`New-IAMServiceLinkedRole` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、自動スケーリングサービスのサービスにリンクされたロールを作成します。**
```
New-IAMServiceLinkedRole -AWSServiceName autoscaling.amazonaws.com -CustomSuffix RoleNameEndsWithThis -Description "My service-linked role to support autoscaling"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateServiceLinkedRole](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-IAMUser`
次のコード例は、`New-IAMUser` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`Bob` という名前の IAM ユーザーを作成します。Bob が AWS コンソールにサインインする必要がある場合は、 コマンドを個別に実行`New-IAMLoginProfile`して、パスワードでサインインプロファイルを作成する必要があります。Bob が AWS PowerShell またはクロスプラットフォーム CLI コマンドを実行したり、 AWS API コールを実行したりする必要がある場合は、 `New-IAMAccessKey` コマンドを個別に実行してアクセスキーを作成する必要があります。**
```
New-IAMUser -UserName Bob
```
**出力:**
```
Arn : arn:aws:iam::123456789012:user/Bob
CreateDate : 4/22/2015 12:02:11 PM
PasswordLastUsed : 1/1/0001 12:00:00 AM
Path : /
UserId : AIDAJWGEFDMEMEXAMPLE1
UserName : Bob
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateUser](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-IAMVirtualMFADevice`
次のコード例は、`New-IAMVirtualMFADevice` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、新しい仮想 MFA デバイスを作成します。2 行目と 3 行目は、仮想 MFA ソフトウェアプログラムが (QR コードの代わりに) アカウントを作成するのに必要な `Base32StringSeed` 値を抽出します。この値でプログラムを設定したら、プログラムから 2 つの連続した認証コードを取得します。最後に、最後のコマンドを使用して仮想 MFA デバイスを IAM ユーザー `Bob` にリンクし、アカウントを 2 つの認証コードと同期します。**
```
$Device = New-IAMVirtualMFADevice -VirtualMFADeviceName BobsMFADevice
$SR = New-Object System.IO.StreamReader($Device.Base32StringSeed)
$base32stringseed = $SR.ReadToEnd()
$base32stringseed
CZWZMCQNW4DEXAMPLE3VOUGXJFZYSUW7EXAMPLECR4NJFD65GX2SLUDW2EXAMPLE
```
**出力:**
```
-- Pause here to enter base-32 string seed code into virtual MFA program to register account. --
Enable-IAMMFADevice -SerialNumber $Device.SerialNumber -UserName Bob -AuthenticationCode1 123456 -AuthenticationCode2 789012
```
**例 2: この例では、新しい仮想 MFA デバイスを作成します。2 行目と 3 行目は、`QRCodePNG` 値を抽出してファイルに書き込みます。(Base32StringSeed 値を手動で入力する代わりに) このイメージを仮想 MFA ソフトウェアプログラムでスキャンして、アカウントを作成できます。仮想 MFA プログラムでアカウントを作成したら、2 つの連続した認証コードを取得して最後のコマンドに入力し、仮想 MFA デバイスを IAM ユーザー `Bob` にリンクして、アカウントを同期します。**
```
$Device = New-IAMVirtualMFADevice -VirtualMFADeviceName BobsMFADevice
$BR = New-Object System.IO.BinaryReader($Device.QRCodePNG)
$BR.ReadBytes($BR.BaseStream.Length) | Set-Content -Encoding Byte -Path QRCode.png
```
**出力:**
```
-- Pause here to scan PNG with virtual MFA program to register account. --
Enable-IAMMFADevice -SerialNumber $Device.SerialNumber -UserName Bob -AuthenticationCode1 123456 -AuthenticationCode2 789012
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateVirtualMfaDevice](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Publish-IAMServerCertificate`
次のコード例は、`Publish-IAMServerCertificate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、新しいサーバー証明書を IAM アカウントにアップロードします。証明書本文、プライベートキー、および (オプションで) 証明書チェーンを含むファイルは、すべて PEM エンコードされる必要があります。パラメータにはファイル名ではなくファイルの実際の内容が必要であることに注意してください。ファイルの内容を正常に処理するには、`-Raw` スイッチパラメータを使用する必要があります。**
```
Publish-IAMServerCertificate -ServerCertificateName MyTestCert -CertificateBody (Get-Content -Raw server.crt) -PrivateKey (Get-Content -Raw server.key)
```
**出力:**
```
Arn : arn:aws:iam::123456789012:server-certificate/MyTestCert
Expiration : 1/14/2018 9:52:36 AM
Path : /
ServerCertificateId : ASCAJIEXAMPLE7J7HQZYW
ServerCertificateName : MyTestCert
UploadDate : 4/21/2015 11:14:16 AM
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UploadServerCertificate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Publish-IAMSigningCertificate`
次のコード例は、`Publish-IAMSigningCertificate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、新しい X.509 署名証明書をアップロードし、`Bob` という名前の IAM ユーザーに関連付けます。証明書の本文を含むファイルは PEM でエンコードされています。`CertificateBody` パラメータには、ファイル名ではなく証明書ファイルの実際の内容が必要です。ファイルを正常に処理するには、`-Raw` スイッチパラメータを使用する必要があります。**
```
Publish-IAMSigningCertificate -UserName Bob -CertificateBody (Get-Content -Raw SampleSigningCert.pem)
```
**出力:**
```
CertificateBody : -----BEGIN CERTIFICATE-----
MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC
VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6
b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd
BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN
MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD
VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z
b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt
YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ
21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T
rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE
Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4
nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb
FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb
NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=
-----END CERTIFICATE-----
CertificateId : Y3EK7RMEXAMPLESV33FCEXAMPLEHMJLU
Status : Active
UploadDate : 4/20/2015 1:26:01 PM
UserName : Bob
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UploadSigningCertificate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Register-IAMGroupPolicy`
次のコード例は、`Register-IAMGroupPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`TesterPolicy` という名前のカスタマー管理ポリシーを IAM グループ `Testers` にアタッチします。そのグループのユーザーは、そのポリシーのデフォルトバージョンで定義されているアクセス権限の影響をすぐに受けます。**
```
Register-IAMGroupPolicy -GroupName Testers -PolicyArn arn:aws:iam::123456789012:policy/TesterPolicy
```
**例 2: この例では、 という名前 AWS の管理ポリシーを IAM グループ `AdministratorAccess`にアタッチします`Admins`。そのグループのユーザーは、そのポリシーの最新バージョンで定義されているアクセス権限の影響をすぐに受けます。**
```
Register-IAMGroupPolicy -GroupName Admins -PolicyArn arn:aws:iam::aws:policy/AdministratorAccess
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[AttachGroupPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Register-IAMRolePolicy`
次のコード例は、`Register-IAMRolePolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 という名前 AWS の管理ポリシーを IAM ロール `SecurityAudit`にアタッチします`CoSecurityAuditors`。そのロールを引き受けるユーザーは、そのポリシーの最新バージョンで定義されているアクセス権限の影響をすぐに受けます。**
```
Register-IAMRolePolicy -RoleName CoSecurityAuditors -PolicyArn arn:aws:iam::aws:policy/SecurityAudit
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[AttachRolePolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Register-IAMUserPolicy`
次のコード例は、`Register-IAMUserPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 という名前 AWS の管理ポリシーを IAM ユーザー `AmazonCognitoPowerUser`にアタッチします`Bob`。ユーザーは、そのポリシーの最新バージョンで定義されているアクセス権限の影響をすぐに受けます。**
```
Register-IAMUserPolicy -UserName Bob -PolicyArn arn:aws:iam::aws:policy/AmazonCognitoPowerUser
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[AttachUserPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMAccessKey`
次のコード例は、`Remove-IAMAccessKey` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 という名前のユーザー`AKIAIOSFODNN7EXAMPLE`からキー ID を持つ AWS アクセスキーペアを削除します`Bob`。**
```
Remove-IAMAccessKey -AccessKeyId AKIAIOSFODNN7EXAMPLE -UserName Bob -Force
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteAccessKey](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMAccountAlias`
次のコード例は、`Remove-IAMAccountAlias` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 からアカウントエイリアスを削除します AWS アカウント。https://mycompanyaws.signin.aws.amazon.com/console で、エイリアスを持つユーザーサインインページは機能しなくなりました。代わりに、https://.signin.aws.amazon.com/console の AWS アカウント ID 番号で元の URL を使用する必要があります。**
```
Remove-IAMAccountAlias -AccountAlias mycompanyaws
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteAccountAlias](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMAccountPasswordPolicy`
次のコード例は、`Remove-IAMAccountPasswordPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 のパスワードポリシーを削除 AWS アカウント し、すべての値を元のデフォルトにリセットします。パスワードポリシーが現在存在しない場合、次のエラーメッセージが表示されます。The account policy with name PasswordPolicy cannot be found.**
```
Remove-IAMAccountPasswordPolicy
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteAccountPasswordPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMClientIDFromOpenIDConnectProvider`
次のコード例は、`Remove-IAMClientIDFromOpenIDConnectProvider` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ARN が `arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com` である IAM OIDC プロバイダーに関連付けられているクライアント ID のリストから、クライアント ID `My-TestApp-3` を削除します。**
```
Remove-IAMClientIDFromOpenIDConnectProvider -ClientID My-TestApp-3 -OpenIDConnectProviderArn arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[RemoveClientIdFromOpenIdConnectProvider](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMGroup`
次のコード例は、`Remove-IAMGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`MyTestGroup` という名前の IAM グループを削除します。最初のコマンドはグループのメンバーであるすべての IAM ユーザーを削除し、2 番目のコマンドは IAM グループを削除します。どちらのコマンドも、確認を求めるプロンプトが表示されなくても機能します。**
```
(Get-IAMGroup -GroupName MyTestGroup).Users | Remove-IAMUserFromGroup -GroupName MyTestGroup -Force
Remove-IAMGroup -GroupName MyTestGroup -Force
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMGroupPolicy`
次のコード例は、`Remove-IAMGroupPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`TesterPolicy` という名前のインラインポリシーを IAM グループ `Testers` から削除します。そのグループのユーザーは、そのポリシーで定義されているアクセス権限をすぐに失います。**
```
Remove-IAMGroupPolicy -GroupName Testers -PolicyName TestPolicy
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteGroupPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMInstanceProfile`
次のコード例は、`Remove-IAMInstanceProfile` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`MyAppInstanceProfile` という名前の EC2 インスタンスプロファイルを削除します。最初のコマンドはインスタンスプロファイルからすべてのロールをデタッチし、2 番目のコマンドはインスタンスプロファイルを削除します。**
```
(Get-IAMInstanceProfile -InstanceProfileName MyAppInstanceProfile).Roles | Remove-IAMRoleFromInstanceProfile -InstanceProfileName MyAppInstanceProfile
Remove-IAMInstanceProfile -InstanceProfileName MyAppInstanceProfile
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteInstanceProfile](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMLoginProfile`
次のコード例は、`Remove-IAMLoginProfile` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`Bob` という名前の IAM ユーザーからログインプロファイルを削除します。これにより、ユーザーは AWS コンソールにサインインできなくなります。ユーザーアカウントにアタッチされている可能性のある AWS アクセスキーを使用して、ユーザーが AWS CLI、PowerShell、または API コールを実行できないようにします。**
```
Remove-IAMLoginProfile -UserName Bob
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteLoginProfile](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMOpenIDConnectProvider`
次のコード例は、`Remove-IAMOpenIDConnectProvider` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、プロバイダー `example.oidcprovider.com` に接続する IAM OIDC プロバイダーを削除します。ロールの信頼ポリシーの `Principal` 要素で、このプロバイダーを参照するロールをすべて更新または削除してください。**
```
Remove-IAMOpenIDConnectProvider -OpenIDConnectProviderArn arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteOpenIdConnectProvider](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMPolicy`
次のコード例は、`Remove-IAMPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ARN が `arn:aws:iam::123456789012:policy/MySamplePolicy` であるポリシーを削除します。ポリシーを削除する前に、`Remove-IAMPolicyVersion` を実行して、デフォルト以外のすべてのバージョンを削除する必要があります。また、すべての IAM ユーザー、グループ、またはロールからポリシーをデタッチする必要があります。**
```
Remove-IAMPolicy -PolicyArn arn:aws:iam::123456789012:policy/MySamplePolicy
```
**例 2: この例では、最初にデフォルト以外のポリシーバージョンをすべて削除し、アタッチされているすべての IAM エンティティからデタッチして、最後にポリシー自体を削除することでポリシーを削除します。1 行目では、ポリシーオブジェクトを取得します。2 行目では、デフォルトバージョンとしてフラグが立てられていないすべてのポリシーバージョンをコレクションに取得し、コレクション内の各ポリシーを削除します。3 行目では、ポリシーがアタッチされているすべての IAM ユーザー、グループ、およびロールを取得します。4 行目から 6 行目では、アタッチされている各エンティティからポリシーをデタッチします。最後の行では、このコマンドを使用して管理ポリシーと残りのデフォルトバージョンを削除します。この例には、確認を求めるプロンプトを非表示にするための `-Force` switch パラメータが、このパラメータを必要とする行に含まれています。**
```
$pol = Get-IAMPolicy -PolicyArn arn:aws:iam::123456789012:policy/MySamplePolicy
Get-IAMPolicyVersions -PolicyArn $pol.Arn | where {-not $_.IsDefaultVersion} | Remove-IAMPolicyVersion -PolicyArn $pol.Arn -force
$attached = Get-IAMEntitiesForPolicy -PolicyArn $pol.Arn
$attached.PolicyGroups | Unregister-IAMGroupPolicy -PolicyArn $pol.arn
$attached.PolicyRoles | Unregister-IAMRolePolicy -PolicyArn $pol.arn
$attached.PolicyUsers | Unregister-IAMUserPolicy -PolicyArn $pol.arn
Remove-IAMPolicy $pol.Arn -Force
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeletePolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMPolicyVersion`
次のコード例は、`Remove-IAMPolicyVersion` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`v2` と識別されたバージョンを ARN が `arn:aws:iam::123456789012:policy/MySamplePolicy` であるポリシーから削除します。**
```
Remove-IAMPolicyVersion -PolicyArn arn:aws:iam::123456789012:policy/MySamplePolicy -VersionID v2
```
**例 2: この例では、最初にデフォルト以外のポリシーバージョンをすべて削除し、次にポリシー自体を削除することでポリシーを削除します。1 行目では、ポリシーオブジェクトを取得します。2 行目では、デフォルトとしてフラグが立てられていないすべてのポリシーバージョンをコレクションに取得し、このコマンドを使用してコレクション内の各ポリシーを削除します。最後の行では、ポリシー自体と残りのデフォルトバージョンを削除します。管理ポリシーを正常に削除するには、`Unregister-IAMUserPolicy`、`Unregister-IAMGroupPolicy`、`Unregister-IAMRolePolicy` コマンドを使用して、ユーザー、グループ、またはロールからポリシーをデタッチする必要があることに注意してください。`Remove-IAMPolicy` コマンドレットの例を参照してください。**
```
$pol = Get-IAMPolicy -PolicyArn arn:aws:iam::123456789012:policy/MySamplePolicy
Get-IAMPolicyVersions -PolicyArn $pol.Arn | where {-not $_.IsDefaultVersion} | Remove-IAMPolicyVersion -PolicyArn $pol.Arn -force
Remove-IAMPolicy -PolicyArn $pol.Arn -force
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeletePolicyVersion](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMRole`
次のコード例は、`Remove-IAMRole` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、現在の IAM アカウントから `MyNewRole` という名前のロールを削除します。ロールを削除する前に、まず `Unregister-IAMRolePolicy` コマンドを使用して、管理ポリシーをデタッチする必要があります。インラインポリシーは、ロールと共に削除されます。**
```
Remove-IAMRole -RoleName MyNewRole
```
**例 2: この例では、`MyNewRole` という名前のロールから管理ポリシーをすべてデタッチして、ロールを削除します。最初の行では、ロールにアタッチされているすべての管理ポリシーをコレクションとして取得し、コレクション内の各ポリシーをロールからデタッチします。2 行目では、ロール自体を削除します。インラインポリシーは、ロールと共に削除されます。**
```
Get-IAMAttachedRolePolicyList -RoleName MyNewRole | Unregister-IAMRolePolicy -RoleName MyNewRole
Remove-IAMRole -RoleName MyNewRole
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteRole](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMRoleFromInstanceProfile`
次のコード例は、`Remove-IAMRoleFromInstanceProfile` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`MyNewRole` という名前の EC2 インスタンスプロファイルから `MyNewRole` という名前のロールを削除します。IAM コンソールで作成されたインスタンスプロファイルは、この例のように、常にロールと同じ名前になります。API または CLI で作成する場合、名前は異なる場合があります。**
```
Remove-IAMRoleFromInstanceProfile -InstanceProfileName MyNewRole -RoleName MyNewRole -Force
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[RemoveRoleFromInstanceProfile](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMRolePermissionsBoundary`
次のコード例は、`Remove-IAMRolePermissionsBoundary` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例は、IAM ロールにアタッチされたアクセス許可の境界を削除する方法を示しています。**
```
Remove-IAMRolePermissionsBoundary -RoleName MyRoleName
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteRolePermissionsBoundary](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMRolePolicy`
次のコード例は、`Remove-IAMRolePolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、IAM ロール `S3BackupRole` に埋め込まれているインラインポリシー `S3AccessPolicy` を削除します。**
```
Remove-IAMRolePolicy -PolicyName S3AccessPolicy -RoleName S3BackupRole
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteRolePolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMRoleTag`
次のコード例は、`Remove-IAMRoleTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、タグキーが「abac」の「MyRoleName」という名前のロールからタグを削除します。複数のタグを削除するには、カンマで区切ったタグキーリストを指定します。**
```
Remove-IAMRoleTag -RoleName MyRoleName -TagKey "abac","xyzw"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UntagRole](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMSAMLProvider`
次のコード例は、`Remove-IAMSAMLProvider` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ARN が `arn:aws:iam::123456789012:saml-provider/SAMLADFSProvider` である IAM SAML 2.0 プロバイダーを削除します。**
```
Remove-IAMSAMLProvider -SAMLProviderArn arn:aws:iam::123456789012:saml-provider/SAMLADFSProvider
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteSAMLProvider](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMServerCertificate`
次のコード例は、`Remove-IAMServerCertificate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`MyServerCert` という名前のサーバー証明書を削除します。**
```
Remove-IAMServerCertificate -ServerCertificateName MyServerCert
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteServerCertificate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMServiceLinkedRole`
次のコード例は、`Remove-IAMServiceLinkedRole` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、サービスにリンクされたロールを削除しました。サービスがこのロールをまだ使用している場合、このコマンドは失敗することに注意してください。**
```
Remove-IAMServiceLinkedRole -RoleName AWSServiceRoleForAutoScaling_RoleNameEndsWithThis
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteServiceLinkedRole](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMSigningCertificate`
次のコード例は、`Remove-IAMSigningCertificate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`Bob` という名前の IAM ユーザーから ID `Y3EK7RMEXAMPLESV33FCREXAMPLEMJLU` の付いた署名証明書を削除します。**
```
Remove-IAMSigningCertificate -UserName Bob -CertificateId Y3EK7RMEXAMPLESV33FCREXAMPLEMJLU
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteSigningCertificate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMUser`
次のコード例は、`Remove-IAMUser` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`Bob` という名前の IAM ユーザーを削除します。**
```
Remove-IAMUser -UserName Bob
```
**例 2: この例では、`Theresa` という名前の IAM ユーザーと、最初に削除する必要がある要素をすべて削除します。**
```
$name = "Theresa"
# find any groups and remove user from them
$groups = Get-IAMGroupForUser -UserName $name
foreach ($group in $groups) { Remove-IAMUserFromGroup -GroupName $group.GroupName -UserName $name -Force }
# find any inline policies and delete them
$inlinepols = Get-IAMUserPolicies -UserName $name
foreach ($pol in $inlinepols) { Remove-IAMUserPolicy -PolicyName $pol -UserName $name -Force}
# find any managed polices and detach them
$managedpols = Get-IAMAttachedUserPolicies -UserName $name
foreach ($pol in $managedpols) { Unregister-IAMUserPolicy -PolicyArn $pol.PolicyArn -UserName $name }
# find any signing certificates and delete them
$certs = Get-IAMSigningCertificate -UserName $name
foreach ($cert in $certs) { Remove-IAMSigningCertificate -CertificateId $cert.CertificateId -UserName $name -Force }
# find any access keys and delete them
$keys = Get-IAMAccessKey -UserName $name
foreach ($key in $keys) { Remove-IAMAccessKey -AccessKeyId $key.AccessKeyId -UserName $name -Force }
# delete the user's login profile, if one exists - note: need to use try/catch to suppress not found error
try { $prof = Get-IAMLoginProfile -UserName $name -ea 0 } catch { out-null }
if ($prof) { Remove-IAMLoginProfile -UserName $name -Force }
# find any MFA device, detach it, and if virtual, delete it.
$mfa = Get-IAMMFADevice -UserName $name
if ($mfa) {
Disable-IAMMFADevice -SerialNumber $mfa.SerialNumber -UserName $name
if ($mfa.SerialNumber -like "arn:*") { Remove-IAMVirtualMFADevice -SerialNumber $mfa.SerialNumber }
}
# finally, remove the user
Remove-IAMUser -UserName $name -Force
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteUser](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMUserFromGroup`
次のコード例は、`Remove-IAMUserFromGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、IAM ユーザー `Bob` をグループ `Testers` から削除します。**
```
Remove-IAMUserFromGroup -GroupName Testers -UserName Bob
```
**例 2: この例では、IAM ユーザー `Theresa` がメンバーとなっているグループをすべて検索し、それらのグループから `Theresa` を削除します。**
```
$groups = Get-IAMGroupForUser -UserName Theresa
foreach ($group in $groups) { Remove-IAMUserFromGroup -GroupName $group.GroupName -UserName Theresa -Force }
```
**例 3: この例は、IAM ユーザー `Bob` を `Testers` グループから削除する別の方法を示しています。**
```
Get-IAMGroupForUser -UserName Bob | Remove-IAMUserFromGroup -UserName Bob -GroupName Testers -Force
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[RemoveUserFromGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMUserPermissionsBoundary`
次のコード例は、`Remove-IAMUserPermissionsBoundary` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例は、IAM ユーザーにアタッチされたアクセス許可の境界を削除する方法を示しています。**
```
Remove-IAMUserPermissionsBoundary -UserName joe
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteUserPermissionsBoundary](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMUserPolicy`
次のコード例は、`Remove-IAMUserPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`Bob` という名前の IAM ユーザーに埋め込まれている `AccessToEC2Policy` という名前のインラインポリシーを削除します。**
```
Remove-IAMUserPolicy -PolicyName AccessToEC2Policy -UserName Bob
```
**例 2: この例では、`Theresa` という名前の IAM ユーザーに埋め込まれているすべてのインラインポリシーを検索し、削除します。**
```
$inlinepols = Get-IAMUserPolicies -UserName Theresa
foreach ($pol in $inlinepols) { Remove-IAMUserPolicy -PolicyName $pol -UserName Theresa -Force}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteUserPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMUserTag`
次のコード例は、`Remove-IAMUserTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、タグキーが「abac」と「xyzw」の「joe」という名前のユーザーからタグを削除します。複数のタグを削除するには、カンマで区切ったタグキーリストを指定します。**
```
Remove-IAMUserTag -UserName joe -TagKey "abac","xyzw"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UntagUser](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-IAMVirtualMFADevice`
次のコード例は、`Remove-IAMVirtualMFADevice` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ARN が `arn:aws:iam::123456789012:mfa/bob` である IAM 仮想 MFA デバイスを削除します。**
```
Remove-IAMVirtualMFADevice -SerialNumber arn:aws:iam::123456789012:mfa/bob
```
**例 2: この例では、IAM ユーザー Theresa に MFA デバイスが割り当てられているかどうかを確認します。割り当てられているデバイスが見つかった場合、そのデバイスはその IAM ユーザーに対して無効になります。デバイスが仮想の場合は、そのデバイスも削除されます。**
```
$mfa = Get-IAMMFADevice -UserName Theresa
if ($mfa) {
Disable-IAMMFADevice -SerialNumber $mfa.SerialNumber -UserName $name
if ($mfa.SerialNumber -like "arn:*") { Remove-IAMVirtualMFADevice -SerialNumber $mfa.SerialNumber }
}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteVirtualMfaDevice](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Request-IAMCredentialReport`
次のコード例は、`Request-IAMCredentialReport` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、4 時間ごとに実行できる新しいレポートの生成を要求しています。最新のレポートがまだ新しい場合、[状態] フィールドには `COMPLETE` と表示されます。`Get-IAMCredentialReport` を使用して、完成したレポートを表示します。**
```
Request-IAMCredentialReport
```
**出力:**
```
Description State
----------- -----
No report exists. Starting a new report generation task STARTED
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GenerateCredentialReport](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Request-IAMServiceLastAccessedDetail`
次のコード例は、`Request-IAMServiceLastAccessedDetail` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例は GenerateServiceLastAccessedDetails API と同等のコマンドレットです。これにより、Get-IAMServiceLastAccessedDetail と Get-IAMServiceLastAccessedDetailWithEntity で使用できるジョブ ID が提供されます。**
```
Request-IAMServiceLastAccessedDetail -Arn arn:aws:iam::123456789012:user/TestUser
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GenerateServiceLastAccessedDetails](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Set-IAMDefaultPolicyVersion`
次のコード例は、`Set-IAMDefaultPolicyVersion` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: ARN が `arn:aws:iam::123456789012:policy/MyPolicy` であるポリシーの `v2` バージョンをデフォルトのアクティブなバージョンとして設定します。**
```
Set-IAMDefaultPolicyVersion -PolicyArn arn:aws:iam::123456789012:policy/MyPolicy -VersionId v2
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[SetDefaultPolicyVersion](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Set-IAMRolePermissionsBoundary`
次のコード例は、`Set-IAMRolePermissionsBoundary` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例は、IAM ロールのアクセス許可の境界を設定する方法を示しています。 AWS 管理ポリシーまたはカスタムポリシーをアクセス許可の境界として設定できます。**
```
Set-IAMRolePermissionsBoundary -RoleName MyRoleName -PermissionsBoundary arn:aws:iam::123456789012:policy/intern-boundary
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutRolePermissionsBoundary](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Set-IAMUserPermissionsBoundary`
次のコード例は、`Set-IAMUserPermissionsBoundary` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例は、ユーザーのアクセス許可の境界を設定する方法を示しています。 AWS 管理ポリシーまたはカスタムポリシーをアクセス許可の境界として設定できます。 **
```
Set-IAMUserPermissionsBoundary -UserName joe -PermissionsBoundary arn:aws:iam::123456789012:policy/intern-boundary
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutUserPermissionsBoundary](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Sync-IAMMFADevice`
次のコード例は、`Sync-IAMMFADevice` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、IAM ユーザー `Bob` に関連付けられていて、ARN が `arn:aws:iam::123456789012:mfa/bob` である MFA デバイスを、2 つの認証コードを提供した認証プログラムと同期します。**
```
Sync-IAMMFADevice -SerialNumber arn:aws:iam::123456789012:mfa/theresa -AuthenticationCode1 123456 -AuthenticationCode2 987654 -UserName Bob
```
**例 2: この例では、IAM ユーザー `Theresa` に関連付けられている IAM MFA デバイスを、シリアル番号が `ABCD12345678` であり、2 つの認証コードを提供した物理デバイスと同期します。**
```
Sync-IAMMFADevice -SerialNumber ABCD12345678 -AuthenticationCode1 123456 -AuthenticationCode2 987654 -UserName Theresa
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ResyncMfaDevice](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Unregister-IAMGroupPolicy`
次のコード例は、`Unregister-IAMGroupPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ARN が `arn:aws:iam::123456789012:policy/TesterAccessPolicy` である管理グループポリシーを `Testers` という名前のグループからデタッチします。**
```
Unregister-IAMGroupPolicy -GroupName Testers -PolicyArn arn:aws:iam::123456789012:policy/TesterAccessPolicy
```
**例 2: この例では、`Testers` という名前のグループにアタッチされているすべての管理ポリシーを検索し、グループからデタッチします。**
```
Get-IAMAttachedGroupPolicies -GroupName Testers | Unregister-IAMGroupPolicy -Groupname Testers
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DetachGroupPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Unregister-IAMRolePolicy`
次のコード例は、`Unregister-IAMRolePolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ARN が `arn:aws:iam::123456789012:policy/FederatedTesterAccessPolicy` である管理グループポリシーを `FedTesterRole` という名前のロールからデタッチします。**
```
Unregister-IAMRolePolicy -RoleName FedTesterRole -PolicyArn arn:aws:iam::123456789012:policy/FederatedTesterAccessPolicy
```
**例 2: この例では、`FedTesterRole` という名前のロールにアタッチされているすべての管理ポリシーを検索し、ロールからデタッチします。**
```
Get-IAMAttachedRolePolicyList -RoleName FedTesterRole | Unregister-IAMRolePolicy -Rolename FedTesterRole
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DetachRolePolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Unregister-IAMUserPolicy`
次のコード例は、`Unregister-IAMUserPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ARN が `arn:aws:iam::123456789012:policy/TesterPolicy` である管理ポリシーを `Bob` という名前の IAM ユーザーからデタッチします。**
```
Unregister-IAMUserPolicy -UserName Bob -PolicyArn arn:aws:iam::123456789012:policy/TesterPolicy
```
**例 2: この例では、`Theresa` という名前の IAM ユーザーにアタッチされているすべての管理ポリシーを検索し、それらのポリシーをユーザーからデタッチします。**
```
Get-IAMAttachedUserPolicyList -UserName Theresa | Unregister-IAMUserPolicy -Username Theresa
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DetachUserPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-IAMAccessKey`
次のコード例は、`Update-IAMAccessKey` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`Bob` という名前の IAM ユーザーのアクセスキー `AKIAIOSFODNN7EXAMPLE` のステータスを `Inactive` に変更します。**
```
Update-IAMAccessKey -UserName Bob -AccessKeyId AKIAIOSFODNN7EXAMPLE -Status Inactive
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateAccessKey](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-IAMAccountPasswordPolicy`
次のコード例は、`Update-IAMAccountPasswordPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した設定でアカウントのパスワードポリシーを更新します。コマンドに含まれていないパラメータは変更されないままにはならないことに注意してください。代わりに、デフォルト値にリセットされます。**
```
Update-IAMAccountPasswordPolicy -AllowUsersToChangePasswords $true -HardExpiry $false -MaxPasswordAge 90 -MinimumPasswordLength 8 -PasswordReusePrevention 20 -RequireLowercaseCharacters $true -RequireNumbers $true -RequireSymbols $true -RequireUppercaseCharacters $true
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateAccountPasswordPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-IAMAssumeRolePolicy`
次のコード例は、`Update-IAMAssumeRolePolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`ClientRole` という名前の IAM ロールを新しい信頼ポリシーで更新します。その内容は、ファイル `ClientRolePolicy.json` から取得されます。JSON ファイルの内容を正常に処理するには、`-Raw` スイッチパラメータを使用する必要があることに注意してください。**
```
Update-IAMAssumeRolePolicy -RoleName ClientRole -PolicyDocument (Get-Content -raw ClientRolePolicy.json)
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateAssumeRolePolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-IAMGroup`
次のコード例は、`Update-IAMGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、IAM グループ `Testers` の名前を `AppTesters` に変更します。**
```
Update-IAMGroup -GroupName Testers -NewGroupName AppTesters
```
**例 2: この例では、IAM グループ `AppTesters` のパスを `/Org1/Org2/` に変更します。これにより、グループの ARN が `arn:aws:iam::123456789012:group/Org1/Org2/AppTesters` に変更されます。**
```
Update-IAMGroup -GroupName AppTesters -NewPath /Org1/Org2/
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-IAMLoginProfile`
次のコード例は、`Update-IAMLoginProfile` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、IAM ユーザー `Bob` に新しい一時パスワードを設定し、ユーザーが次回サインインしたときにパスワードを変更するようユーザーに要求します。**
```
Update-IAMLoginProfile -UserName Bob -Password "P@ssw0rd1234" -PasswordResetRequired $true
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateLoginProfile](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-IAMOpenIDConnectProviderThumbprint`
次のコード例は、`Update-IAMOpenIDConnectProviderThumbprint` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ARN が `arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com` である OIDC プロバイダーの証明書サムプリントリストを更新して、新しいサムプリントを使用します。OIDC プロバイダーは、プロバイダーに関連付けられている証明書が変更されると、新しい値を共有します。**
```
Update-IAMOpenIDConnectProviderThumbprint -OpenIDConnectProviderArn arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com -ThumbprintList 7359755EXAMPLEabc3060bce3EXAMPLEec4542a3
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateOpenIdConnectProviderThumbprint](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-IAMRole`
次のコード例は、`Update-IAMRole` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ロールの説明と、ロールのセッションをリクエストできる最大セッション期間の値 (秒単位) を更新します。**
```
Update-IAMRole -RoleName MyRoleName -Description "My testing role" -MaxSessionDuration 43200
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateRole](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-IAMRoleDescription`
次のコード例は、`Update-IAMRoleDescription` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、アカウントの IAM ロールの説明を更新します。**
```
Update-IAMRoleDescription -RoleName MyRoleName -Description "My testing role"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateRoleDescription](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-IAMSAMLProvider`
次のコード例は、`Update-IAMSAMLProvider` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ARN が `arn:aws:iam::123456789012:saml-provider/SAMLADFS` である IAM の SAML プロバイダーを、ファイル `SAMLMetaData.xml` の新しい SAML メタデータドキュメントで更新します。JSON ファイルの内容を正常に処理するには、`-Raw` スイッチパラメータを使用する必要があることに注意してください。**
```
Update-IAMSAMLProvider -SAMLProviderArn arn:aws:iam::123456789012:saml-provider/SAMLADFS -SAMLMetadataDocument (Get-Content -Raw SAMLMetaData.xml)
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateSamlProvider](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-IAMServerCertificate`
次のコード例は、`Update-IAMServerCertificate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`MyServerCertificate` という証明書の名前を `MyRenamedServerCertificate` に変更します。**
```
Update-IAMServerCertificate -ServerCertificateName MyServerCertificate -NewServerCertificateName MyRenamedServerCertificate
```
**例 2: この例では、`MyServerCertificate` という証明書を /Org1/Org2/ というパスに移動します。これにより、リソースの ARN が `arn:aws:iam::123456789012:server-certificate/Org1/Org2/MyServerCertificate` に変更されます。**
```
Update-IAMServerCertificate -ServerCertificateName MyServerCertificate -NewPath /Org1/Org2/
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateServerCertificate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-IAMSigningCertificate`
次のコード例は、`Update-IAMSigningCertificate` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`Bob` という名前の IAM ユーザーに関連付けられ、証明書 ID が `Y3EK7RMEXAMPLESV33FCREXAMPLEMJLU` である証明書を更新し、無効としてマークされるようにします。**
```
Update-IAMSigningCertificate -CertificateId Y3EK7RMEXAMPLESV33FCREXAMPLEMJLU -UserName Bob -Status Inactive
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateSigningCertificate](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-IAMUser`
次のコード例は、`Update-IAMUser` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、IAM ユーザー `Bob` の名前を `Robert` に変更します。**
```
Update-IAMUser -UserName Bob -NewUserName Robert
```
**例 2: この例では、IAM ユーザー `Bob` のパスを `/Org1/Org2/` に変更します。これにより、ユーザーの ARN は実質的に `arn:aws:iam::123456789012:user/Org1/Org2/bob` に変更されます。**
```
Update-IAMUser -UserName Bob -NewPath /Org1/Org2/
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateUser](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Write-IAMGroupPolicy`
次のコード例は、`Write-IAMGroupPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`AppTesterPolicy` という名前のインラインポリシーを作成し、IAM グループ `AppTesters` に埋め込みます。同じ名前のインラインポリシーが既に存在する場合、上書きされます。JSON ポリシーの内容がファイル `apptesterpolicy.json` に送られます。JSON ファイルの内容を正常に処理するには、`-Raw` パラメータを使用する必要があることに注意してください。**
```
Write-IAMGroupPolicy -GroupName AppTesters -PolicyName AppTesterPolicy -PolicyDocument (Get-Content -Raw apptesterpolicy.json)
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutGroupPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Write-IAMRolePolicy`
次のコード例は、`Write-IAMRolePolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`FedTesterRolePolicy` という名前のインラインポリシーを作成し、IAM ロール `FedTesterRole` に埋め込みます。同じ名前のインラインポリシーが既に存在する場合、上書きされます。JSON ポリシーの内容は、ファイル `FedTesterPolicy.json` から取得されます。JSON ファイルの内容を正常に処理するには、`-Raw` パラメータを使用する必要があることに注意してください。**
```
Write-IAMRolePolicy -RoleName FedTesterRole -PolicyName FedTesterRolePolicy -PolicyDocument (Get-Content -Raw FedTesterPolicy.json)
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutRolePolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Write-IAMUserPolicy`
次のコード例は、`Write-IAMUserPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`EC2AccessPolicy` という名前のインラインポリシーを作成し、IAM ユーザー `Bob` に埋め込みます。同じ名前のインラインポリシーが既に存在する場合、上書きされます。JSON ポリシーの内容は、ファイル `EC2AccessPolicy.json` から取得されます。JSON ファイルの内容を正常に処理するには、`-Raw` パラメータを使用する必要があることに注意してください。**
```
Write-IAMUserPolicy -UserName Bob -PolicyName EC2AccessPolicy -PolicyDocument (Get-Content -Raw EC2AccessPolicy.json)
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutUserPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用した Kinesis の例
次のコード例は、Kinesis で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Get-KINRecord`
次のコード例は、`Get-KINRecord` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、一連の 1 つ以上のレコードからデータを返して抽出する方法を示しています。Get-KINRecord に供給されたイテレータは、この例で変数 \$1records にキャプチャされるレコードの開始位置を決定します。その後、\$1records コレクションにインデックスを付けることで、個々のレコードにアクセスできます。レコード内のデータが UTF-8 でエンコードされたテキストであると仮定すると、最終コマンドは、オブジェクト内の MemoryStream からデータを抽出してテキストとしてコンソールに返す方法を示します。**
```
$records
$records = Get-KINRecord -ShardIterator "AAAAAAAAAAGIc....9VnbiRNaP"
```
**出力:**
```
MillisBehindLatest NextShardIterator Records
------------------ ----------------- -------
0 AAAAAAAAAAERNIq...uDn11HuUs {Key1, Key2}
```
```
$records.Records[0]
```
**出力:**
```
ApproximateArrivalTimestamp Data PartitionKey SequenceNumber
--------------------------- ---- ------------ --------------
3/7/2016 5:14:33 PM System.IO.MemoryStream Key1 4955986459776...931586
```
```
[Text.Encoding]::UTF8.GetString($records.Records[0].Data.ToArray())
```
**出力:**
```
test data from string
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetRecords](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-KINShardIterator`
次のコード例は、`Get-KINShardIterator` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたシャードと開始位置のシャードイテレータを返します。シャード識別子とシーケンス番号の詳細は、返されたストリームオブジェクトのシャードコレクションを参照することで、Get-KINStream コマンドレットの出力から取得できます。返されたイテレータを Get-KINRecord コマンドレットとともに使用して、シャード内のデータレコードをプルできます。**
```
Get-KINShardIterator -StreamName "mystream" -ShardId "shardId-000000000000" -ShardIteratorType AT_SEQUENCE_NUMBER -StartingSequenceNumber "495598645..."
```
**出力:**
```
AAAAAAAAAAGIc....9VnbiRNaP
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetShardIterator](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-KINStream`
次のコード例は、`Get-KINStream` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたストリームの詳細を返します。**
```
Get-KINStream -StreamName "mystream"
```
**出力:**
```
HasMoreShards : False
RetentionPeriodHours : 24
Shards : {}
StreamARN : arn:aws:kinesis:us-west-2:123456789012:stream/mystream
StreamName : mystream
StreamStatus : ACTIVE
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeStream](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-KINStream`
次のコード例は、`New-KINStream` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 新しいストリームを作成します。**
```
New-KINStream -StreamName "mystream" -ShardCount 1
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateStream](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-KINStream`
次のコード例は、`Remove-KINStream` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたストリームを削除します。コマンドを実行する前に確認を求められます。確認メッセージを非表示にするには -Force スイッチを使用します。**
```
Remove-KINStream -StreamName "mystream"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteStream](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Write-KINRecord`
次のコード例は、`Write-KINRecord` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: -Text パラメータに指定された文字列を含むレコードを書き込みます。**
```
Write-KINRecord -Text "test data from string" -StreamName "mystream" -PartitionKey "Key1"
```
**例 2: 指定されたファイルに含まれるデータを含むレコードを書き込みます。ファイルはバイトのシーケンスとして扱われるため、テキストが含まれている場合は、このコマンドレットで使用する前に、必要なエンコードで記述する必要があります。**
```
Write-KINRecord -FilePath "C:\TestData.txt" -StreamName "mystream" -PartitionKey "Key2"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutRecord](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用した Lambda の例
次のコード例は、Lambda で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-LMResourceTag`
次のコード例は、`Add-LMResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 3 つのタグ (Washington、Oregon、California) およびそれぞれに関連付けされた値を、ARN で識別される指定の関数に追加します。**
```
Add-LMResourceTag -Resource "arn:aws:lambda:us-west-2:123456789012:function:MyFunction" -Tag @{ "Washington" = "Olympia"; "Oregon" = "Salem"; "California" = "Sacramento" }
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[TagResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-LMAccountSetting`
次のコード例は、`Get-LMAccountSetting` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、アカウントの制限値と使用量を比較するための情報を表示します。**
```
Get-LMAccountSetting | Select-Object @{Name="TotalCodeSizeLimit";Expression={$_.AccountLimit.TotalCodeSize}}, @{Name="TotalCodeSizeUsed";Expression={$_.AccountUsage.TotalCodeSize}}
```
**出力:**
```
TotalCodeSizeLimit TotalCodeSizeUsed
------------------ -----------------
80530636800 15078795
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetAccountSettings](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-LMAlias`
次のコード例は、`Get-LMAlias` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、特定の Lambda 関数エイリアスのルーティング設定の重点を取得します。**
```
Get-LMAlias -FunctionName "MylambdaFunction123" -Name "newlabel1" -Select RoutingConfig
```
**出力:**
```
AdditionalVersionWeights
------------------------
{[1, 0.6]}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetAlias](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-LMFunctionConcurrency`
次のコード例は、`Get-LMFunctionConcurrency` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Lambda 関数の予約済み同時実行数が取得されます**
```
Get-LMFunctionConcurrency -FunctionName "MylambdaFunction123" -Select *
```
**出力:**
```
ReservedConcurrentExecutions
----------------------------
100
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetFunctionConcurrency](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-LMFunctionConfiguration`
次のコード例は、`Get-LMFunctionConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Lambda 関数のバージョン固有設定を返します。**
```
Get-LMFunctionConfiguration -FunctionName "MylambdaFunction123" -Qualifier "PowershellAlias"
```
**出力:**
```
CodeSha256 : uWOW0R7z+f0VyLuUg7+/D08hkMFsq0SF4seuyUZJ/R8=
CodeSize : 1426
DeadLetterConfig : Amazon.Lambda.Model.DeadLetterConfig
Description : Verson 3 to test Aliases
Environment : Amazon.Lambda.Model.EnvironmentResponse
FunctionArn : arn:aws:lambda:us-east-1:123456789012:function:MylambdaFunction123
:PowershellAlias
FunctionName : MylambdaFunction123
Handler : lambda_function.launch_instance
KMSKeyArn :
LastModified : 2019-12-25T09:52:59.872+0000
LastUpdateStatus : Successful
LastUpdateStatusReason :
LastUpdateStatusReasonCode :
Layers : {}
MasterArn :
MemorySize : 128
RevisionId : 5d7de38b-87f2-4260-8f8a-e87280e10c33
Role : arn:aws:iam::123456789012:role/service-role/lambda
Runtime : python3.8
State : Active
StateReason :
StateReasonCode :
Timeout : 600
TracingConfig : Amazon.Lambda.Model.TracingConfigResponse
Version : 4
VpcConfig : Amazon.Lambda.Model.VpcConfigDetail
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetFunctionConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-LMFunctionList`
次のコード例は、`Get-LMFunctionList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、コードサイズ順にすべての Lambda 関数を表示します**
```
Get-LMFunctionList | Sort-Object -Property CodeSize | Select-Object FunctionName, RunTime, Timeout, CodeSize
```
**出力:**
```
FunctionName Runtime Timeout CodeSize
------------ ------- ------- --------
test python2.7 3 243
MylambdaFunction123 python3.8 600 659
myfuncpython1 python3.8 303 675
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListFunctions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-LMPolicy`
次のコード例は、`Get-LMPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した Lambda 関数の関数ポリシーを表示します**
```
Get-LMPolicy -FunctionName test -Select Policy
```
**出力:**
```
{"Version":"2012-10-17", "Id":"default","Statement":[{"Sid":"xxxx","Effect":"Allow","Principal":{"Service":"sns.amazonaws.com"},"Action":"lambda:InvokeFunction","Resource":"arn:aws:lambda:us-east-1:123456789102:function:test"}]}
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[GetPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-LMProvisionedConcurrencyConfig`
次のコード例は、`Get-LMProvisionedConcurrencyConfig` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Lambda 関数の指定されたエイリアスにプロビジョニングされた同時実行設定を取得します。**
```
C:\>Get-LMProvisionedConcurrencyConfig -FunctionName "MylambdaFunction123" -Qualifier "NewAlias1"
```
**出力:**
```
AllocatedProvisionedConcurrentExecutions : 0
AvailableProvisionedConcurrentExecutions : 0
LastModified : 2020-01-15T03:21:26+0000
RequestedProvisionedConcurrentExecutions : 70
Status : IN_PROGRESS
StatusReason :
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetProvisionedConcurrencyConfig](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-LMProvisionedConcurrencyConfigList`
次のコード例は、`Get-LMProvisionedConcurrencyConfigList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Lambda 関数にプロビジョニングされた同時実行設定のリストを取得します。**
```
Get-LMProvisionedConcurrencyConfigList -FunctionName "MylambdaFunction123"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListProvisionedConcurrencyConfigs](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-LMResourceTag`
次のコード例は、`Get-LMResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定した関数に現在設定されているタグとその値を取得します。**
```
Get-LMResourceTag -Resource "arn:aws:lambda:us-west-2:123456789012:function:MyFunction"
```
**出力:**
```
Key Value
--- -----
California Sacramento
Oregon Salem
Washington Olympia
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-LMVersionsByFunction`
次のコード例は、`Get-LMVersionsByFunction` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Lambda 関数の各バージョンのバージョン固有設定に関するリストを返します。**
```
Get-LMVersionsByFunction -FunctionName "MylambdaFunction123"
```
**出力:**
```
FunctionName Runtime MemorySize Timeout CodeSize LastModified RoleName
------------ ------- ---------- ------- -------- ------------ --------
MylambdaFunction123 python3.8 128 600 659 2020-01-10T03:20:56.390+0000 lambda
MylambdaFunction123 python3.8 128 5 1426 2019-12-25T09:19:02.238+0000 lambda
MylambdaFunction123 python3.8 128 5 1426 2019-12-25T09:39:36.779+0000 lambda
MylambdaFunction123 python3.8 128 600 1426 2019-12-25T09:52:59.872+0000 lambda
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListVersionsByFunction](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-LMAlias`
次のコード例は、`New-LMAlias` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたバージョンおよびルーティング設定の新しい Lambda エイリアスを作成し、受信する呼び出しリクエストの割合を指定します。**
```
New-LMAlias -FunctionName "MylambdaFunction123" -RoutingConfig_AdditionalVersionWeight @{Name="1";Value="0.6} -Description "Alias for version 4" -FunctionVersion 4 -Name "PowershellAlias"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateAlias](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Publish-LMFunction`
次のコード例は、`Publish-LMFunction` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、 AWS Lambda で MyFunction という名前の新しい C\$1 (dotnetcore1.0 ランタイム) 関数を作成し、ローカルファイルシステムの zip ファイルから関数のコンパイルされたバイナリを提供します (相対パスまたは絶対パスを使用できます）。C\$1 Lambda 関数は、AssemblyName::Namespace.ClassName::MethodName の指定を使用して関数のハンドラーを指定します。ハンドラー仕様のアセンブリ名 (.dll サフィックスなし)、名前空間、クラス名、メソッド名の部分を適切に置き換える必要があります。新しい関数には、指定された値で「envvar1」および「envvar2」の環境変数が設定されます。**
```
Publish-LMFunction -Description "My C# Lambda Function" `
-FunctionName MyFunction `
-ZipFilename .\MyFunctionBinaries.zip `
-Handler "AssemblyName::Namespace.ClassName::MethodName" `
-Role "arn:aws:iam::123456789012:role/LambdaFullExecRole" `
-Runtime dotnetcore1.0 `
-Environment_Variable @{ "envvar1"="value";"envvar2"="value" }
```
**出力:**
```
CodeSha256 : /NgBMd...gq71I=
CodeSize : 214784
DeadLetterConfig :
Description : My C# Lambda Function
Environment : Amazon.Lambda.Model.EnvironmentResponse
FunctionArn : arn:aws:lambda:us-west-2:123456789012:function:ToUpper
FunctionName : MyFunction
Handler : AssemblyName::Namespace.ClassName::MethodName
KMSKeyArn :
LastModified : 2016-12-29T23:50:14.207+0000
MemorySize : 128
Role : arn:aws:iam::123456789012:role/LambdaFullExecRole
Runtime : dotnetcore1.0
Timeout : 3
Version : $LATEST
VpcConfig :
```
**例 2: この例は前の例と似ていますが、関数バイナリが最初に Amazon S3 バケット (目的の Lambda 関数と同じリージョンにある必要がある) にアップロードされ、結果の S3 オブジェクトが関数の作成時に参照される点が異なります。**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Key MyFunctionBinaries.zip -File .\MyFunctionBinaries.zip
Publish-LMFunction -Description "My C# Lambda Function" `
-FunctionName MyFunction `
-BucketName amzn-s3-demo-bucket `
-Key MyFunctionBinaries.zip `
-Handler "AssemblyName::Namespace.ClassName::MethodName" `
-Role "arn:aws:iam::123456789012:role/LambdaFullExecRole" `
-Runtime dotnetcore1.0 `
-Environment_Variable @{ "envvar1"="value";"envvar2"="value" }
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateFunction](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Publish-LMVersion`
次のコード例は、`Publish-LMVersion` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Lambda 関数コードの既存のスナップショットのバージョンを作成します**
```
Publish-LMVersion -FunctionName "MylambdaFunction123" -Description "Publishing Existing Snapshot of function code as a new version through Powershell"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PublishVersion](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-LMAlias`
次のコード例は、`Remove-LMAlias` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、コマンドに記述された Lambda 関数のエイリアスを削除します。**
```
Remove-LMAlias -FunctionName "MylambdaFunction123" -Name "NewAlias"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteAlias](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-LMFunction`
次のコード例は、`Remove-LMFunction` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Lambda 関数の特定のバージョンを削除します。**
```
Remove-LMFunction -FunctionName "MylambdaFunction123" -Qualifier '3'
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteFunction](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-LMFunctionConcurrency`
次のコード例は、`Remove-LMFunctionConcurrency` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Lambda 関数の関数同時実行数を削除します。**
```
Remove-LMFunctionConcurrency -FunctionName "MylambdaFunction123"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteFunctionConcurrency](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-LMPermission`
次のコード例は、`Remove-LMPermission` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Lambda 関数の指定された StatementId の関数ポリシーを削除します。**
```
$policy = Get-LMPolicy -FunctionName "MylambdaFunction123" -Select Policy | ConvertFrom-Json| Select-Object -ExpandProperty Statement
Remove-LMPermission -FunctionName "MylambdaFunction123" -StatementId $policy[0].Sid
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[RemovePermission](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-LMProvisionedConcurrencyConfig`
次のコード例は、`Remove-LMProvisionedConcurrencyConfig` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、特定のエイリアスのプロビジョニングされた同時実行設定を削除します。**
```
Remove-LMProvisionedConcurrencyConfig -FunctionName "MylambdaFunction123" -Qualifier "NewAlias1"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteProvisionedConcurrencyConfig](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-LMResourceTag`
次のコード例は、`Remove-LMResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 提供されたタグを関数から削除します。-Force スイッチが指定されていない限り、cmdlet は続行する前に確認を求めます。タグを削除するため、サービスが 1 回呼び出されます。**
```
Remove-LMResourceTag -Resource "arn:aws:lambda:us-west-2:123456789012:function:MyFunction" -TagKey "Washington","Oregon","California"
```
**例 2: 提供されたタグを関数から削除します。-Force スイッチが指定されていない限り、cmdlet は続行する前に確認を求めます。提供されたタグにつき、サービスに 1 回呼び出しが行われます。**
```
"Washington","Oregon","California" | Remove-LMResourceTag -Resource "arn:aws:lambda:us-west-2:123456789012:function:MyFunction"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UntagResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-LMAlias`
次のコード例は、`Update-LMAlias` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、既存の Lambda 関数エイリアスの設定を更新します。RoutingConfiguration の値を更新し、トラフィックの 60% (0.6) をバージョン 1 に変換します。**
```
Update-LMAlias -FunctionName "MylambdaFunction123" -Description " Alias for version 2" -FunctionVersion 2 -Name "newlabel1" -RoutingConfig_AdditionalVersionWeight @{Name="1";Value="0.6}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateAlias](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-LMFunctionCode`
次のコード例は、`Update-LMFunctionCode` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 「MyFunction」という名前の関数を、指定された zip ファイルに含まれる新しいコンテンツで更新します。C\$1 .NET Core Lambda 関数には、zip ファイルはコンパイルされたアセンブリが含まれている必要があります。**
```
Update-LMFunctionCode -FunctionName MyFunction -ZipFilename .\UpdatedCode.zip
```
**例 2: この例は前の例と似ていますが、更新されたコードを含む Amazon S3 オブジェクトを使用して関数を更新します。**
```
Update-LMFunctionCode -FunctionName MyFunction -BucketName amzn-s3-demo-bucket -Key UpdatedCode.zip
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateFunctionCode](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-LMFunctionConfiguration`
次のコード例は、`Update-LMFunctionConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、既存の Lambda 関数の設定を更新します**
```
Update-LMFunctionConfiguration -FunctionName "MylambdaFunction123" -Handler "lambda_function.launch_instance" -Timeout 600 -Environment_Variable @{ "envvar1"="value";"envvar2"="value" } -Role arn:aws:iam::123456789101:role/service-role/lambda -DeadLetterConfig_TargetArn arn:aws:sns:us-east-1: 123456789101:MyfirstTopic
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateFunctionConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Write-LMFunctionConcurrency`
次のコード例は、`Write-LMFunctionConcurrency` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、関数全体の同時実行設定を適用します。**
```
Write-LMFunctionConcurrency -FunctionName "MylambdaFunction123" -ReservedConcurrentExecution 100
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[PutFunctionConcurrency](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Write-LMProvisionedConcurrencyConfig`
次のコード例は、`Write-LMProvisionedConcurrencyConfig` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、プロビジョニングされた同時実行設定を関数のエイリアスに追加します。**
```
Write-LMProvisionedConcurrencyConfig -FunctionName "MylambdaFunction123" -ProvisionedConcurrentExecution 20 -Qualifier "NewAlias1"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutProvisionedConcurrencyConfig](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用した Amazon ML の例
次のコード例は、Amazon ML で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Get-MLBatchPrediction`
次のコード例は、`Get-MLBatchPrediction` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: id ID を含むバッチ予測の詳細なメタデータを返します。**
```
Get-MLBatchPrediction -BatchPredictionId ID
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetBatchPrediction](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-MLBatchPredictionList`
次のコード例は、`Get-MLBatchPredictionList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: リクエストで指定された検索条件に一致するすべての BatchPredictions および関連するデータレコードのリストを返します。**
```
Get-MLBatchPredictionList
```
**例 2: ステータスが COMPLETED であるすべての BatchPredictions のリストを返します。**
```
Get-MLBatchPredictionList -FilterVariable Status -EQ COMPLETED
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeBatchPredictions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-MLDataSource`
次のコード例は、`Get-MLDataSource` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: ID を含む DataSource のメタデータ、ステータス、データファイル情報を返します。**
```
Get-MLDataSource -DataSourceId ID
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetDataSource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-MLDataSourceList`
次のコード例は、`Get-MLDataSourceList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: すべての DataSourcesとそれに関連するデータレコードのリストを返します。**
```
Get-MLDataSourceList
```
**例 2: ステータスが COMPLETED であるすべての DataSources のリストを返します。**
```
Get-MLDataDourceList -FilterVariable Status -EQ COMPLETED
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeDataSources](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-MLEvaluation`
次のコード例は、`Get-MLEvaluation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: ID を含む Evaluation のメタデータとステータスを返します。**
```
Get-MLEvaluation -EvaluationId ID
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetEvaluation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-MLEvaluationList`
次のコード例は、`Get-MLEvaluationList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: すべての Evaluation リソースのリストを返します**
```
Get-MLEvaluationList
```
**例 2: ステータスが COMPLETED であるすべての Evaulation のリストを返します。**
```
Get-MLEvaluationList -FilterVariable Status -EQ COMPLETED
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeEvaluations](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-MLModel`
次のコード例は、`Get-MLModel` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: ID を含む MLModel の詳細メタデータ、ステータス、スキーマ、データファイル情報を返します。**
```
Get-MLModel -ModelId ID
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetMLModel](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-MLModelList`
次のコード例は、`Get-MLModelList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: すべての Model とそれに関連するデータレコードのリストを返します。 **
```
Get-MLModelList
```
**例 2: ステータスが COMPLETED であるすべての Model のリストを返します。**
```
Get-MLModelList -FilterVariable Status -EQ COMPLETED
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeMLModels](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-MLPrediction`
次のコード例は、`Get-MLPrediction` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: ID を含むモデルのリアルタイム予測エンドポイント URL にレコードを送信します。**
```
Get-MLPrediction -ModelId ID -PredictEndpoint URL -Record @{"A" = "B"; "C" = "D";}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[Predict](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-MLBatchPrediction`
次のコード例は、`New-MLBatchPrediction` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: ID を含むモデルの新しいバッチ予測リクエストを作成し、指定 S3 の場所に出力を配置します。**
```
New-MLBatchPrediction -ModelId ID -Name NAME -OutputURI s3://...
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateBatchPrediction](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-MLDataSourceFromS3`
次のコード例は、`New-MLDataSourceFromS3` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 名前が NAME、スキーマが SCHEMA である S3 の場所のデータを使用してデータソースを作成します。**
```
New-MLDataSourceFromS3 -Name NAME -ComputeStatistics $true -DataSpec_DataLocationS3 "s3://BUCKET/KEY" -DataSchema SCHEMA
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateDataSourceFromS3](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-MLEvaluation`
次のコード例は、`New-MLEvaluation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定のデータソース ID とモデル ID の評価を作成します**
```
New-MLEvaluation -Name NAME -DataSourceId DSID -ModelId MID
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateEvaluation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-MLModel`
次のコード例は、`New-MLModel` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: トレーニングデータを使用して新しいモデルを作成します。**
```
New-MLModel -Name NAME -ModelType BINARY -Parameter @{...} -TrainingDataSourceId ID
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateMLModel](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-MLRealtimeEndpoint`
次のコード例は、`New-MLRealtimeEndpoint` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定モデル ID の新しいリアルタイム予測エンドポイントを作成します。**
```
New-MLRealtimeEndpoint -ModelId ID
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateRealtimeEndpoint](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用した Macie の例
次のコード例は、Macie で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Get-MAC2FindingList`
次のコード例は、`Get-MAC2FindingList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 「CREDIT\$1CARD\$1NUMBER」または「US\$1SOCIAL\$1SECURITY\$1NUMBER」タイプの機密データ検出を含む検出結果の FindingIds のリストを返します。**
```
$criterionAddProperties = New-Object Amazon.Macie2.Model.CriterionAdditionalProperties
$criterionAddProperties.Eq = @(
"CREDIT_CARD_NUMBER"
"US_SOCIAL_SECURITY_NUMBER"
)
$FindingCriterion = @{
'classificationDetails.result.sensitiveData.detections.type' = [Amazon.Macie2.Model.CriterionAdditionalProperties]$criterionAddProperties
}
Get-MAC2FindingList -FindingCriteria_Criterion $FindingCriterion -MaxResult 5
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListFindings](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# AWS の料金表 Tools for PowerShell V5 を使用した の例
次のコード例は、 で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています AWS の料金表。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Get-PLSAttributeValue`
次のコード例は、`Get-PLSAttributeValue` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: us-east-1 リージョンの Amazon EC2 の属性「volumeType」の値を返します。**
```
Get-PLSAttributeValue -ServiceCode AmazonEC2 -AttributeName "volumeType" -region us-east-1
```
**出力:**
```
Value
-----
Cold HDD
General Purpose
Magnetic
Provisioned IOPS
Throughput Optimized HDD
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetAttributeValues](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-PLSProduct`
次のコード例は、`Get-PLSProduct` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: Amazon EC2 のすべての製品の詳細を返します。**
```
Get-PLSProduct -ServiceCode AmazonEC2 -Region us-east-1
```
**出力:**
```
{"product":{"productFamily":"Compute Instance","attributes":{"enhancedNetworkingSupported":"Yes","memory":"30.5 GiB","dedicatedEbsThroughput":"800 Mbps","vcpu":"4","locationType":"AWS Region","storage":"EBS only","instanceFamily":"Memory optimized","operatingSystem":"SUSE","physicalProcessor":"Intel Xeon E5-2686 v4 (Broadwell)","clockSpeed":"2.3 GHz","ecu":"Variable","networkPerformance":"Up to 10 Gigabit","servicename":"Amazon Elastic Compute Cloud","instanceType":"r4.xlarge","tenancy":"Shared","usagetype":"USW2-BoxUsage:r4.xlarge","normalizationSizeFactor":"8","processorFeatures":"Intel AVX, Intel AVX2, Intel Turbo","servicecode":"AmazonEC2","licenseModel":"No License required","currentGeneration":"Yes","preInstalledSw":"NA","location":"US West (Oregon)","processorArchitecture":"64-bit","operation":"RunInstances:000g"},...
```
**例 2: us-east-1 リージョン内の Amazon EC2 のデータのうち、SSD ベースの「General Purpose」のボリュームタイプでフィルタリングされたデータを返します。**
```
Get-PLSProduct -ServiceCode AmazonEC2 -Filter @{Type="TERM_MATCH";Field="volumeType";Value="General Purpose"},@{Type="TERM_MATCH";Field="storageMedia";Value="SSD-backed"} -Region us-east-1
```
**出力:**
```
{"product":{"productFamily":"Storage","attributes":{"storageMedia":"SSD-backed","maxThroughputvolume":"160 MB/sec","volumeType":"General Purpose","maxIopsvolume":"10000",...
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetProducts](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-PLSService`
次のコード例は、`Get-PLSService` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: us-east-1 リージョンで使用可能なすべてのサービスコードのメタデータを返します。**
```
Get-PLSService -Region us-east-1
```
**出力:**
```
AttributeNames ServiceCode
-------------- -----------
{productFamily, servicecode, groupDescription, termType...} AWSBudgets
{productFamily, servicecode, termType, usagetype...} AWSCloudTrail
{productFamily, servicecode, termType, usagetype...} AWSCodeCommit
{productFamily, servicecode, termType, usagetype...} AWSCodeDeploy
{productFamily, servicecode, termType, usagetype...} AWSCodePipeline
{productFamily, servicecode, termType, usagetype...} AWSConfig
...
```
**例 2: us-east-1 リージョンの Amazon EC2 サービスのメタデータを返します。**
```
Get-PLSService -ServiceCode AmazonEC2 -Region us-east-1
```
**出力:**
```
AttributeNames ServiceCode
-------------- -----------
{volumeType, maxIopsvolume, instanceCapacity10xlarge, locationType...} AmazonEC2
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeServices](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用した Resource Groups の例
次のコード例は、Resource Groups で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-RGResourceTag`
次のコード例は、`Add-RGResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリソースグループ ARN に値「workboxes」を持つタグキー「Instances」を追加します。**
```
Add-RGResourceTag -Tag @{Instances="workboxes"} -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes
```
**出力:**
```
Arn Tags
--- ----
arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes {[Instances, workboxes]}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[Tag](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Find-RGResource`
次のコード例は、`Find-RGResource` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、タグフィルターを使用してインスタンスリソースタイプの ResourceQuery を作成し、リソースを検索します。**
```
$query = [Amazon.ResourceGroups.Model.ResourceQuery]::new()
$query.Type = [Amazon.ResourceGroups.QueryType]::TAG_FILTERS_1_0
$query.Query = ConvertTo-Json -Compress -Depth 4 -InputObject @{
ResourceTypeFilters = @('AWS::EC2::Instance')
TagFilters = @(@{
Key = 'auto'
Values = @('no')
})
}
Find-RGResource -ResourceQuery $query | Select-Object -ExpandProperty ResourceIdentifiers
```
**出力:**
```
ResourceArn ResourceType
----------- ------------
arn:aws:ec2:eu-west-1:123456789012:instance/i-0123445b6cb7bd67b AWS::EC2::Instance
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[SearchResources](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-RGGroup`
次のコード例は、`Get-RGGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、グループ名に従ってリソースグループを取得します。**
```
Get-RGGroup -GroupName auto-no
```
**出力:**
```
Description GroupArn Name
----------- -------- ----
arn:aws:resource-groups:eu-west-1:123456789012:group/auto-no auto-no
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-RGGroupList`
次のコード例は、`Get-RGGroupList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、既に作成されたリソースグループを一覧表示します。**
```
Get-RGGroupList
```
**出力:**
```
GroupArn GroupName
-------- ---------
arn:aws:resource-groups:eu-west-1:123456789012:group/auto-no auto-no
arn:aws:resource-groups:eu-west-1:123456789012:group/auto-yes auto-yes
arn:aws:resource-groups:eu-west-1:123456789012:group/build600 build600
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListGroups](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-RGGroupQuery`
次のコード例は、`Get-RGGroupQuery` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリソースグループのリソースクエリを取得します。**
```
Get-RGGroupQuery -GroupName auto-no | Select-Object -ExpandProperty ResourceQuery
```
**出力:**
```
Query Type
----- ----
{"ResourceTypeFilters":["AWS::EC2::Instance"],"TagFilters":[{"Key":"auto","Values":["no"]}]} TAG_FILTERS_1_0
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetGroupQuery](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-RGGroupResourceList`
次のコード例は、`Get-RGGroupResourceList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、リソースタイプでフィルタリングされたグループリソースを一覧表示します。**
```
Get-RGGroupResourceList -Filter @{Name="resource-type";Values="AWS::EC2::Instance"} -GroupName auto-yes | Select-Object -ExpandProperty ResourceIdentifiers
```
**出力:**
```
ResourceArn ResourceType
----------- ------------
arn:aws:ec2:eu-west-1:123456789012:instance/i-0123bc45b567890e1 AWS::EC2::Instance
arn:aws:ec2:eu-west-1:123456789012:instance/i-0a1caf2345f67d8dc AWS::EC2::Instance
arn:aws:ec2:eu-west-1:123456789012:instance/i-012e3cb4df567e8aa AWS::EC2::Instance
arn:aws:ec2:eu-west-1:123456789012:instance/i-0fd12dd3456789012 AWS::EC2::Instance
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListGroupResources](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-RGResourceTag`
次のコード例は、`Get-RGResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定されたリソースグループ ARN のタグを一覧表示します。**
```
Get-RGResourceTag -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes
```
**出力:**
```
Key Value
--- -----
Instances workboxes
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-RGGroup`
次のコード例は、`New-RGGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、TestPowerShellGroup という名前の新しいタグベースの AWS Resource Groups リソースグループを作成します。グループには、タグキー「Name」とタグ値「test2」でタグ付けされた現在のリージョンの Amazon EC2 インスタンスが含まれます。コマンドは、クエリとグループのタイプ、および操作の結果を返します。**
```
$ResourceQuery = New-Object -TypeName Amazon.ResourceGroups.Model.ResourceQuery
$ResourceQuery.Type = "TAG_FILTERS_1_0"
$ResourceQuery.Query = '{"ResourceTypeFilters":["AWS::EC2::Instance"],"TagFilters":[{"Key":"Name","Values":["test2"]}]}'
$ResourceQuery
New-RGGroup -Name TestPowerShellGroup -ResourceQuery $ResourceQuery -Description "Test resource group."
```
**出力:**
```
Query Type
----- ----
{"ResourceTypeFilters":["AWS::EC2::Instance"],"TagFilters":[{"Key":"Name","Values":["test2"]}]} TAG_FILTERS_1_0
LoggedAt : 11/20/2018 2:40:59 PM
Group : Amazon.ResourceGroups.Model.Group
ResourceQuery : Amazon.ResourceGroups.Model.ResourceQuery
Tags : {}
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 338
HttpStatusCode : OK
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-RGGroup`
次のコード例は、`Remove-RGGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、名前付きリソースグループを削除します。**
```
Remove-RGGroup -GroupName non-tag-cfn-elbv2
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-RGGroup (DeleteGroup)" on target "non-tag-cfn-elbv2".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
Description GroupArn Name
----------- -------- ----
arn:aws:resource-groups:eu-west-1:123456789012:group/non-tag-cfn-elbv2 non-tag-cfn-elbv2
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-RGResourceTag`
次のコード例は、`Remove-RGResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、リソースグループから指定されたタグを削除します。**
```
Remove-RGResourceTag -Arn arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes -Key Instances
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-RGResourceTag (Untag)" on target "arn:aws:resource-groups:eu-west-1:933303704102:group/workboxes".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
Arn Keys
--- ----
arn:aws:resource-groups:eu-west-1:123456789012:group/workboxes {Instances}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[Untag](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-RGGroup`
次のコード例は、`Update-RGGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、グループの説明を更新します。**
```
Update-RGGroup -GroupName auto-yes -Description "Instances auto-remove"
```
**出力:**
```
Description GroupArn Name
----------- -------- ----
Instances to be cleaned arn:aws:resource-groups:eu-west-1:123456789012:group/auto-yes auto-yes
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-RGGroupQuery`
次のコード例は、`Update-RGGroupQuery` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、クエリオブジェクトを作成し、グループのクエリを更新します。**
```
$query = [Amazon.ResourceGroups.Model.ResourceQuery]::new()
$query.Type = [Amazon.ResourceGroups.QueryType]::TAG_FILTERS_1_0
$query.Query = @{
ResourceTypeFilters = @('AWS::EC2::Instance')
TagFilters = @(@{
Key='Environment'
Values='Build600.11'
})
} | ConvertTo-Json -Compress -Depth 4
Update-RGGroupQuery -GroupName build600 -ResourceQuery $query
```
**出力:**
```
GroupName ResourceQuery
--------- -------------
build600 Amazon.ResourceGroups.Model.ResourceQuery
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateGroupQuery](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用したリソースグループタグ付け API の例
次のコード例は、Resource Groups Tagging API で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-RGTResourceTag`
次のコード例は、`Add-RGTResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、値「beta」と「preprod\$1test」を含むタグキー「stage」と「version」を Amazon S3 バケットと Amazon DynamoDB テーブルに追加します。タグを適用するため、サービスが 1 回呼び出されます。**
```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"
Add-RGTResourceTag -ResourceARNList $arn1,$arn2 -Tag @{ "stage"="beta"; "version"="preprod_test" }
```
**例 2: この例では、指定されたタグと値を Amazon S3 バケットと Amazon DynamoDB テーブルに追加します。コマンドレットにパイプされたリソース ARN ごとに 1 回ずつ、2 回サービスが呼び出されます。**
```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"
$arn1,$arn2 | Add-RGTResourceTag -Tag @{ "stage"="beta"; "version"="preprod_test" }
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[TagResources](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-RGTResource`
次のコード例は、`Get-RGTResource` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: リージョン内のすべてのタグ付けされたリソースと、リソースに関連付けられたタグキーを返します。コマンドレットに -Region パラメータが指定されていない場合、シェルまたは EC2 インスタンスメタデータからリージョンを推測しようとします。**
```
Get-RGTResource
```
**出力:**
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**例 2: リージョン内の指定されたタイプのタグ付けされたリソースをすべて返します。各サービス名とリソースタイプの文字列は、リソースの Amazon リソースネーム (ARN) に埋め込まれている文字列と同じです。**
```
Get-RGTResource -ResourceType "s3"
```
**出力:**
```
ResourceARN Tags
----------- ----
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**例 3: リージョン内の指定されたタイプのタグ付けされたリソースをすべて返します。リソースタイプをコマンドレットにパイプすると、指定されたリソースタイプごとにサービスへの呼び出しが 1 回行われることに注意してください。**
```
"dynamodb","s3" | Get-RGTResource
```
**出力:**
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**例 4: 指定されたフィルターに一致するタグ付けされたすべてのリソースを返します。**
```
Get-RGTResource -TagFilter @{ Key="stage" }
```
**出力:**
```
ResourceARN Tags
----------- ----
arn:aws:s3:::amzn-s3-demo-bucket {stage, version, othertag}
```
**例 5: 指定されたフィルターとリソースタイプに一致するタグ付けされたすべてのリソースを返します。**
```
Get-RGTResource -TagFilter @{ Key="stage" } -ResourceType "dynamodb"
```
**出力:**
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
```
**例 6: 指定されたフィルターに一致するタグ付けされたすべてのリソースを返します。**
```
Get-RGTResource -TagFilter @{ Key="stage"; Values=@("beta","gamma") }
```
**出力:**
```
ResourceARN Tags
----------- ----
arn:aws:dynamodb:us-west-2:123456789012:table/mytable {stage, version}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetResources](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-RGTTagKey`
次のコード例は、`Get-RGTTagKey` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたリージョンのすべてのタグキーを返します。-Region パラメータが指定されていない場合、コマンドレットはデフォルトのシェルリージョンまたは EC2 インスタンスメタデータからリージョンを推測しようとします。タグキーは特定の順序では返されないことに注意してください。**
```
Get-RGTTagKey -region us-west-2
```
**出力:**
```
version
stage
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetTagKeys](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-RGTTagValue`
次のコード例は、`Get-RGTTagValue` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: リージョン内の指定されたタグの値を返します。-Region パラメータが指定されていない場合、コマンドレットはデフォルトのシェルリージョンまたは EC2 インスタンスメタデータからリージョンを推測しようとします。**
```
Get-RGTTagValue -Key "stage" -Region us-west-2
```
**出力:**
```
beta
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetTagValues](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-RGTResourceTag`
次のコード例は、`Remove-RGTResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: Amazon S3 バケットと Amazon DynamoDB テーブルからタグキー「stage」と「version」、および関連する値を削除します。タグを削除するために、サービスが 1 回呼び出されます。タグを削除する前に、コマンドレットで確認を求められます。確認を表示しないようにするには、-Force パラメータを追加します。**
```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"
Remove-RGTResourceTag -ResourceARNList $arn1,$arn2 -TagKey "stage","version"
```
**例 2: Amazon S3 バケットと Amazon DynamoDB テーブルからタグキー「stage」と「version」、および関連する値を削除します。コマンドレットにパイプされたリソース ARN ごとに 1 回ずつ、2 回サービスが呼び出されます。各呼び出しの前に、コマンドレットで確認を求められます。確認を表示しないようにするには、-Force パラメータを追加します。**
```
$arn1 = "arn:aws:s3:::amzn-s3-demo-bucket"
$arn2 = "arn:aws:dynamodb:us-west-2:123456789012:table/mytable"
$arn1,$arn2 | Remove-RGTResourceTag -TagKey "stage","version"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UntagResources](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用した Route 53 の例
次のコード例は、Route AWS Tools for PowerShell V5 5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Edit-R53ResourceRecordSet`
次のコード例は、`Edit-R53ResourceRecordSet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、www.example.com の A レコードを作成し、test.example.com の A レコードを 192.0.2.3 から 192.0.2.1 に変更します。変更 TXT タイプのレコードの値は二重引用符で囲む必要があることに注意してください。詳細については、Amazon Route 53 のドキュメントを参照してください。Get-R53Change コマンドレットを使用してポーリングし、変更が完了したタイミングを確認できます。**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "www.example.com"
$change1.ResourceRecordSet.Type = "TXT"
$change1.ResourceRecordSet.TTL = 600
$change1.ResourceRecordSet.ResourceRecords = @()
$change1.ResourceRecordSet.ResourceRecords.Add(@{Value="item 1 item 2 item 3"})
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "DELETE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change2.ResourceRecordSet.Name = "test.example.com"
$change2.ResourceRecordSet.Type = "A"
$change2.ResourceRecordSet.TTL = 600
$change2.ResourceRecordSet.ResourceRecords = @()
$change2.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.3"})
$change3 = New-Object Amazon.Route53.Model.Change
$change3.Action = "CREATE"
$change3.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change3.ResourceRecordSet.Name = "test.example.com"
$change3.ResourceRecordSet.Type = "A"
$change3.ResourceRecordSet.TTL = 600
$change3.ResourceRecordSet.ResourceRecords = @()
$change3.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.1"})
$params = @{
HostedZoneId="Z1PA6795UKMFR9"
ChangeBatch_Comment="This change batch creates a TXT record for www.example.com. and changes the A record for test.example.com. from 192.0.2.3 to 192.0.2.1."
ChangeBatch_Change=$change1,$change2,$change3
}
Edit-R53ResourceRecordSet @params
```
**例 2: この例は、エイリアスリソースレコードセットの作成方法を示します。「Z222222222」は、エイリアスリソースレコードセットを作成する Amazon Route 53 ホストゾーンの ID です。「example.com」は、エイリアスを作成するゾーン頂点 Zone Apex で、「www.example.com」は、エイリアスを作成するサブドメインです。「Z1111111111111」はロードバランサーのホストゾーン ID の例で、「example-load-balancer-1111111111.us-east-1.elb.amazonaws.com」は Amazon Route 53 が example.com および www.example.com のクエリに応答するロードバランサードメイン名の例です。詳細については、Amazon Route 53 のドキュメントを参照してください。Get-R53Change コマンドレットを使用してポーリングし、変更が完了したタイミングを確認できます。**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111"
$change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-1111111111.us-east-1.elb.amazonaws.com."
$change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "CREATE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "www.example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111"
$change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-1111111111.us-east-1.elb.amazonaws.com."
$change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $false
$params = @{
HostedZoneId="Z222222222"
ChangeBatch_Comment="This change batch creates two alias resource record sets, one for the zone apex, example.com, and one for www.example.com, that both point to example-load-balancer-1111111111.us-east-1.elb.amazonaws.com."
ChangeBatch_Change=$change1,$change2
}
Edit-R53ResourceRecordSet @params
```
**例 3: この例では、www.example.com の A レコードを 2 つ作成します。割合が 4 分の 1 (1/(1\$13)) の Amazon Route 53 は、最初のリソースレコードセット (192.0.2.9 と 192.0.2.10) の 2 つの値を使用して www.example.com のクエリに応答します。割合が 4 分の 3 (3/(1\$13)) の Amazon Route 53 は、2 番目のリソースレコードセット (192.0.2.11 と 192.0.2.12) の 2 つの値を使用して www.example.com のクエリに応答します。詳細については、Amazon Route 53 のドキュメントを参照してください。Get-R53Change コマンドレットを使用してポーリングし、変更が完了したタイミングを確認できます。**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "www.example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.SetIdentifier = "Rack 2, Positions 4 and 5"
$change1.ResourceRecordSet.Weight = 1
$change1.ResourceRecordSet.TTL = 600
$change1.ResourceRecordSet.ResourceRecords = @()
$change1.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.9"})
$change1.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.10"})
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "CREATE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change2.ResourceRecordSet.Name = "www.example.com"
$change2.ResourceRecordSet.Type = "A"
$change2.ResourceRecordSet.SetIdentifier = "Rack 5, Positions 1 and 2"
$change2.ResourceRecordSet.Weight = 3
$change2.ResourceRecordSet.TTL = 600
$change2.ResourceRecordSet.ResourceRecords = @()
$change2.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.11"})
$change2.ResourceRecordSet.ResourceRecords.Add(@{Value="192.0.2.12"})
$params = @{
HostedZoneId="Z1PA6795UKMFR9"
ChangeBatch_Comment="This change creates two weighted resource record sets, each of which has two values."
ChangeBatch_Change=$change1,$change2
}
Edit-R53ResourceRecordSet @params
```
**例 4: この例は、example.com が加重エイリアスリソースレコードセットを作成するドメインであると仮定した、加重エイリアスリソースレコードセットの作成方法を示します。SetIdentifier は、2 つの加重エイリアスリソースレコードセットを相互に区別します。Name 要素と Type 要素が両方のリソースレコードセットに同じ値を持つため、この要素は必要です。Z1111111111111 および Z3333333333333 は、DNSName の値で指定された ELB ロードバランサーのホストゾーン ID の例です。example-load-balancer-2222222222.us-east-1.elb.amazonaws.com および example-load-balancer-4444444444.us-east-1.elb.amazonaws.com は Amazon Route 53 が example.com のクエリに応答する Elastic Load Balancing ドメインの例です。詳細については、Amazon Route 53 のドキュメントを参照してください。Get-R53Change コマンドレットを使用してポーリングし、変更が完了したタイミングを確認できます。**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.SetIdentifier = "1"
$change1.ResourceRecordSet.Weight = 3
$change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111"
$change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-2222222222.us-east-1.elb.amazonaws.com."
$change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "CREATE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change2.ResourceRecordSet.Name = "example.com"
$change2.ResourceRecordSet.Type = "A"
$change2.ResourceRecordSet.SetIdentifier = "2"
$change2.ResourceRecordSet.Weight = 1
$change2.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change2.ResourceRecordSet.AliasTarget.HostedZoneId = "Z3333333333333"
$change2.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-4444444444.us-east-1.elb.amazonaws.com."
$change2.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $false
$params = @{
HostedZoneId="Z5555555555"
ChangeBatch_Comment="This change batch creates two weighted alias resource record sets. Amazon Route 53 responds to queries for example.com with the first ELB domain 3/4ths of the times and the second one 1/4th of the time."
ChangeBatch_Change=$change1,$change2
}
Edit-R53ResourceRecordSet @params
```
**例 5: この例では、レイテンシーエイリアスリソースレコードセットを 2 つ作成します。1 つは米国西部 (オレゴン) リージョン (us-west-2) の ELB ロードバランサー用で、もう 1 つはアジアパシフィック (シンガポール) リージョン (ap-southeast-1) のロードバランサー用です。詳細については、Amazon Route 53 のドキュメントを参照してください。Get-R53Change コマンドレットを使用してポーリングし、変更が完了したタイミングを確認できます。**
```
$change1 = New-Object Amazon.Route53.Model.Change
$change1.Action = "CREATE"
$change1.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change1.ResourceRecordSet.Name = "example.com"
$change1.ResourceRecordSet.Type = "A"
$change1.ResourceRecordSet.SetIdentifier = "Oregon load balancer 1"
$change1.ResourceRecordSet.Region = us-west-2
$change1.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change1.ResourceRecordSet.AliasTarget.HostedZoneId = "Z1111111111111"
$change1.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-2222222222.us-west-2.elb.amazonaws.com"
$change1.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true
$change2 = New-Object Amazon.Route53.Model.Change
$change2.Action = "CREATE"
$change2.ResourceRecordSet = New-Object Amazon.Route53.Model.ResourceRecordSet
$change2.ResourceRecordSet.Name = "example.com"
$change2.ResourceRecordSet.Type = "A"
$change2.ResourceRecordSet.SetIdentifier = "Singapore load balancer 1"
$change2.ResourceRecordSet.Region = ap-southeast-1
$change2.ResourceRecordSet.AliasTarget = New-Object Amazon.Route53.Model.AliasTarget
$change2.ResourceRecordSet.AliasTarget.HostedZoneId = "Z2222222222222"
$change2.ResourceRecordSet.AliasTarget.DNSName = "example-load-balancer-1111111111.ap-southeast-1.elb.amazonaws.com"
$change2.ResourceRecordSet.AliasTarget.EvaluateTargetHealth = $true
$params = @{
HostedZoneId="Z5555555555"
ChangeBatch_Comment="This change batch creates two latency resource record sets, one for the US West (Oregon) region and one for the Asia Pacific (Singapore) region."
ChangeBatch_Change=$change1,$change2
}
Edit-R53ResourceRecordSet @params
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ChangeResourceRecordSets](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-R53AccountLimit`
次のコード例は、`Get-R53AccountLimit` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、現在のアカウントを使用して作成できるホストゾーンの最大数を返します。**
```
Get-R53AccountLimit -Type MAX_HOSTED_ZONES_BY_OWNER
```
**出力:**
```
15
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetAccountLimit](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-R53CheckerIpRanges`
次のコード例は、`Get-R53CheckerIpRanges` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Route53 ヘルスチェッカーの CIDR を返します。**
```
Get-R53CheckerIpRanges
```
**出力:**
```
15.177.2.0/23
15.177.6.0/23
15.177.10.0/23
15.177.14.0/23
15.177.18.0/23
15.177.22.0/23
15.177.26.0/23
15.177.30.0/23
15.177.34.0/23
15.177.38.0/23
15.177.42.0/23
15.177.46.0/23
15.177.50.0/23
15.177.54.0/23
15.177.58.0/23
15.177.62.0/23
54.183.255.128/26
54.228.16.0/26
54.232.40.64/26
54.241.32.64/26
54.243.31.192/26
54.244.52.192/26
54.245.168.0/26
54.248.220.0/26
54.250.253.192/26
54.251.31.128/26
54.252.79.128/26
54.252.254.192/26
54.255.254.192/26
107.23.255.0/26
176.34.159.192/26
177.71.207.128/26
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetCheckerIpRanges](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-R53HostedZone`
次のコード例は、`Get-R53HostedZone` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: ID Z1D633PJN98FT9 を持つホストゾーンの詳細を返します。**
```
Get-R53HostedZone -Id Z1D633PJN98FT9
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetHostedZone](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-R53HostedZoneCount`
次のコード例は、`Get-R53HostedZoneCount` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 現在のパブリックホストゾーンとプライベートホストゾーンの合計数を返します AWS アカウント。**
```
Get-R53HostedZoneCount
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetHostedZoneCount](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-R53HostedZoneLimit`
次のコード例は、`Get-R53HostedZoneLimit` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定ホストゾーンで作成できるレコードの数の上限を返します。**
```
Get-R53HostedZoneLimit -HostedZoneId Z3MEQ8T7HAAAAF -Type MAX_RRSETS_BY_ZONE
```
**出力:**
```
5
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetHostedZoneLimit](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-R53HostedZoneList`
次のコード例は、`Get-R53HostedZoneList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: すべてのパブリックホストゾーンとプライベートホストゾーンを出力します。**
```
Get-R53HostedZoneList
```
**例 2: ID NZ8X2CISAMPLE を持つ再利用可能な委託セットに関連付けられているすべてのホストゾーンを出力します**
```
Get-R53HostedZoneList -DelegationSetId NZ8X2CISAMPLE
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListHostedZones](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-R53HostedZonesByName`
次のコード例は、`Get-R53HostedZonesByName` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: すべてのパブリックホストゾーンとプライベートホストゾーンを、ドメイン名で ASCII 順に返します。**
```
Get-R53HostedZonesByName
```
**例 2: パブリックホストゾーンとプライベートホストゾーンを、ドメイン名で ASCII 順に指定した DNS 名から返します。**
```
Get-R53HostedZonesByName -DnsName example2.com
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListHostedZonesByName](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-R53QueryLoggingConfigList`
次のコード例は、`Get-R53QueryLoggingConfigList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、現在の AWS アカウントに関連付けられている DNS クエリのログ記録のすべての設定を返します。**
```
Get-R53QueryLoggingConfigList
```
**出力:**
```
Id HostedZoneId CloudWatchLogsLogGroupArn
-- ------------ -------------------------
59b0fa33-4fea-4471-a88c-926476aaa40d Z385PDS6EAAAZR arn:aws:logs:us-east-1:111111111112:log-group:/aws/route53/example1.com:*
ee528e95-4e03-4fdc-9d28-9e24ddaaa063 Z94SJHBV1AAAAZ arn:aws:logs:us-east-1:111111111112:log-group:/aws/route53/example2.com:*
e38dddda-ceb6-45c1-8cb7-f0ae56aaaa2b Z3MEQ8T7AAA1BF arn:aws:logs:us-east-1:111111111112:log-group:/aws/route53/example3.com:*
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListQueryLoggingConfigs](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-R53ReusableDelegationSet`
次のコード例は、`Get-R53ReusableDelegationSet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、委任セットに割り当てられた 4 つのネームサーバーを含む、指定委任セットに関する情報を取得します。**
```
Get-R53ReusableDelegationSet -Id N23DS9X4AYEAAA
```
**出力:**
```
Id CallerReference NameServers
-- --------------- -----------
/delegationset/N23DS9X4AYEAAA testcaller {ns-545.awsdns-04.net, ns-1264.awsdns-30.org, ns-2004.awsdns-58.co.uk, ns-240.awsdns-30.com}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetReusableDelegationSet](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-R53HostedZone`
次のコード例は、`New-R53HostedZone` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 再利用可能な委託セットに関連付けられた「example.com」という名前の新しいホストゾーンを作成します。CallerReference パラメータの値を指定する必要があります。それによって、必要に応じて再試行が必要なリクエストのオペレーションを 2 回実行するリスクがなくなります。ホストゾーンは VPC で作成され、自動的にプライベートになるため、-HostedZoneConfig\$1PrivateZone パラメータは設定しないでください。**
```
$params = @{
Name="example.com"
CallerReference="myUniqueIdentifier"
HostedZoneConfig_Comment="This is my first hosted zone"
DelegationSetId="NZ8X2CISAMPLE"
VPC_VPCId="vpc-1a2b3c4d"
VPC_VPCRegion="us-east-1"
}
New-R53HostedZone @params
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateHostedZone](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-R53QueryLoggingConfig`
次のコード例は、`New-R53QueryLoggingConfig` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定ホストゾーンの新しい Route53 DNS クエリのログ記録設定を作成します。Amazon Route53 は、指定 Cloudwatch ロググループに DNS クエリログを発行します。**
```
New-R53QueryLoggingConfig -HostedZoneId Z3MEQ8T7HAAAAF -CloudWatchLogsLogGroupArn arn:aws:logs:us-east-1:111111111111:log-group:/aws/route53/example.com:*
```
**出力:**
```
QueryLoggingConfig Location
------------------ --------
Amazon.Route53.Model.QueryLoggingConfig https://route53.amazonaws.com/2013-04-01/queryloggingconfig/ee5aaa95-4e03-4fdc-9d28-9e24ddaaaaa3
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateQueryLoggingConfig](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-R53ReusableDelegationSet`
次のコード例は、`New-R53ReusableDelegationSet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、複数のホストゾーンで再利用できる 4 つのネームサーバーの再利用可能な委任セットを作成します。**
```
New-R53ReusableDelegationSet -CallerReference testcallerreference
```
**出力:**
```
DelegationSet Location
------------- --------
Amazon.Route53.Model.DelegationSet https://route53.amazonaws.com/2013-04-01/delegationset/N23DS9XAAAAAXM
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateReusableDelegationSet](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Register-R53VPCWithHostedZone`
次のコード例は、`Register-R53VPCWithHostedZone` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定 VPC をプライベートホストゾーンに関連付けます。**
```
Register-R53VPCWithHostedZone -HostedZoneId Z3MEQ8T7HAAAAF -VPC_VPCId vpc-f1b9aaaa -VPC_VPCRegion us-east-1
```
**出力:**
```
Id Status SubmittedAt Comment
-- ------ ----------- -------
/change/C3SCAAA633Z6DX PENDING 01/28/2020 19:32:02
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[AssociateVPCWithHostedZone](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-R53HostedZone`
次のコード例は、`Remove-R53HostedZone` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定された ID を持つホストゾーンを削除します。-Force スイッチパラメータを追加しない限り、コマンドを進める前に確認を求められます。**
```
Remove-R53HostedZone -Id Z1PA6795UKMFR9
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteHostedZone](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-R53QueryLoggingConfig`
次のコード例は、`Remove-R53QueryLoggingConfig` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、DNS クエリログ記録の指定された設定を削除します。**
```
Remove-R53QueryLoggingConfig -Id ee528e95-4e03-4fdc-9d28-9e24daaa20063
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteQueryLoggingConfig](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-R53ReusableDelegationSet`
次のコード例は、`Remove-R53ReusableDelegationSet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、再利用可能な指定委任セットを削除します。**
```
Remove-R53ReusableDelegationSet -Id N23DS9X4AYAAAM
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteReusableDelegationSet](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Unregister-R53VPCFromHostedZone`
次のコード例は、`Unregister-R53VPCFromHostedZone` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定 VPC とプライベートホストゾーンの関連付けを解除します。**
```
Unregister-R53VPCFromHostedZone -HostedZoneId Z3MEQ8T7HAAAAF -VPC_VPCId vpc-f1b9aaaa -VPC_VPCRegion us-east-1
```
**出力:**
```
Id Status SubmittedAt Comment
-- ------ ----------- -------
/change/C2XFCAAAA9HKZG PENDING 01/28/2020 10:35:55
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DisassociateVPCFromHostedZone](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-R53HostedZoneComment`
次のコード例は、`Update-R53HostedZoneComment` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定ホストゾーンのコメントを更新します。**
```
Update-R53HostedZoneComment -Id Z385PDS6AAAAAR -Comment "This is my first hosted zone"
```
**出力:**
```
Id : /hostedzone/Z385PDS6AAAAAR
Name : example.com.
CallerReference : C5B55555-7147-EF04-8341-69131E805C89
Config : Amazon.Route53.Model.HostedZoneConfig
ResourceRecordSetCount : 9
LinkedService :
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateHostedZoneComment](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用した Amazon S3 の例
次のコード例は、Amazon S3 で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Copy-S3Object`
次のコード例は、`Copy-S3Object` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、オブジェクト「sample.txt」をバケット「test-files」から同じバケットにコピーします。ただし、新しいキー「sample-copy.txt」を使用します。**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -DestinationKey sample-copy.txt
```
**例 2: このコマンドは、オブジェクト「sample.txt」をバケット「test-files」からバケット「backup-files」にコピーします。ただし、キーは「sample-copy.txt」を使用します。**
```
Copy-S3Object -BucketName amzn-s3-demo-source-bucket -Key sample.txt -DestinationKey sample-copy.txt -DestinationBucket amzn-s3-demo-destination-bucket
```
**例 3: このコマンドは、オブジェクト「sample.txt」をバケット「test-files」からダウンロードして、「local-sample.txt」という名前のローカルファイルに保存します。**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -LocalFile local-sample.txt
```
**例 4: 指定したファイルに 1 つのオブジェクトをダウンロードします。ダウンロードしたファイルは c:\$1downloads\$1data\$1archive.zip に保存されます。**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -Key data/archive.zip -LocalFolder c:\downloads
```
**例 5: 指定した key prefix と一致するすべてのオブジェクトをローカルフォルダにダウンロードします。相対的なキー階層は、ダウンロードの場所全体のサブフォルダとして保存されます。**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -KeyPrefix data -LocalFolder c:\downloads
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CopyObject](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3Bucket`
次のコード例は、`Get-S3Bucket` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドはすべての S3 バケットを返します。**
```
Get-S3Bucket
```
**例 2: このコマンドは「test-files」という名前のバケットを返します。**
```
Get-S3Bucket -BucketName amzn-s3-demo-bucket
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListBuckets](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3BucketACL`
次のコード例は、`Get-S3BucketACL` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: コマンドは、S3 オブジェクトのオブジェクト所有者の詳細を取得します。**
```
(Get-S3BucketACL -BucketName 'amzn-s3-demo-bucket' -Select *).Owner
```
**出力:**
```
DisplayName Id
----------- --
testusername 9988776a6554433d22f1100112e334acb45566778899009e9887bd7f66c5f544
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetBucketAcl](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3BucketAccelerateConfiguration`
次のコード例は、`Get-S3BucketAccelerateConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定したバケットで転送加速設定が有効になっている場合、このコマンドは Enabled の値を返します。**
```
Get-S3BucketAccelerateConfiguration -BucketName 'amzn-s3-demo-bucket'
```
**出力:**
```
Value
-----
Enabled
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetBucketAccelerateConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3BucketAnalyticsConfiguration`
次のコード例は、`Get-S3BucketAnalyticsConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定した S3 バケット内の「testfilter」という名前の分析フィルターの詳細を返します。**
```
Get-S3BucketAnalyticsConfiguration -BucketName 'amzn-s3-demo-bucket' -AnalyticsId 'testfilter'
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetBucketAnalyticsConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3BucketAnalyticsConfigurationList`
次のコード例は、`Get-S3BucketAnalyticsConfigurationList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定した S3 バケットの最初の 100 つの分析設定を返します。**
```
Get-S3BucketAnalyticsConfigurationList -BucketName 'amzn-s3-demo-bucket'
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListBucketAnalyticsConfigurations](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3BucketEncryption`
次のコード例は、`Get-S3BucketEncryption` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: のコマンドは、指定したバケットに関連付けられたすべてのサーバー側暗号化ルールを返します。**
```
Get-S3BucketEncryption -BucketName 'amzn-s3-demo-bucket'
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetBucketEncryption](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3BucketInventoryConfiguration`
次のコード例は、`Get-S3BucketInventoryConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定した S3 バケット内の「testinventory」という名前のインベントリの詳細を返します。**
```
Get-S3BucketInventoryConfiguration -BucketName 'amzn-s3-demo-bucket' -InventoryId 'testinventory'
```
+ API の詳細については、**AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetBucketInventoryConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-S3BucketInventoryConfigurationList`
次のコード例は、`Get-S3BucketInventoryConfigurationList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定した S3 バケットの最初の 100 つのインベントリ設定を返します。**
```
Get-S3BucketInventoryConfigurationList -BucketName 'amzn-s3-demo-bucket'
```
+ API の詳細については、**AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListBucketInventoryConfigurations](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-S3BucketLocation`
次のコード例は、`Get-S3BucketLocation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、制約が存在する場合、バケット「amzn-s3-demo-bucket」の場所の制約を返します。**
```
Get-S3BucketLocation -BucketName 'amzn-s3-demo-bucket'
```
**出力:**
```
Value
-----
ap-south-1
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetBucketLocation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3BucketLogging`
次のコード例は、`Get-S3BucketLogging` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定したバケットのログ記録ステータスを返します。**
```
Get-S3BucketLogging -BucketName 'amzn-s3-demo-bucket'
```
**出力:**
```
TargetBucketName Grants TargetPrefix
---------------- ------ ------------
testbucket1 {} testprefix
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetBucketLogging](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3BucketMetricsConfiguration`
次のコード例は、`Get-S3BucketMetricsConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定した S3 バケットの「testfilter」という名前のメトリクスフィルターに関する詳細を返します。**
```
Get-S3BucketMetricsConfiguration -BucketName 'amzn-s3-demo-bucket' -MetricsId 'testfilter'
```
+ API の詳細については、**AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetBucketMetricsConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-S3BucketNotification`
次のコード例は、`Get-S3BucketNotification` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したバケットの通知設定を取得します。**
```
Get-S3BucketNotification -BucketName amzn-s3-demo-bucket | select -ExpandProperty TopicConfigurations
```
**出力:**
```
Id Topic
-- -----
mimo arn:aws:sns:eu-west-1:123456789012:topic-1
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetBucketNotification](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3BucketPolicy`
次のコード例は、`Get-S3BucketPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定した S3 バケットに関連付けられたバケットポリシーを出力します。**
```
Get-S3BucketPolicy -BucketName 'amzn-s3-demo-bucket'
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetBucketPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3BucketPolicyStatus`
次のコード例は、`Get-S3BucketPolicyStatus` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定した S3 バケットのポリシーステータスを返し、バケットがパブリックかどうかを示します。**
```
Get-S3BucketPolicyStatus -BucketName 'amzn-s3-demo-bucket'
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetBucketPolicyStatus](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3BucketReplication`
次のコード例は、`Get-S3BucketReplication` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 「amzn-s3-demo-bucket」という名前のバケットに設定されているレプリケーション設定の情報を返します。**
```
Get-S3BucketReplication -BucketName amzn-s3-demo-bucket
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetBucketReplication](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3BucketRequestPayment`
次のコード例は、`Get-S3BucketRequestPayment` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 「amzn-s3-demo-bucket」という名前のバケットのリクエストの支払い設定を返します。デフォルトでは、バケット所有者はバケットからのダウンロード料金を支払います。**
```
Get-S3BucketRequestPayment -BucketName amzn-s3-demo-bucket
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetBucketRequestPayment](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3BucketTagging`
次のコード例は、`Get-S3BucketTagging` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定バケットに関連付けられたすべてのタグを返します。**
```
Get-S3BucketTagging -BucketName 'amzn-s3-demo-bucket'
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetBucketTagging](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3BucketVersioning`
次のコード例は、`Get-S3BucketVersioning` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定バケットに関するバージョニングステータスを返します。**
```
Get-S3BucketVersioning -BucketName 'amzn-s3-demo-bucket'
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetBucketVersioning](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3BucketWebsite`
次のコード例は、`Get-S3BucketWebsite` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定 S3 バケットの静的ウェブサイトの設定の詳細を返します。**
```
Get-S3BucketWebsite -BucketName 'amzn-s3-demo-bucket'
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetBucketWebsite](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3CORSConfiguration`
次のコード例は、`Get-S3CORSConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定 S3 バケットに対応するすべての CORS 設定ルールを含むオブジェクトを返します。**
```
Get-S3CORSConfiguration -BucketName 'amzn-s3-demo-bucket' -Select Configuration.Rules
```
**出力:**
```
AllowedMethods : {PUT, POST, DELETE}
AllowedOrigins : {http://www.example1.com}
Id :
ExposeHeaders : {}
MaxAgeSeconds : 0
AllowedHeaders : {*}
AllowedMethods : {PUT, POST, DELETE}
AllowedOrigins : {http://www.example2.com}
Id :
ExposeHeaders : {}
MaxAgeSeconds : 0
AllowedHeaders : {*}
AllowedMethods : {GET}
AllowedOrigins : {*}
Id :
ExposeHeaders : {}
MaxAgeSeconds : 0
AllowedHeaders : {}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetCORSConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3HeadBucket`
次のコード例は、`Get-S3HeadBucket` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、ユーザーがバケットにアクセスするアクセス許可を持っている場合に、既存のバケットに対して HTTP ステータスコード 200 OK の出力を返します。BucketArn パラメータは S3 ディレクトリバケットでのみサポートされています。**
```
Get-S3HeadBucket -BucketName amzn-s3-demo-bucket
```
**出力:**
```
AccessPointAlias : False
BucketArn :
BucketLocationName :
BucketLocationType :
BucketRegion : us-east-2
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 0
HttpStatusCode : OK
```
**例 2: このコマンドは、存在しないバケットに対して HTTP ステータスコード NotFound でエラーをスローします。**
```
Get-S3HeadBucket -BucketName amzn-s3-non-existing-bucket
```
**出力:**
```
Get-S3HeadBucket: Error making request with Error Code NotFound and Http Status Code NotFound. No further error information was returned by the service.
```
**例 3: このコマンドは、ユーザーがアクセス許可を持たない既存のバケットに対して HTTP ステータスコード Forbidden でエラーをスローします。**
```
Get-S3HeadBucket -BucketName amzn-s3-no-access-bucket
```
**出力:**
```
Get-S3HeadBucket: Error making request with Error Code Forbidden and Http Status Code Forbidden. No further error information was returned by the service.
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[HeadBucket](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3LifecycleConfiguration`
次のコード例は、`Get-S3LifecycleConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、バケットのライフサイクル設定を取得します。**
```
Get-S3LifecycleConfiguration -BucketName amzn-s3-demo-bucket
```
**出力:**
```
Rules
-----
{Remove-in-150-days, Archive-to-Glacier-in-30-days}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetLifecycleConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3Object`
次のコード例は、`Get-S3Object` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、バケット「test-files」内のすべての項目に関する情報を取得します。**
```
Get-S3Object -BucketName amzn-s3-demo-bucket
```
**例 2: このコマンドは、バケット「test-files」内の項目「sample.txt」に関する情報を取得します。**
```
Get-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt
```
**例 3: このコマンドは、バケット「test-files」からプレフィックス「sample」を持つすべての項目に関する情報を取得します。**
```
Get-S3Object -BucketName amzn-s3-demo-bucket -KeyPrefix sample
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListObjects](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3ObjectACL`
次のコード例は、`Get-S3ObjectACL` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: コマンドは、S3 オブジェクトのオブジェクト所有者の詳細を取得します。**
```
(Get-S3ObjectACL -BucketName 'amzn-s3-demo-bucket' -key 'initialize.ps1' -Select *).Owner
```
**出力:**
```
DisplayName Id
----------- --
testusername 9988776a6554433d22f1100112e334acb45566778899009e9887bd7f66c5f544
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetObjectAcl](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3ObjectLockConfiguration`
次のコード例は、`Get-S3ObjectLockConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定した S3 バケットのオブジェクトロック設定が有効になっている場合、このコマンドは値「Enabled」を返しま。**
```
Get-S3ObjectLockConfiguration -BucketName 'amzn-s3-demo-bucket' -Select ObjectLockConfiguration.ObjectLockEnabled
```
**出力:**
```
Value
-----
Enabled
```
+ API の詳細については、**AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetObjectLockConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-S3ObjectMetadata`
次のコード例は、`Get-S3ObjectMetadata` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定された S3 バケット内のキー 「ListTrusts.txt」を含むオブジェクトのメタデータを返します。**
```
Get-S3ObjectMetadata -BucketName 'amzn-s3-demo-bucket' -Key 'ListTrusts.txt'
```
**出力:**
```
Headers : Amazon.S3.Model.HeadersCollection
Metadata : Amazon.S3.Model.MetadataCollection
DeleteMarker :
AcceptRanges : bytes
ContentRange :
Expiration :
RestoreExpiration :
RestoreInProgress : False
LastModified : 01/01/2020 08:02:05
ETag : "d000011112a222e333e3bb4ee5d43d21"
MissingMeta : 0
VersionId : null
Expires : 01/01/0001 00:00:00
WebsiteRedirectLocation :
ServerSideEncryptionMethod : AES256
ServerSideEncryptionCustomerMethod :
ServerSideEncryptionKeyManagementServiceKeyId :
ReplicationStatus :
PartsCount :
ObjectLockLegalHoldStatus :
ObjectLockMode :
ObjectLockRetainUntilDate : 01/01/0001 00:00:00
StorageClass :
RequestCharged :
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetObjectMetadata](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3ObjectRetention`
次のコード例は、`Get-S3ObjectRetention` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、オブジェクトが保持されるまでのモードと日付を返します。**
```
Get-S3ObjectRetention -BucketName 'amzn-s3-demo-bucket' -Key 'testfile.txt'
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetObjectRetention](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3ObjectTagSet`
次のコード例は、`Get-S3ObjectTagSet` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した S3 バケット上に存在するオブジェクトに関連付けられたタグを返します。**
```
Get-S3ObjectTagSet -Key 'testfile.txt' -BucketName 'amzn-s3-demo-bucket'
```
**出力:**
```
Key Value
--- -----
test value
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetObjectTagging](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3PreSignedURL`
次のコード例は、`Get-S3PreSignedURL` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: コマンドは、指定キーと有効期限の署名付き URL を返します。**
```
Get-S3PreSignedURL -BucketName 'amzn-s3-demo-bucket' -Key 'testkey' -Expires '2023-11-16'
```
**例 2: コマンドは、指定キーと有効期限を持つディレクトリバケットの署名付き URL を返します。**
```
[Amazon.AWSConfigsS3]::UseSignatureVersion4 = $true
Get-S3PreSignedURL -BucketName amzn-s3-demo-bucket--usw2-az1--x-s3 -Key 'testkey' -Expire '2023-11-17'
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetPreSignedURL](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3PublicAccessBlock`
次のコード例は、`Get-S3PublicAccessBlock` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定 S3 バケットのパブリックアクセスブロック設定を返します。**
```
Get-S3PublicAccessBlock -BucketName 'amzn-s3-demo-bucket'
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetPublicAccessBlock](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-S3Version`
次のコード例は、`Get-S3Version` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定 S3 バケット内のすべてのバージョンのオブジェクトに関するメタデータを返します。**
```
Get-S3Version -BucketName 'amzn-s3-demo-bucket'
```
**出力:**
```
IsTruncated : False
KeyMarker :
VersionIdMarker :
NextKeyMarker :
NextVersionIdMarker :
Versions : {EC2.txt, EC2MicrosoftWindowsGuide.txt, ListDirectories.json, ListTrusts.json}
Name : amzn-s3-demo-bucket
Prefix :
MaxKeys : 1000
CommonPrefixes : {}
Delimiter :
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListVersions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-S3Bucket`
次のコード例は、`New-S3Bucket` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、「sample-bucket」という名前の新しいプライベートバケットを作成します。**
```
New-S3Bucket -BucketName amzn-s3-demo-bucket
```
**例 2: このコマンドは、読み取り/書き込みアクセス許可を持つ「sample-bucket」という名前の新しいバケットを作成します。**
```
New-S3Bucket -BucketName amzn-s3-demo-bucket -PublicReadWrite
```
**例 3: このコマンドは、読み取り専用アクセス許可を持つ「sample-bucket」という名前の新しいバケットを作成します。**
```
New-S3Bucket -BucketName amzn-s3-demo-bucket -PublicReadOnly
```
**例 4: このコマンドは、PutBucketConfiguration を使用して「amzn-s3-demo-bucket--use1-az5--x-s3」という名前の新しいディレクトリバケットを作成します。**
```
$bucketConfiguration = @{
BucketInfo = @{
DataRedundancy = 'SingleAvailabilityZone'
Type = 'Directory'
}
Location = @{
Name = 'usw2-az1'
Type = 'AvailabilityZone'
}
}
New-S3Bucket -BucketName amzn-s3-demo-bucket--usw2-az1--x-s3 -BucketConfiguration $bucketConfiguration -Region us-west-2
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutBucket](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Read-S3Object`
次のコード例は、`Read-S3Object` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、バケット「amzn-s3-demo-bucket」から項目「sample.txt」を取得し、現在の場所の「local-sample.txt」という名前のファイルに保存します。このコマンドを呼び出す前にファイル「local-sample.txt」が存在していなくても構いません。**
```
Read-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -File local-sample.txt
```
**例 2: このコマンドは、バケット「amzn-s3-demo-bucket」から仮想ディレクトリ「DIR」を取得し、現在の場所の「Local-DIR」という名前のフォルダに保存します。このコマンドを呼び出す前に、フォルダー「Local-DIR」が存在していなくても構いません。**
```
Read-S3Object -BucketName amzn-s3-demo-bucket -KeyPrefix DIR -Folder Local-DIR
```
**例 3: バケット名に「config」を含むバケットから、キーが「.json」で終わるすべてのオブジェクトを、指定したフォルダ内のファイルにダウンロードします。オブジェクトキーはファイル名の設定に使用されます。**
```
Get-S3Bucket | ? { $_.BucketName -like '*config*' } | Get-S3Object | ? { $_.Key -like '*.json' } | Read-S3Object -Folder C:\ConfigObjects
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetObject](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-S3Bucket`
次のコード例は、`Remove-S3Bucket` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、バケット「test-files」からすべてのオブジェクトとオブジェクトバージョンを削除してから、バケットを削除します。このコマンドは、続行する前に確認を求めるプロンプトを表示します。-Force スイッチを追加すると、確認メッセージが表示されなくなります。空でないバケットは削除できないことに注意が必要です。**
```
Remove-S3Bucket -BucketName amzn-s3-demo-bucket -DeleteBucketContent
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteBucket](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-S3BucketAnalyticsConfiguration`
次のコード例は、`Remove-S3BucketAnalyticsConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定した S3 バケット内の「testfilter」という名前の分析フィルターを削除します。**
```
Remove-S3BucketAnalyticsConfiguration -BucketName 'amzn-s3-demo-bucket' -AnalyticsId 'testfilter'
```
+ API の詳細については、**AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteBucketAnalyticsConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-S3BucketEncryption`
次のコード例は、`Remove-S3BucketEncryption` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: これは、指定した S3 バケットで有効になっている暗号化を無効にします。**
```
Remove-S3BucketEncryption -BucketName 'amzn-s3-demo-bucket'
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3BucketEncryption (DeleteBucketEncryption)" on target "s3casetestbucket".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteBucketEncryption](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-S3BucketInventoryConfiguration`
次のコード例は、`Remove-S3BucketInventoryConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定した S3 バケットに対応する「testInventoryName」という名前のインベントリを削除します。**
```
Remove-S3BucketInventoryConfiguration -BucketName 'amzn-s3-demo-bucket' -InventoryId 'testInventoryName'
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3BucketInventoryConfiguration (DeleteBucketInventoryConfiguration)" on target "amzn-s3-demo-bucket".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ API の詳細については、**AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteBucketInventoryConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-S3BucketMetricsConfiguration`
次のコード例は、`Remove-S3BucketMetricsConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定した S3 バケット内の「testmetrics」という名前のメトリクスフィルターを削除します。**
```
Remove-S3BucketMetricsConfiguration -BucketName 'amzn-s3-demo-bucket' -MetricsId 'testmetrics'
```
+ API の詳細については、**AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteBucketMetricsConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-S3BucketPolicy`
次のコード例は、`Remove-S3BucketPolicy` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定した S3 バケットに関連付けられたバケットポリシーを削除します。**
```
Remove-S3BucketPolicy -BucketName 'amzn-s3-demo-bucket'
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteBucketPolicy](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-S3BucketReplication`
次のコード例は、`Remove-S3BucketReplication` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 「amzn-s3-demo-bucket」という名前のバケットに関連付けられているレプリケーションの設定を削除します。なお、このオペレーションには s3:DeleteReplicationConfiguration アクションに対するアクセス許可が必要です。オペレーションを続行する前に確認を求めるプロンプトが表示されます。プロンプトを表示しないようにするには、-Force スイッチを使用します。**
```
Remove-S3BucketReplication -BucketName amzn-s3-demo-bucket
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteBucketReplication](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-S3BucketTagging`
次のコード例は、`Remove-S3BucketTagging` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定した S3 バケットに関連付けられたすべてのタグを削除します。**
```
Remove-S3BucketTagging -BucketName 'amzn-s3-demo-bucket'
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3BucketTagging (DeleteBucketTagging)" on target "amzn-s3-demo-bucket".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteBucketTagging](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-S3BucketWebsite`
次のコード例は、`Remove-S3BucketWebsite` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定した S3 バケットの静的ウェブサイトホスティングのプロパティを無効にします。**
```
Remove-S3BucketWebsite -BucketName 'amzn-s3-demo-bucket'
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3BucketWebsite (DeleteBucketWebsite)" on target "amzn-s3-demo-bucket".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteBucketWebsite](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-S3CORSConfiguration`
次のコード例は、`Remove-S3CORSConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定した S3 バケットの CORS 設定を削除します。**
```
Remove-S3CORSConfiguration -BucketName 'amzn-s3-demo-bucket'
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3CORSConfiguration (DeleteCORSConfiguration)" on target "amzn-s3-demo-bucket".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteCORSConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-S3LifecycleConfiguration`
次のコード例は、`Remove-S3LifecycleConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: コマンドは、指定 S3 バケットのすべてのライフサイクルルールを削除します。**
```
Remove-S3LifecycleConfiguration -BucketName 'amzn-s3-demo-bucket'
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteLifecycleConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-S3MultipartUpload`
次のコード例は、`Remove-S3MultipartUpload` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、5 日より前に作成されたマルチパートアップロードを中止します。**
```
Remove-S3MultipartUpload -BucketName amzn-s3-demo-bucket -DaysBefore 5
```
**例 2: このコマンドは、2014 年 1 月 2 日より前に作成されたマルチパートアップロードを中止します。**
```
Remove-S3MultipartUpload -BucketName amzn-s3-demo-bucket -InitiatedDate "Thursday, January 02, 2014"
```
**例 3: このコマンドは、2014 年 1 月 2 日 10:45:37 より前に作成されたマルチパートアップロードを中止します。**
```
Remove-S3MultipartUpload -BucketName amzn-s3-demo-bucket -InitiatedDate "2014/01/02 10:45:37"
```
+ API の詳細については、**AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[AbortMultipartUpload](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Remove-S3Object`
次のコード例は、`Remove-S3Object` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、バケット「test-files」からオブジェクト「sample.txt」を削除します。コマンドを実行する前に、確認を求めるプロンプトが表示されます。-Force スイッチを追加すると、確認メッセージが表示されなくなります。**
```
Remove-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt
```
**例 2: このコマンドは、指定されたバージョンのオブジェクト「sample.txt」をバケット「test-files」から削除します。これは、バケットがオブジェクトバージョンを有効にするように設定されていることを前提としています。**
```
Remove-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -VersionId HLbxnx6V9omT6AQYVpks8mmFKQcejpqt
```
**例 3: このコマンドは、バケット「test-files」からオブジェクト「sample1.txt」、「sample2.txt」、「sample3.txt」を 1 回のバッチ操作で削除します。このサービスの応答では、削除の成功またはエラーのステータスを問わず、処理されたすべてのキーがリスト表示されます。このサービスで処理できなかったキーのエラーのみを取得するには、-ReportErrorsOnly パラメータを追加します (このパラメータは -Quiet というエイリアスを使用して指定することもできます)。**
```
Remove-S3Object -BucketName amzn-s3-demo-bucket -KeyCollection @( "sample1.txt", "sample2.txt", "sample3.txt" )
```
**例 4: この例では、-KeyCollection パラメータを指定したインライン式を使用して、削除するオブジェクトのキーを取得します。Get-S3Object は Amazon.S3.Model.S3Object インスタンスのコレクションを返します。各インスタンスには、オブジェクトを識別する文字列型の Key メンバーがあります。**
```
Remove-S3Object -bucketname "amzn-s3-demo-bucket" -KeyCollection (Get-S3Object "test-files" -KeyPrefix "prefix/subprefix" | select -ExpandProperty Key)
```
**例 5: この例では、バケット内のキープレフィックス「prefix/subprefix」を持つすべてのオブジェクトを取得して削除します。受け取るオブジェクトは一度に 1 つずつ処理されることに注意が必要です。大規模なコレクションの場合は、コレクションをコマンドレットの -InputObject (エイリアスは -S3ObjectCollection) パラメータに渡して、サービスを 1 回呼び出すだけでバッチで削除できるようにすることを検討してください。**
```
Get-S3Object -BucketName "amzn-s3-demo-bucket" -KeyPrefix "prefix/subprefix" | Remove-S3Object -Force
```
**例 6: この例では、削除マーカーを表す Amazon.S3.Model.S3ObjectVersion インスタンスのコレクションを、削除コマンドレットにパイプします。受け取るオブジェクトは一度に 1 つずつ処理されることに注意が必要です。大規模なコレクションの場合は、コレクションをコマンドレットの -InputObject (エイリアスは -S3ObjectCollection) パラメータに渡して、サービスを 1 回呼び出すだけでバッチで削除できるようにすることを検討してください。**
```
(Get-S3Version -BucketName "amzn-s3-demo-bucket").Versions | Where {$_.IsDeleteMarker -eq "True"} | Remove-S3Object -Force
```
**例 7: このスクリプトは、-KeyAndVersionCollection パラメータで使用するオブジェクトの配列を作成することで、オブジェクトセット (この場合は削除マーカー) をバッチで削除する方法を示しています。**
```
$keyVersions = @()
$markers = (Get-S3Version -BucketName $BucketName).Versions | Where {$_.IsDeleteMarker -eq "True"}
foreach ($marker in $markers) { $keyVersions += @{ Key = $marker.Key; VersionId = $marker.VersionId } }
Remove-S3Object -BucketName $BucketName -KeyAndVersionCollection $keyVersions -Force
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteObjects](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-S3ObjectTagSet`
次のコード例は、`Remove-S3ObjectTagSet` を使用する方法を示しています。
**Tools for PowerShell V5**
**このコマンドは、指定した S3 バケット内のキー「testfile.txt」を持つオブジェクトに関連付けられたすべてのタグを削除します。**
```
Remove-S3ObjectTagSet -Key 'testfile.txt' -BucketName 'amzn-s3-demo-bucket' -Select '^Key'
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3ObjectTagSet (DeleteObjectTagging)" on target "testfile.txt".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
testfile.txt
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteObjectTagging](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-S3PublicAccessBlock`
次のコード例は、`Remove-S3PublicAccessBlock` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定したバケットのブロックパブリックアクセス設定をオフにします。**
```
Remove-S3PublicAccessBlock -BucketName 'amzn-s3-demo-bucket' -Force -Select '^BucketName'
```
**出力:**
```
amzn-s3-demo-bucket
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeletePublicAccessBlock](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Set-S3BucketEncryption`
次のコード例は、`Set-S3BucketEncryption` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定したバケットで Amazon S3 マネージドキー (SSE-S3) を使用したデフォルトの AES256 サーバー側暗号化を有効にします。**
```
$Encryptionconfig = @{ServerSideEncryptionByDefault = @{ServerSideEncryptionAlgorithm = "AES256"}}
Set-S3BucketEncryption -BucketName 'amzn-s3-demo-bucket' -ServerSideEncryptionConfiguration_ServerSideEncryptionRule $Encryptionconfig
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutBucketEncryption](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Test-S3Bucket`
次のコード例は、`Test-S3Bucket` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、バケットが存在する場合は True を返し、存在しない場合は False を返します。コマンドは、バケットがユーザーに属していない場合でも True を返します。**
```
Test-S3Bucket -BucketName amzn-s3-demo-bucket
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[Test-S3Bucket](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Write-S3BucketAccelerateConfiguration`
次のコード例は、`Write-S3BucketAccelerateConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定 S3 バケットの転送加速を有効にします。**
```
$statusVal = New-Object Amazon.S3.BucketAccelerateStatus('Enabled')
Write-S3BucketAccelerateConfiguration -BucketName 'amzn-s3-demo-bucket' -AccelerateConfiguration_Status $statusVal
```
+ API の詳細については、**AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutBucketAccelerateConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Write-S3BucketNotification`
次のコード例は、`Write-S3BucketNotification` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、S3 イベント ObjectRemovedDelete の SNS トピック設定を設定して、指定した S3 バケットの通知を有効にします。**
```
$topic = [Amazon.S3.Model.TopicConfiguration] @{
Id = "delete-event"
Topic = "arn:aws:sns:eu-west-1:123456789012:topic-1"
Event = [Amazon.S3.EventType]::ObjectRemovedDelete
}
Write-S3BucketNotification -BucketName amzn-s3-demo-bucket -TopicConfiguration $topic
```
**例 2: この例では、指定したバケットの ObjectCreatedAll の通知を有効にして、Lambda 関数に送信します。**
```
$lambdaConfig = [Amazon.S3.Model.LambdaFunctionConfiguration] @{
Events = "s3:ObjectCreated:*"
FunctionArn = "arn:aws:lambda:eu-west-1:123456789012:function:rdplock"
Id = "ObjectCreated-Lambda"
Filter = @{
S3KeyFilter = @{
FilterRules = @(
@{Name="Prefix";Value="dada"}
@{Name="Suffix";Value=".pem"}
)
}
}
}
Write-S3BucketNotification -BucketName amzn-s3-demo-bucket -LambdaFunctionConfiguration $lambdaConfig
```
**例 3: この例では、異なるキーサフィックスに基づいて 2 つの異なる Lambda 設定を作成し、両方を 1 つのコマンドで設定します。**
```
#Lambda Config 1
$firstLambdaConfig = [Amazon.S3.Model.LambdaFunctionConfiguration] @{
Events = "s3:ObjectCreated:*"
FunctionArn = "arn:aws:lambda:eu-west-1:123456789012:function:verifynet"
Id = "ObjectCreated-dada-ps1"
Filter = @{
S3KeyFilter = @{
FilterRules = @(
@{Name="Prefix";Value="dada"}
@{Name="Suffix";Value=".ps1"}
)
}
}
}
#Lambda Config 2
$secondlambdaConfig = [Amazon.S3.Model.LambdaFunctionConfiguration] @{
Events = [Amazon.S3.EventType]::ObjectCreatedAll
FunctionArn = "arn:aws:lambda:eu-west-1:123456789012:function:verifyssm"
Id = "ObjectCreated-dada-json"
Filter = @{
S3KeyFilter = @{
FilterRules = @(
@{Name="Prefix";Value="dada"}
@{Name="Suffix";Value=".json"}
)
}
}
}
Write-S3BucketNotification -BucketName amzn-s3-demo-bucket -LambdaFunctionConfiguration $firstLambdaConfig,$secondlambdaConfig
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutBucketNotification](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Write-S3BucketReplication`
次のコード例は、`Write-S3BucketReplication` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、バケット「amzn-s3-demo-bucket」内のキー名プレフィックス「TaxDocs」で作成された新しいオブジェクトの「amzn-s3-demo-bucket」バケットへのレプリケーションを有効にする単一のルールを使用してレプリケーション設定を指定します。**
```
$rule1 = New-Object Amazon.S3.Model.ReplicationRule
$rule1.ID = "Rule-1"
$rule1.Status = "Enabled"
$rule1.Prefix = "TaxDocs"
$rule1.Destination = @{ BucketArn = "arn:aws:s3:::amzn-s3-demo-destination-bucket" }
$params = @{
BucketName = "amzn-s3-demo-bucket"
Configuration_Role = "arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3"
Configuration_Rule = $rule1
}
Write-S3BucketReplication @params
```
**例 2: この例では、キー名のプレフィックスが「TaxDocs」または「OtherDocs」の新しく作成されたオブジェクトを、バケット「amzn-s3-demo-bucket」にレプリケートするための複数のルールを使用して、レプリケーション設定を指定します。キーのプレフィックスの重複は許可されません。**
```
$rule1 = New-Object Amazon.S3.Model.ReplicationRule
$rule1.ID = "Rule-1"
$rule1.Status = "Enabled"
$rule1.Prefix = "TaxDocs"
$rule1.Destination = @{ BucketArn = "arn:aws:s3:::amzn-s3-demo-destination-bucket" }
$rule2 = New-Object Amazon.S3.Model.ReplicationRule
$rule2.ID = "Rule-2"
$rule2.Status = "Enabled"
$rule2.Prefix = "OtherDocs"
$rule2.Destination = @{ BucketArn = "arn:aws:s3:::amzn-s3-demo-destination-bucket" }
$params = @{
BucketName = "amzn-s3-demo-bucket"
Configuration_Role = "arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3"
Configuration_Rule = $rule1,$rule2
}
Write-S3BucketReplication @params
```
**例 3: この例では、指定されたバケットのレプリケーション設定を更新して、「TaxDocs」というキー名のプレフィックスを持つオブジェクトのバケット「amzn-s3-demo-bucket」へのレプリケーションを制御するルールを無効にします。**
```
$rule1 = New-Object Amazon.S3.Model.ReplicationRule
$rule1.ID = "Rule-1"
$rule1.Status = "Disabled"
$rule1.Prefix = "TaxDocs"
$rule1.Destination = @{ BucketArn = "arn:aws:s3:::amzn-s3-demo-destination-bucket" }
$params = @{
BucketName = "amzn-s3-demo-bucket"
Configuration_Role = "arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3"
Configuration_Rule = $rule1
}
Write-S3BucketReplication @params
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutBucketReplication](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Write-S3BucketRequestPayment`
次のコード例は、`Write-S3BucketRequestPayment` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 「amzn-s3-demo-bucket」という名前のバケットのリクエスト支払い設定を更新して、バケットからのダウンロードをリクエストしたユーザーにダウンロード料金が請求されるようにします。デフォルトでは、バケット所有者がダウンロード料金を支払います。リクエストの支払いをデフォルトに戻すには、RequestPaymentConfiguration\$1Payer パラメーターに「BucketOwner」を使用します。**
```
Write-S3BucketRequestPayment -BucketName amzn-s3-demo-bucket -RequestPaymentConfiguration_Payer Requester
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutBucketRequestPayment](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Write-S3BucketTagging`
次のコード例は、`Write-S3BucketTagging` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、`cloudtrail-test-2018` という名前のバケットに 2 つのタグを適用します。1 つは Stage のキーと値が Test のタグで、もう 1 つはキーが Environment で、値は Alpha のタグです。タグがバケットに追加されたことを確認するには、`Get-S3BucketTagging -BucketName bucket_name` を実行します。結果では、最初のコマンドでバケットに適用したタグが表示されるはずです。`Write-S3BucketTagging` は、バケットに設定されている既存のタグセット全体を上書きすることに注意が必要です。個別のタグを追加または削除するには、リソースグループとタグ付けの API コマンドレット、`Add-RGTResourceTag`、`Remove-RGTResourceTag` を実行します。または、 AWS マネジメントコンソールのタグエディタを使用して S3 バケットタグを管理します。**
```
Write-S3BucketTagging -BucketName amzn-s3-demo-bucket -TagSet @( @{ Key="Stage"; Value="Test" }, @{ Key="Environment"; Value="Alpha" } )
```
**例 2: このコマンドは、バケット `cloudtrail-test-2018` を `Write-S3BucketTagging` コマンドレットにパイプします。これにより、Stage:Production と Department:Finance というタグがバケットに適用されます。`Write-S3BucketTagging` は、バケットに設定されている既存のタグセット全体を上書きすることに注意が必要です。**
```
Get-S3Bucket -BucketName amzn-s3-demo-bucket | Write-S3BucketTagging -TagSet @( @{ Key="Stage"; Value="Production" }, @{ Key="Department"; Value="Finance" } )
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutBucketTagging](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Write-S3BucketVersioning`
次のコード例は、`Write-S3BucketVersioning` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定した S3 バケットのバージョニングを有効にします。**
```
Write-S3BucketVersioning -BucketName 'amzn-s3-demo-bucket' -VersioningConfig_Status Enabled
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutBucketVersioning](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Write-S3BucketWebsite`
次のコード例は、`Write-S3BucketWebsite` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定したバケットのウェブサイトのホスティングを有効にして、インデックスドキュメントを「index.html」、エラードキュメントを「error.html」と指定します。**
```
Write-S3BucketWebsite -BucketName 'amzn-s3-demo-bucket' -WebsiteConfiguration_IndexDocumentSuffix 'index.html' -WebsiteConfiguration_ErrorDocument 'error.html'
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutBucketWebsite](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Write-S3LifecycleConfiguration`
次のコード例は、`Write-S3LifecycleConfiguration` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、\$1NewRule で指定されている設定を書き込み/置き換えます。この設定では、指定のプレフィックスとタグ値を持つスコープオブジェクトを制限します。**
```
$NewRule = [Amazon.S3.Model.LifecycleRule] @{
Expiration = @{
Days= 50
}
Id = "Test-From-Write-cmdlet-1"
Filter= @{
LifecycleFilterPredicate = [Amazon.S3.Model.LifecycleAndOperator]@{
Operands= @(
[Amazon.S3.Model.LifecyclePrefixPredicate] @{
"Prefix" = "py"
},
[Amazon.S3.Model.LifecycleTagPredicate] @{
"Tag"= @{
"Key" = "non-use"
"Value" = "yes"
}
}
)
}
}
"Status"= 'Enabled'
NoncurrentVersionExpiration = @{
NoncurrentDays = 75
}
}
Write-S3LifecycleConfiguration -BucketName amzn-s3-demo-bucket -Configuration_Rule $NewRule
```
**例 2: この例では、フィルタリングを使用して複数のルールを設定します。\$1ArchiveRule は、オブジェクトを 30 日後に Glacier にアーカイブし、120 日後に DeepArchive にアーカイブするように設定します。\$1ExpireRule は、「py」プレフィックスと tag:key「archieved」が「yes」に設定されているオブジェクトについて、現在のバージョンと以前のバージョンの両方を 150 日で期限切れにします。**
```
$ExpireRule = [Amazon.S3.Model.LifecycleRule] @{
Expiration = @{
Days= 150
}
Id = "Remove-in-150-days"
Filter= @{
LifecycleFilterPredicate = [Amazon.S3.Model.LifecycleAndOperator]@{
Operands= @(
[Amazon.S3.Model.LifecyclePrefixPredicate] @{
"Prefix" = "py"
},
[Amazon.S3.Model.LifecycleTagPredicate] @{
"Tag"= @{
"Key" = "archived"
"Value" = "yes"
}
}
)
}
}
Status= 'Enabled'
NoncurrentVersionExpiration = @{
NoncurrentDays = 150
}
}
$ArchiveRule = [Amazon.S3.Model.LifecycleRule] @{
Expiration = $null
Id = "Archive-to-Glacier-in-30-days"
Filter= @{
LifecycleFilterPredicate = [Amazon.S3.Model.LifecycleAndOperator]@{
Operands= @(
[Amazon.S3.Model.LifecyclePrefixPredicate] @{
"Prefix" = "py"
},
[Amazon.S3.Model.LifecycleTagPredicate] @{
"Tag"= @{
"Key" = "reviewed"
"Value" = "yes"
}
}
)
}
}
Status = 'Enabled'
NoncurrentVersionExpiration = @{
NoncurrentDays = 75
}
Transitions = @(
@{
Days = 30
"StorageClass"= 'Glacier'
},
@{
Days = 120
"StorageClass"= [Amazon.S3.S3StorageClass]::DeepArchive
}
)
}
Write-S3LifecycleConfiguration -BucketName amzn-s3-demo-bucket -Configuration_Rule $ExpireRule,$ArchiveRule
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutLifecycleConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Write-S3Object`
次のコード例は、`Write-S3Object` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、単一のファイル「local-sample.txt」を Amazon S3 にアップロードして、バケット「test-files」に「sample.txt」というキーを持つオブジェクトを作成します。**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Key "sample.txt" -File .\local-sample.txt
```
**例 2: このコマンドは、単一のファイル「sample.txt」を Amazon S3 にアップロードして、バケット「test-files」に「sample.txt」というキーを持つオブジェクトを作成します。-Key パラメータを指定しない場合、ファイル名が S3 オブジェクトキーとして使用されます。**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -File .\sample.txt
```
**例 3: このコマンドは、単一のファイル「local-sample.txt」を Amazon S3 にアップロードして、バケット「test-files」に「prefix/to/sample.txt」というキーを持つオブジェクトを作成します。**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Key "prefix/to/sample.txt" -File .\local-sample.txt
```
**例 4: このコマンドは、サブディレクトリ「Scripts」内のすべてのファイルをバケット「test-files」にアップロードして、共通のキープレフィックス「SampleScripts」を各オブジェクトに適用します。アップロードされた各ファイルは「SampleScripts/filename」というキーを持ちます。ただし、「filename」の部分はそれぞれ異なります。**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Folder .\Scripts -KeyPrefix SampleScripts\
```
**例 5: このコマンドは、ローカルディレクトリ「Scripts」内のすべての \$1.ps1 ファイルをバケット「test-files」にアップロードして、共通のキープレフィックス「SampleScripts」を各オブジェクトに適用します。アップロードされた各ファイルは「SampleScripts/filename.ps1」というキーを持ちます。ただし、「filename」の部分はそれぞれ異なります。**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Folder .\Scripts -KeyPrefix SampleScripts\ -SearchPattern *.ps1
```
**例 6: このコマンドは、「sample.txt」というキーを持つ、指定されたコンテンツ文字列を含む新しい S3 オブジェクトを作成します。**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Key "sample.txt" -Content "object contents"
```
**例 7: このコマンドは、指定したファイル (ファイル名をキーとして使用) をアップロードして、指定したタグを新しいオブジェクトに適用します。**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -File "sample.txt" -TagSet @{Key="key1";Value="value1"},@{Key="key2";Value="value2"}
```
**例 8: このコマンドは、指定したフォルダを再帰的にアップロードして、指定したタグをすべての新しいオブジェクトに適用します。**
```
Write-S3Object -BucketName amzn-s3-demo-bucket -Folder . -KeyPrefix "TaggedFiles" -Recurse -TagSet @{Key="key1";Value="value1"},@{Key="key2";Value="value2"}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutObject](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Write-S3ObjectRetention`
次のコード例は、`Write-S3ObjectRetention` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、指定した S3 バケット内の「testfile.txt」オブジェクトの期限日「2019 年 12 月 31 日 00:00:00」までガバナンス保持モードを有効にします。**
```
Write-S3ObjectRetention -BucketName 'amzn-s3-demo-bucket' -Key 'testfile.txt' -Retention_Mode GOVERNANCE -Retention_RetainUntilDate "2019-12-31T00:00:00"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutObjectRetention](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用した Security Hub CSPM の例
次のコード例は、Security Hub CSPM で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Get-SHUBFinding`
次のコード例は、`Get-SHUBFinding` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、Amazon EC2; サービスから Security Hub の検出結果を取得します。**
```
$filter = New-Object -TypeName Amazon.SecurityHub.Model.AwsSecurityFindingFilters
$filter.ResourceType = New-Object -TypeName Amazon.SecurityHub.Model.StringFilter -Property @{
Comparison = 'PREFIX'
Value = 'AwsEc2'
}
Get-SHUBFinding -Filter $filter
```
**例 2: このコマンドは、 AWS アカウント ID 123456789012 から Security Hub の検出結果を取得します。**
```
$filter = New-Object -TypeName Amazon.SecurityHub.Model.AwsSecurityFindingFilters
$filter.AwsAccountId = New-Object -TypeName Amazon.SecurityHub.Model.StringFilter -Property @{
Comparison = 'EQUALS'
Value = '123456789012'
}
Get-SHUBFinding -Filter $filter
```
**例 3: このコマンドは、標準の「pci-dss」用に生成された Security Hub の検出結果を取得します。**
```
$filter = New-Object -TypeName Amazon.SecurityHub.Model.AwsSecurityFindingFilters
$filter.GeneratorId = New-Object -TypeName Amazon.SecurityHub.Model.StringFilter -Property @{
Comparison = 'PREFIX'
Value = 'pci-dss'
}
Get-SHUBFinding -Filter $filter
```
**例 4: このコマンドは、ワークフローステータスが NOTIFIED である Security Hub の、重要度が重大である検出結果を取得します。**
```
$filter = New-Object -TypeName Amazon.SecurityHub.Model.AwsSecurityFindingFilters
$filter.SeverityLabel = New-Object -TypeName Amazon.SecurityHub.Model.StringFilter -Property @{
Comparison = 'EQUALS'
Value = 'CRITICAL'
}
$filter.WorkflowStatus = New-Object -TypeName Amazon.SecurityHub.Model.StringFilter -Property @{
Comparison = 'EQUALS'
Value = 'NOTIFIED'
}
Get-SHUBFinding -Filter $filter
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetFindings](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用した Amazon SES の例
次のコード例は、Amazon SES で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Get-SESIdentity`
次のコード例は、`Get-SESIdentity` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、検証ステータスに関係なく、特定の AWS アカウントのすべての ID (E メールアドレスとドメイン) を含むリストを返します。**
```
Get-SESIdentity
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListIdentities](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SESSendQuota`
次のコード例は、`Get-SESSendQuota` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、ユーザーの現在の送信制限を返します。**
```
Get-SESSendQuota
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetSendQuota](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SESSendStatistic`
次のコード例は、`Get-SESSendStatistic` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、ユーザーの統計の送信を返します。結果は、送信アクティビティの最新の 2 週間を示すデータポイントのリストです。このリスト内の各データポイントには、15 分間隔の統計が含まれます。**
```
Get-SESSendStatistic
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetSendStatistics](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用した Amazon SES API v2 の例
次のコード例は、Amazon SES API v2 で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Send-SES2Email`
次のコード例は、`Send-SES2Email` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、標準の E メールメッセージを送信する方法を示します。**
```
Send-SES2Email -FromEmailAddress "sender@example.com" -Destination_ToAddress "recipient@example.com" -Subject_Data "Email Subject" -Text_Data "Email Body"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[SendEmail](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用した Amazon SNS の例
次のコード例は、Amazon SNS で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Publish-SNSMessage`
次のコード例は、`Publish-SNSMessage` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インラインで宣言された単一の MessageAttribute を使用してメッセージを発行しています。**
```
Publish-SNSMessage -TopicArn "arn:aws:sns:us-west-2:123456789012:my-topic" -Message "Hello" -MessageAttribute @{'City'=[Amazon.SimpleNotificationService.Model.MessageAttributeValue]@{DataType='String'; StringValue ='AnyCity'}}
```
**例 2: この例では、事前に宣言された複数の MessageAttribute を使用してメッセージを発行しています。**
```
$cityAttributeValue = New-Object Amazon.SimpleNotificationService.Model.MessageAttributeValue
$cityAttributeValue.DataType = "String"
$cityAttributeValue.StringValue = "AnyCity"
$populationAttributeValue = New-Object Amazon.SimpleNotificationService.Model.MessageAttributeValue
$populationAttributeValue.DataType = "Number"
$populationAttributeValue.StringValue = "1250800"
$messageAttributes = New-Object System.Collections.Hashtable
$messageAttributes.Add("City", $cityAttributeValue)
$messageAttributes.Add("Population", $populationAttributeValue)
Publish-SNSMessage -TopicArn "arn:aws:sns:us-west-2:123456789012:my-topic" -Message "Hello" -MessageAttribute $messageAttributes
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[Publish](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用した Amazon SQS の例
次のコード例は、Amazon SQS で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-SQSPermission`
次のコード例は、`Add-SQSPermission` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された が指定されたキューからメッセージを送信 AWS アカウント することを許可します。**
```
Add-SQSPermission -Action SendMessage -AWSAccountId 80398EXAMPLE -Label SendMessagesFromMyQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[AddPermission](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Clear-SQSQueue`
次のコード例は、`Clear-SQSQueue` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したキューからすべてのメッセージを削除します。**
```
Clear-SQSQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PurgeQueue](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Edit-SQSMessageVisibility`
次のコード例は、`Edit-SQSMessageVisibility` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したキュー内の指定した受信ハンドルを持つメッセージの可視性タイムアウトを 10 時間 (10 時間 × 60 分 × 60 秒 = 36,000 秒) に変更します。**
```
Edit-SQSMessageVisibility -QueueUrl https://sqs.us-east-1.amazonaws.com/8039EXAMPLE/MyQueue -ReceiptHandle AQEBgGDh...J/Iqww== -VisibilityTimeout 36000
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ChangeMessageVisibility](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-SQSMessageVisibilityBatch`
次のコード例は、`Edit-SQSMessageVisibilityBatch` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したキュー内の指定した受信ハンドルを持つ 2 つのメッセージの可視性タイムアウトを変更します。最初のメッセージの可視性タイムアウトを 10 時間 (10 時間 × 60 分 × 60 秒 = 36,000 秒) に変更します。2 番目のメッセージの可視性タイムアウトを 5 時間 (5 時間 × 60 分 × 60 秒 = 18,000 秒) に変更します。**
```
$changeVisibilityRequest1 = New-Object Amazon.SQS.Model.ChangeMessageVisibilityBatchRequestEntry
$changeVisibilityRequest1.Id = "Request1"
$changeVisibilityRequest1.ReceiptHandle = "AQEBd329...v6gl8Q=="
$changeVisibilityRequest1.VisibilityTimeout = 36000
$changeVisibilityRequest2 = New-Object Amazon.SQS.Model.ChangeMessageVisibilityBatchRequestEntry
$changeVisibilityRequest2.Id = "Request2"
$changeVisibilityRequest2.ReceiptHandle = "AQEBgGDh...J/Iqww=="
$changeVisibilityRequest2.VisibilityTimeout = 18000
Edit-SQSMessageVisibilityBatch -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue -Entry $changeVisibilityRequest1, $changeVisibilityRequest2
```
**出力:**
```
Failed Successful
------ ----------
{} {Request2, Request1}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ChangeMessageVisibilityBatch](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SQSDeadLetterSourceQueue`
次のコード例は、`Get-SQSDeadLetterSourceQueue` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、デッドレターキューとして指定したキューに依存するすべてのキューの URL を一覧表示します。**
```
Get-SQSDeadLetterSourceQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue
```
**出力:**
```
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyOtherQueue
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListDeadLetterSourceQueues](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SQSQueue`
次のコード例は、`Get-SQSQueue` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、すべてのキューを一覧表示します。**
```
Get-SQSQueue
```
**出力:**
```
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/AnotherQueue
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/DeadLetterQueue
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyOtherQueue
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue
```
**例 2: この例では、指定した名前で始まるすべてのキューを一覧表示します。**
```
Get-SQSQueue -QueueNamePrefix My
```
**出力:**
```
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyOtherQueue
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListQueues](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SQSQueueAttribute`
次のコード例は、`Get-SQSQueueAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したキューのすべての属性を一覧表示します。**
```
Get-SQSQueueAttribute -AttributeName All -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
**出力:**
```
VisibilityTimeout : 30
DelaySeconds : 0
MaximumMessageSize : 262144
MessageRetentionPeriod : 345600
ApproximateNumberOfMessages : 0
ApproximateNumberOfMessagesNotVisible : 0
ApproximateNumberOfMessagesDelayed : 0
CreatedTimestamp : 2/11/2015 5:53:35 PM
LastModifiedTimestamp : 12/29/2015 2:23:17 PM
QueueARN : arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue
Policy : {"Version":"2012-10-17", "Id":"arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue/SQSDefaultPolicy","Statement":[{"Sid":"Sid14
495134224EX","Effect":"Allow","Principal":{"AWS":"*"},"Action":"SQS:SendMessage","Resource":"arn:aws:sqs:us-east-1:80
398EXAMPLE:MyQueue","Condition":{"ArnEquals":{"aws:SourceArn":"arn:aws:sns:us-east-1:80398EXAMPLE:MyTopic"}}},{"Sid":
"SendMessagesFromMyQueue","Effect":"Allow","Principal":{"AWS":"80398EXAMPLE"},"Action":"SQS:SendMessage","Resource":"
arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue"}]}
Attributes : {[QueueArn, arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue], [ApproximateNumberOfMessages, 0],
[ApproximateNumberOfMessagesNotVisible, 0], [ApproximateNumberOfMessagesDelayed, 0]...}
```
**例 2: この例では、指定したキューの指定した属性のみを別個に一覧表示します。**
```
Get-SQSQueueAttribute -AttributeName MaximumMessageSize, VisibilityTimeout -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
**出力:**
```
VisibilityTimeout : 30
DelaySeconds : 0
MaximumMessageSize : 262144
MessageRetentionPeriod : 345600
ApproximateNumberOfMessages : 0
ApproximateNumberOfMessagesNotVisible : 0
ApproximateNumberOfMessagesDelayed : 0
CreatedTimestamp : 2/11/2015 5:53:35 PM
LastModifiedTimestamp : 12/29/2015 2:23:17 PM
QueueARN : arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue
Policy : {"Version":"2012-10-17", "Id":"arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue/SQSDefaultPolicy","Statement":[{"Sid":"Sid14
495134224EX","Effect":"Allow","Principal":{"AWS":"*"},"Action":"SQS:SendMessage","Resource":"arn:aws:sqs:us-east-1:80
398EXAMPLE:MyQueue","Condition":{"ArnEquals":{"aws:SourceArn":"arn:aws:sns:us-east-1:80398EXAMPLE:MyTopic"}}},{"Sid":
"SendMessagesFromMyQueue","Effect":"Allow","Principal":{"AWS":"80398EXAMPLE"},"Action":"SQS:SendMessage","Resource":"
arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue"}]}
Attributes : {[MaximumMessageSize, 262144], [VisibilityTimeout, 30]}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetQueueAttributes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SQSQueueUrl`
次のコード例は、`Get-SQSQueueUrl` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した名前のキューの URL を表示します。**
```
Get-SQSQueueUrl -QueueName MyQueue
```
**出力:**
```
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetQueueUrl](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-SQSQueue`
次のコード例は、`New-SQSQueue` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した名前でキューを作成します。**
```
New-SQSQueue -QueueName MyQueue
```
**出力:**
```
https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateQueue](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Receive-SQSMessage`
次のコード例は、`Receive-SQSMessage` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したキューで次に受信する 10 件までのメッセージに関する情報を表示します。情報には、指定したメッセージ属性 (存在する場合) の値が含まれます。**
```
Receive-SQSMessage -AttributeName SenderId, SentTimestamp -MessageAttributeName StudentName, StudentGrade -MessageCount 10 -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
**出力:**
```
Attributes : {[SenderId, AIDAIAZKMSNQ7TEXAMPLE], [SentTimestamp, 1451495923744]}
Body : Information about John Doe's grade.
MD5OfBody : ea572796e3c231f974fe75d89EXAMPLE
MD5OfMessageAttributes : 48c1ee811f0fe7c4e88fbe0f5EXAMPLE
MessageAttributes : {[StudentGrade, Amazon.SQS.Model.MessageAttributeValue], [StudentName, Amazon.SQS.Model.MessageAttributeValue]}
MessageId : 53828c4b-631b-469b-8833-c093cEXAMPLE
ReceiptHandle : AQEBpfGp...20Q5cg==
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ReceiveMessage](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-SQSMessage`
次のコード例は、`Remove-SQSMessage` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した受信ハンドルを持つメッセージを指定したキューから削除します。**
```
Remove-SQSMessage -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue -ReceiptHandle AQEBd329...v6gl8Q==
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteMessage](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-SQSMessageBatch`
次のコード例は、`Remove-SQSMessageBatch` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した受信ハンドルを持つ 2 つのメッセージを指定したキューから削除します。**
```
$deleteMessageRequest1 = New-Object Amazon.SQS.Model.DeleteMessageBatchRequestEntry
$deleteMessageRequest1.Id = "Request1"
$deleteMessageRequest1.ReceiptHandle = "AQEBX2g4...wtJSQg=="
$deleteMessageRequest2 = New-Object Amazon.SQS.Model.DeleteMessageBatchRequestEntry
$deleteMessageRequest2.Id = "Request2"
$deleteMessageRequest2.ReceiptHandle = "AQEBqOVY...KTsLYg=="
Remove-SQSMessageBatch -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue -Entry $deleteMessageRequest1, $deleteMessageRequest2
```
**出力:**
```
Failed Successful
------ ----------
{} {Request1, Request2}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteMessageBatch](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-SQSPermission`
次のコード例は、`Remove-SQSPermission` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定したラベルを持つアクセス許可設定を、指定したキューから削除します。**
```
Remove-SQSPermission -Label SendMessagesFromMyQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[RemovePermission](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-SQSQueue`
次のコード例は、`Remove-SQSQueue` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: こので例は、指定したキューを削除します。**
```
Remove-SQSQueue -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteQueue](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Send-SQSMessage`
次のコード例は、`Send-SQSMessage` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した属性とメッセージ本文を持つメッセージを指定したキューに送信し、メッセージの配信を 10 秒遅延させます。**
```
$cityAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue
$cityAttributeValue.DataType = "String"
$cityAttributeValue.StringValue = "AnyCity"
$populationAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue
$populationAttributeValue.DataType = "Number"
$populationAttributeValue.StringValue = "1250800"
$messageAttributes = New-Object System.Collections.Hashtable
$messageAttributes.Add("City", $cityAttributeValue)
$messageAttributes.Add("Population", $populationAttributeValue)
Send-SQSMessage -DelayInSeconds 10 -MessageAttributes $messageAttributes -MessageBody "Information about the largest city in Any Region." -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
**出力:**
```
MD5OfMessageAttributes MD5OfMessageBody MessageId
---------------------- ---------------- ---------
1d3e51347bc042efbdf6dda31EXAMPLE 51b0a3256d59467f973009b73EXAMPLE c35fed8f-c739-4d0c-818b-1820eEXAMPLE
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[SendMessage](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Send-SQSMessageBatch`
次のコード例は、`Send-SQSMessageBatch` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定した属性とメッセージ本文を持つ 2 つのメッセージを指定したキューに送信します。最初のメッセージでは配信を 15 秒遅延させ、2 番目のメッセージでは配信を 10 秒遅延させます。**
```
$student1NameAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue
$student1NameAttributeValue.DataType = "String"
$student1NameAttributeValue.StringValue = "John Doe"
$student1GradeAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue
$student1GradeAttributeValue.DataType = "Number"
$student1GradeAttributeValue.StringValue = "89"
$student2NameAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue
$student2NameAttributeValue.DataType = "String"
$student2NameAttributeValue.StringValue = "Jane Doe"
$student2GradeAttributeValue = New-Object Amazon.SQS.Model.MessageAttributeValue
$student2GradeAttributeValue.DataType = "Number"
$student2GradeAttributeValue.StringValue = "93"
$message1 = New-Object Amazon.SQS.Model.SendMessageBatchRequestEntry
$message1.DelaySeconds = 15
$message1.Id = "FirstMessage"
$message1.MessageAttributes.Add("StudentName", $student1NameAttributeValue)
$message1.MessageAttributes.Add("StudentGrade", $student1GradeAttributeValue)
$message1.MessageBody = "Information about John Doe's grade."
$message2 = New-Object Amazon.SQS.Model.SendMessageBatchRequestEntry
$message2.DelaySeconds = 10
$message2.Id = "SecondMessage"
$message2.MessageAttributes.Add("StudentName", $student2NameAttributeValue)
$message2.MessageAttributes.Add("StudentGrade", $student2GradeAttributeValue)
$message2.MessageBody = "Information about Jane Doe's grade."
Send-SQSMessageBatch -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue -Entry $message1, $message2
```
**出力:**
```
Failed Successful
------ ----------
{} {FirstMessage, SecondMessage}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[SendMessageBatch](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Set-SQSQueueAttribute`
次のコード例は、`Set-SQSQueueAttribute` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、キューを SNS トピックにサブスクライブするポリシーを設定する方法を示します。メッセージをトピックに発行すると、メッセージはサブスクライブしたキューに送信されます。**
```
# create the queue and topic to be associated
$qurl = New-SQSQueue -QueueName "myQueue"
$topicarn = New-SNSTopic -Name "myTopic"
# get the queue ARN to inject into the policy; it will be returned
# in the output's QueueARN member but we need to put it into a variable
# so text expansion in the policy string takes effect
$qarn = (Get-SQSQueueAttribute -QueueUrl $qurl -AttributeName "QueueArn").QueueARN
# construct the policy and inject arns
$policy = @"
{
"Version":"2012-10-17",
"Id": "$qarn/SQSPOLICY",
"Statement": [
{
"Sid": "1",
"Effect": "Allow",
"Principal": "*",
"Action": "SQS:SendMessage",
"Resource": "$qarn",
"Condition": {
"ArnEquals": {
"aws:SourceArn": "$topicarn"
}
}
}
]
}
"@
# set the policy
Set-SQSQueueAttribute -QueueUrl $qurl -Attribute @{ Policy=$policy }
```
**例 2: この例では、指定したキューに指定した属性を設定します。**
```
Set-SQSQueueAttribute -Attribute @{"DelaySeconds" = "10"; "MaximumMessageSize" = "131072"} -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[SetQueueAttributes](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
# AWS STS Tools for PowerShell V5 を使用した の例
次のコード例は、 で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています AWS STS。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Convert-STSAuthorizationMessage`
次のコード例は、`Convert-STSAuthorizationMessage` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: リクエストへの応答として返された、指定されたエンコード済みメッセージコンテンツに含まれる追加情報をデコードします。承認ステータスの詳細は、アクションをリクエストしたユーザーが見てはならない特権情報である可能性があるため、追加情報はエンコードされます。**
```
Convert-STSAuthorizationMessage -EncodedMessage "...encoded message..."
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DecodeAuthorizationMessage](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-STSFederationToken`
次のコード例は、`Get-STSFederationToken` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 「Bob」をフェデレーションユーザーの名前として使用して、1 時間有効なフェデレーショントークンをリクエストします。この名前は、リソースベースのポリシー (Amazon S3 バケットポリシーなど) のフェデレーションユーザー名を参照するために使用できます。提供される JSON 形式の IAM ポリシーを使用して、IAM ユーザーが利用できるアクセス権限の範囲を絞り込みます。指定されたポリシーでは、リクエストしたユーザーに付与されたアクセス権限よりも多くのアクセス権限を付与することはできません。フェデレーションユーザーの最終的なアクセス権限は、渡されたポリシーと IAM ユーザーポリシーの共通部分に基づいて最も制限の厳しい一式となります。**
```
Get-STSFederationToken -Name "Bob" -Policy "...JSON policy..." -DurationInSeconds 3600
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetFederationToken](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-STSSessionToken`
次のコード例は、`Get-STSSessionToken` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 一定期間有効な一時的な認証情報を含む `Amazon.RuntimeAWSCredentials` インスタンスを返します。一時的な認証情報をリクエストするために使用される認証情報は、現在のシェルのデフォルトから推測されます。他の認証情報を指定するには、-ProfileName または-AccessKey/-SecretKey パラメータを使用します。**
```
Get-STSSessionToken
```
**出力:**
```
AccessKeyId Expiration SecretAccessKey SessionToken
----------- ---------- --------------- ------------
EXAMPLEACCESSKEYID 2/16/2015 9:12:28 PM examplesecretaccesskey... SamPleTokeN.....
```
**例 2: 1 時間有効な一時的な認証情報を含む `Amazon.RuntimeAWSCredentials` インスタンスを返します。リクエストを行うために使用される認証情報は、指定されたプロファイルから取得されます。**
```
Get-STSSessionToken -DurationInSeconds 3600 -ProfileName myprofile
```
**出力:**
```
AccessKeyId Expiration SecretAccessKey SessionToken
----------- ---------- --------------- ------------
EXAMPLEACCESSKEYID 2/16/2015 9:12:28 PM examplesecretaccesskey... SamPleTokeN.....
```
**例 3: プロファイル「myprofilename」で認証情報が指定されているアカウントに関連付けられた MFA デバイスの識別番号とデバイスから提供された値を使用して、1 時間有効な一時的な認証情報を含む `Amazon.RuntimeAWSCredentials` インスタンスを返します。**
```
Get-STSSessionToken -DurationInSeconds 3600 -ProfileName myprofile -SerialNumber YourMFADeviceSerialNumber -TokenCode 123456
```
**出力:**
```
AccessKeyId Expiration SecretAccessKey SessionToken
----------- ---------- --------------- ------------
EXAMPLEACCESSKEYID 2/16/2015 9:12:28 PM examplesecretaccesskey... SamPleTokeN.....
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetSessionToken](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Use-STSRole`
次のコード例は、`Use-STSRole` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: リクエスト元のユーザーが通常アクセスできない AWS リソースにアクセスするために 1 時間使用できる一時的な認証情報 (アクセスキー、シークレットキー、セッショントークン) のセットを返します。返される認証情報には、引き受けているロールのアクセスポリシーと提供されたポリシーで許可されている権限があります (提供されたポリシーを使用して、引き受けているロールのアクセスポリシーで定義されている権限を超える権限を付与することはできません)。**
```
Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -Policy "...JSON policy..." -DurationInSeconds 3600
```
**例 2: 引き受けているロールのアクセスポリシーで定義されているのと同じ権限を持つ、1 時間有効の一時的な認証情報を返します。**
```
Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -DurationInSeconds 3600
```
**例 3: コマンドレットの実行に使用されるユーザー認証情報に関連付けられている MFA からシリアル番号と生成されたトークンを提供する一時的な認証情報一式を返します。**
```
Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -DurationInSeconds 3600 -SerialNumber "GAHT12345678" -TokenCode "123456"
```
**例 4: 顧客アカウントで定義されているロールを引き受けた一時的な認証情報一式を返します。第三者が引き受けることができるロールごとに、顧客アカウントは、ロールを引き受けるたび、-ExternalId パラメータで渡す必要がある識別子を使用してロールを作成する必要があります。**
```
Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -DurationInSeconds 3600 -ExternalId "ABC123"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[AssumeRole](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Use-STSWebIdentityRole`
次のコード例は、`Use-STSWebIdentityRole` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: Login with Amazon ID プロバイダーで認証されたユーザーの一時的な認証情報一式 (1 時間有効) を返します。認証情報は、ロール ARN によって識別されるロールに関連付けられたアクセスポリシーを引き受けます。オプションで、JSON ポリシーを-Policy パラメータに渡して、アクセス権限をさらに絞り込むことができます (ロールに関連付けられている権限で使用可能な権限よりも多くの権限を付与することはできません)。-WebIdentityToken に渡される値は、ID プロバイダーから返された一意のユーザー識別子です。**
```
Use-STSWebIdentityRole -DurationInSeconds 3600 -ProviderId "www.amazon.com" -RoleSessionName "app1" -RoleArn "arn:aws:iam::123456789012:role/FederatedWebIdentityRole" -WebIdentityToken "Atza...DVI0r1"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[AssumeRoleWithWebIdentity](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# サポート Tools for PowerShell V5 を使用した の例
次のコード例は、 で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています サポート。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-ASACommunicationToCase`
次のコード例は、`Add-ASACommunicationToCase` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定したケースに E メールの本文を追加します。**
```
Add-ASACommunicationToCase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -CommunicationBody "Some text about the case"
```
**例 2: 指定されたケースに E メールの本文と、E メールの CC 行に含まれる 1 つ以上の E メールアドレスを追加します。**
```
Add-ASACommunicationToCase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -CcEmailAddress @("email1@address.com", "email2@address.com") -CommunicationBody "Some text about the case"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[AddCommunicationToCase](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-ASACase`
次のコード例は、`Get-ASACase` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: すべてのサポートケースの詳細を返します。**
```
Get-ASACase
```
**例 2: 指定された日時以降のすべてのサポートケースの詳細を返します。**
```
Get-ASACase -AfterTime "2013-09-10T03:06Z"
```
**例 3: 解決済みのサポートケースを含め、最初の 10 件のサポートケースの詳細を返します。**
```
Get-ASACase -MaxResult 10 -IncludeResolvedCases $true
```
**例 4: 単一の指定されたサポートケースの詳細を返します。**
```
Get-ASACase -CaseIdList "case-12345678910-2013-c4c1d2bf33c5cf47"
```
**例 5: 指定されたサポートケースの詳細を返します。**
```
Get-ASACase -CaseIdList @("case-12345678910-2013-c4c1d2bf33c5cf47", "case-18929034710-2011-c4fdeabf33c5cf47")
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeCases](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-ASACommunication`
次のコード例は、`Get-ASACommunication` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたケースのすべてのコミュニケーションを返します。**
```
Get-ASACommunication -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47"
```
**例 2: 指定されたケースについて、2012 年 1 月 1 日の午前 0 時 (UTC) 以降のすべてのコミュニケーションを返します。**
```
Get-ASACommunication -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47" -AfterTime "2012-01-10T00:00Z"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeCommunications](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-ASAService`
次のコード例は、`Get-ASAService` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 使用可能なすべてのサービスコード、名前、カテゴリを返します。**
```
Get-ASAService
```
**例 2: 指定されたコードを持つサービスの名前とカテゴリを返します。**
```
Get-ASAService -ServiceCodeList "amazon-cloudfront"
```
**例 3: 指定されたサービスコードの名前とカテゴリを返します。**
```
Get-ASAService -ServiceCodeList @("amazon-cloudfront", "amazon-cloudwatch")
```
**例 4: 指定されたサービスコードの名前とカテゴリ (日本語) を返します。現在、英語 (「en」) と日本語 (「ja」) の言語コードがサポートされています。**
```
Get-ASAService -ServiceCodeList @("amazon-cloudfront", "amazon-cloudwatch") -Language "ja"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeServices](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-ASASeverityLevel`
次のコード例は、`Get-ASASeverityLevel` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: AWS サポートケースに割り当てることができる重要度レベルのリストを返します。**
```
Get-ASASeverityLevel
```
**例 2: AWS サポートケースに割り当てることができる重要度レベルのリストを返します。レベルの名前は日本語で返されます。**
```
Get-ASASeverityLevel -Language "ja"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeSeverityLevels](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-ASATrustedAdvisorCheck`
次のコード例は、`Get-ASATrustedAdvisorCheck` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: Trusted Advisor チェックのコレクションを返します。英語出力の場合は「en」、日本語出力の場合は「ja」のいずれかを使用できる Language パラメータを指定する必要があります。**
```
Get-ASATrustedAdvisorCheck -Language "en"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeTrustedAdvisorChecks](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-ASATrustedAdvisorCheckRefreshStatus`
次のコード例は、`Get-ASATrustedAdvisorCheckRefreshStatus` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたチェックの更新リクエストの現在のステータスを返します。Request-ASATrustedAdvisorCheckRefresh を使用して、チェックのステータス情報の更新をリクエストできます。**
```
Get-ASATrustedAdvisorCheckRefreshStatus -CheckId @("checkid1", "checkid2")
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeTrustedAdvisorCheckRefreshStatuses](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-ASATrustedAdvisorCheckResult`
次のコード例は、`Get-ASATrustedAdvisorCheckResult` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: Trusted Advisor チェックの結果を返します。利用可能な Trusted Advisor チェックのリストは、Get-ASATrustedAdvisorChecks を使用して取得できます。出力は、チェックの全体的なステータス、最後のチェック実行時のタイムスタンプ、および特定のチェックの一意のチェック ID です。結果を日本語で出力するには、-Language「ja」パラメータを追加します。**
```
Get-ASATrustedAdvisorCheckResult -CheckId "checkid1"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeTrustedAdvisorCheckResult](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-ASATrustedAdvisorCheckSummary`
次のコード例は、`Get-ASATrustedAdvisorCheckSummary` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定された Trusted Advisor チェックの最新の概要を返します。**
```
Get-ASATrustedAdvisorCheckSummary -CheckId "checkid1"
```
**例 2: 指定された Trusted Advisor チェックの最新の概要を返します。**
```
Get-ASATrustedAdvisorCheckSummary -CheckId @("checkid1", "checkid2")
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeTrustedAdvisorCheckSummaries](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-ASACase`
次のコード例は、`New-ASACase` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: AWS サポートセンターで新しいケースを作成します。-ServiceCode および -CategoryCode パラメータの値は、Get-ASAService コマンドレットを使用して取得できます。-SeverityCode パラメータの値は、Get-ASASeverityLevel コマンドレットを使用して取得できます。-IssueType パラメータ値は、「customer-service」または「technical」のいずれかです。成功すると、 AWS サポートケース番号が出力されます。デフォルトでは、ケースは英語で処理され、日本語を使用するには、-Language「ja」パラメータを追加します。-ServiceCode、-CategoryCode、-Subject、-CommunicationBody パラメータは必須です。**
```
New-ASACase -ServiceCode "amazon-cloudfront" -CategoryCode "APIs" -SeverityCode "low" -Subject "subject text" -CommunicationBody "description of the case" -CcEmailAddress @("email1@domain.com", "email2@domain.com") -IssueType "technical"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateCase](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Request-ASATrustedAdvisorCheckRefresh`
次のコード例は、`Request-ASATrustedAdvisorCheckRefresh` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定された Trusted Advisor チェックの更新をリクエストします。**
```
Request-ASATrustedAdvisorCheckRefresh -CheckId "checkid1"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[RefreshTrustedAdvisorCheck](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Resolve-ASACase`
次のコード例は、`Resolve-ASACase` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたケースの初期状態と、解決のための呼び出しが完了した後の現在の状態を返します。**
```
Resolve-ASACase -CaseId "case-12345678910-2013-c4c1d2bf33c5cf47"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ResolveCase](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用した Systems Manager の例
次のコード例は、Systems Manager で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Add-SSMResourceTag`
次のコード例は、`Add-SSMResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、新しいタグを使用してメンテナンスウィンドウを更新します。コマンドが成功した場合、出力はありません。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
$option1 = @{Key="Stack";Value=@("Production")}
Add-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" -Tag $option1
```
**例 2: PowerShell バージョン 2 では、New-Object を使用して各タグを作成する必要があります。コマンドが成功した場合、出力はありません。**
```
$tag1 = New-Object Amazon.SimpleSystemsManagement.Model.Tag
$tag1.Key = "Stack"
$tag1.Value = "Production"
Add-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" -Tag $tag1
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[AddTagsToResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Edit-SSMDocumentPermission`
次のコード例は、`Edit-SSMDocumentPermission` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ドキュメントのすべてのアカウントに「共有」アクセス許可を追加します。コマンドが成功した場合、出力はありません。**
```
Edit-SSMDocumentPermission -Name "RunShellScript" -PermissionType "Share" -AccountIdsToAdd all
```
**例 2: この例では、ドキュメントの特定のアカウントに「共有」アクセス許可を追加します。コマンドが成功した場合、出力はありません。**
```
Edit-SSMDocumentPermission -Name "RunShellScriptNew" -PermissionType "Share" -AccountIdsToAdd "123456789012"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ModifyDocumentPermission](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMActivation`
次のコード例は、`Get-SSMActivation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、アカウントのアクティベーションに関する詳細情報を示します。**
```
Get-SSMActivation
```
**出力:**
```
ActivationId : 08e51e79-1e36-446c-8e63-9458569c1363
CreatedDate : 3/1/2017 12:01:51 AM
DefaultInstanceName : MyWebServers
Description :
ExpirationDate : 3/2/2017 12:01:51 AM
Expired : False
IamRole : AutomationRole
RegistrationLimit : 10
RegistrationsCount : 0
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeActivations](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMAssociation`
次のコード例は、`Get-SSMAssociation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インスタンスとドキュメントの関連付けを記述します。**
```
Get-SSMAssociation -InstanceId "i-0000293ffd8c57862" -Name "AWS-UpdateSSMAgent"
```
**出力:**
```
Name : AWS-UpdateSSMAgent
InstanceId : i-0000293ffd8c57862
Date : 2/23/2017 6:55:22 PM
Status.Name : Pending
Status.Date : 2/20/2015 8:31:11 AM
Status.Message : temp_status_change
Status.AdditionalInfo : Additional-Config-Needed
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeAssociation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMAssociationExecution`
次のコード例は、`Get-SSMAssociationExecution` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された関連付け ID の実行を返します。**
```
Get-SSMAssociationExecution -AssociationId 123a45a0-c678-9012-3456-78901234db5e
```
**出力:**
```
AssociationId : 123a45a0-c678-9012-3456-78901234db5e
AssociationVersion : 2
CreatedTime : 3/2/2019 8:53:29 AM
DetailedStatus :
ExecutionId : 123a45a0-c678-9012-3456-78901234db5e
LastExecutionDate : 1/1/0001 12:00:00 AM
ResourceCountByStatus : {Success=4}
Status : Success
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeAssociationExecutions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMAssociationExecutionTarget`
次のコード例は、`Get-SSMAssociationExecutionTarget` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、関連付けの実行ターゲットの一部であるリソース ID とその実行ステータスを表示します。**
```
Get-SSMAssociationExecutionTarget -AssociationId 123a45a0-c678-9012-3456-78901234db5e -ExecutionId 123a45a0-c678-9012-3456-78901234db5e | Select-Object ResourceId, Status
```
**出力:**
```
ResourceId Status
---------- ------
i-0b1b2a3456f7a890b Success
i-01c12a45d6fc7a89f Success
i-0a1caf234f56d7dc8 Success
i-012a3fd45af6dbcfe Failed
i-0ddc1df23c4a5fb67 Success
```
**例 2: このコマンドは、コマンドドキュメントが関連付けられている昨日以降の特定のオートメーションにおける、特定の実行をチェックします。さらに、関連付けの実行が失敗したかどうかを確認し、失敗した場合は、実行のコマンド呼び出しの詳細情報とインスタンス ID が表示されます。**
```
$AssociationExecution= Get-SSMAssociationExecutionTarget -AssociationId 1c234567-890f-1aca-a234-5a678d901cb0 -ExecutionId 12345ca12-3456-2345-2b45-23456789012 |
Where-Object {$_.LastExecutionDate -gt (Get-Date -Hour 00 -Minute 00).AddDays(-1)}
foreach ($execution in $AssociationExecution) {
if($execution.Status -ne 'Success'){
Write-Output "There was an issue executing the association $($execution.AssociationId) on $($execution.ResourceId)"
Get-SSMCommandInvocation -CommandId $execution.OutputSource.OutputSourceId -Detail:$true | Select-Object -ExpandProperty CommandPlugins
}
}
```
**出力:**
```
There was an issue executing the association 1c234567-890f-1aca-a234-5a678d901cb0 on i-0a1caf234f56d7dc8
Name : aws:runPowerShellScript
Output :
----------ERROR-------
failed to run commands: exit status 1
OutputS3BucketName :
OutputS3KeyPrefix :
OutputS3Region : eu-west-1
ResponseCode : 1
ResponseFinishDateTime : 5/29/2019 11:04:49 AM
ResponseStartDateTime : 5/29/2019 11:04:49 AM
StandardErrorUrl :
StandardOutputUrl :
Status : Failed
StatusDetails : Failed
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeAssociationExecutionTargets](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMAssociationList`
次のコード例は、`Get-SSMAssociationList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インスタンスのすべての関連付けを一覧表示します。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
$filter1 = @{Key="InstanceId";Value=@("i-0000293ffd8c57862")}
Get-SSMAssociationList -AssociationFilterList $filter1
```
**出力:**
```
AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0
DocumentVersion :
InstanceId : i-0000293ffd8c57862
LastExecutionDate : 2/20/2015 8:31:11 AM
Name : AWS-UpdateSSMAgent
Overview : Amazon.SimpleSystemsManagement.Model.AssociationOverview
ScheduleExpression :
Targets : {InstanceIds}
```
**例 2: この例では、設定ドキュメントのすべての関連付けを一覧表示します。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
$filter2 = @{Key="Name";Value=@("AWS-UpdateSSMAgent")}
Get-SSMAssociationList -AssociationFilterList $filter2
```
**出力:**
```
AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0
DocumentVersion :
InstanceId : i-0000293ffd8c57862
LastExecutionDate : 2/20/2015 8:31:11 AM
Name : AWS-UpdateSSMAgent
Overview : Amazon.SimpleSystemsManagement.Model.AssociationOverview
ScheduleExpression :
Targets : {InstanceIds}
```
**例 3: PowerShell バージョン 2 では、New-Object を使用して各フィルターを作成する必要があります。**
```
$filter1 = New-Object Amazon.SimpleSystemsManagement.Model.AssociationFilter
$filter1.Key = "InstanceId"
$filter1.Value = "i-0000293ffd8c57862"
Get-SSMAssociationList -AssociationFilterList $filter1
```
**出力:**
```
AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0
DocumentVersion :
InstanceId : i-0000293ffd8c57862
LastExecutionDate : 2/20/2015 8:31:11 AM
Name : AWS-UpdateSSMAgent
Overview : Amazon.SimpleSystemsManagement.Model.AssociationOverview
ScheduleExpression :
Targets : {InstanceIds}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListAssociations](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMAssociationVersionList`
次のコード例は、`Get-SSMAssociationVersionList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定された関連付けのすべてのバージョンを取得します。**
```
Get-SSMAssociationVersionList -AssociationId 123a45a0-c678-9012-3456-78901234db5e
```
**出力:**
```
AssociationId : 123a45a0-c678-9012-3456-78901234db5e
AssociationName :
AssociationVersion : 2
ComplianceSeverity :
CreatedDate : 3/12/2019 9:21:01 AM
DocumentVersion :
MaxConcurrency :
MaxErrors :
Name : AWS-GatherSoftwareInventory
OutputLocation :
Parameters : {}
ScheduleExpression :
Targets : {InstanceIds}
AssociationId : 123a45a0-c678-9012-3456-78901234db5e
AssociationName : test-case-1234567890
AssociationVersion : 1
ComplianceSeverity :
CreatedDate : 3/2/2019 8:53:29 AM
DocumentVersion :
MaxConcurrency :
MaxErrors :
Name : AWS-GatherSoftwareInventory
OutputLocation :
Parameters : {}
ScheduleExpression : rate(30minutes)
Targets : {InstanceIds}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListAssociationVersions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMAutomationExecution`
次のコード例は、`Get-SSMAutomationExecution` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、オートメーションの実行に関する詳細を表示します。**
```
Get-SSMAutomationExecution -AutomationExecutionId "4105a4fc-f944-11e6-9d32-8fb2db27a909"
```
**出力:**
```
AutomationExecutionId : 4105a4fc-f944-11e6-9d32-8fb2db27a909
AutomationExecutionStatus : Failed
DocumentName : AWS-UpdateLinuxAmi
DocumentVersion : 1
ExecutionEndTime : 2/22/2017 9:17:08 PM
ExecutionStartTime : 2/22/2017 9:17:02 PM
FailureMessage : Step launchInstance failed maximum allowed times. You are not authorized to perform this operation. Encoded
authorization failure message: B_V2QyyN7NhSZQYpmVzpEc4oSnj2GLTNYnXUHsTbqJkNMoDgubmbtthLmZyaiUYekORIrA42-fv1x-04q5Fjff6glh
Yb6TI5b0GQeeNrpwNvpDzmO-PSR1swlAbg9fdM9BcNjyrznspUkWpuKu9EC1Ou6v3OXU1KC9nZ7mPlWMFZNkSioQqpwWEvMw-GZktsQzm67qOhUhBNOLWYhbS
pkfiqzY-5nw3S0obx30fhd3EJa5O_-GjV_a0nFXQJa70ik40bFOrEh3MtCSbrQT6--DvFy_FQ8TKvkIXadyVskeJI84XOF5WmA60f1pi5GI08i-nRfZS6oDeU
gELBjjoFKD8s3L2aI0B6umWVxnQOjqhQRxwJ53b54sZJ2PW3v_mtg9-q0CK0ezS3xfh_y0ilaUGOAZG-xjQFuvU_JZedWpla3xi-MZsmblAifBI
(Service: AmazonEC2; Status Code: 403; Error Code: UnauthorizedOperation; Request ID:
6a002f94-ba37-43fd-99e6-39517715fce5)
Outputs : {[createImage.ImageId, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
Parameters : {[AutomationAssumeRole, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]], [InstanceIamRole,
Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]], [SourceAmiId,
Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
StepExecutions : {launchInstance, updateOSSoftware, stopInstance, createImage...}
```
**例 2: この例では、指定されたオートメーションの実行 ID におけるステップの詳細情報を一覧表示します。**
```
Get-SSMAutomationExecution -AutomationExecutionId e1d2bad3-4567-8901-ae23-456c7c8901be | Select-Object -ExpandProperty StepExecutions | Select-Object StepName, Action, StepStatus, ValidNextSteps
```
**出力:**
```
StepName Action StepStatus ValidNextSteps
-------- ------ ---------- --------------
LaunchInstance aws:runInstances Success {OSCompatibilityCheck}
OSCompatibilityCheck aws:runCommand Success {RunPreUpdateScript}
RunPreUpdateScript aws:runCommand Success {UpdateEC2Config}
UpdateEC2Config aws:runCommand Cancelled {}
UpdateSSMAgent aws:runCommand Pending {}
UpdateAWSPVDriver aws:runCommand Pending {}
UpdateAWSEnaNetworkDriver aws:runCommand Pending {}
UpdateAWSNVMe aws:runCommand Pending {}
InstallWindowsUpdates aws:runCommand Pending {}
RunPostUpdateScript aws:runCommand Pending {}
RunSysprepGeneralize aws:runCommand Pending {}
StopInstance aws:changeInstanceState Pending {}
CreateImage aws:createImage Pending {}
TerminateInstance aws:changeInstanceState Pending {}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetAutomationExecution](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMAutomationExecutionList`
次のコード例は、`Get-SSMAutomationExecutionList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、アカウントに関連付けられているすべてのアクティブなオートメーションの実行と、終了したオートメーションの実行を記述します。**
```
Get-SSMAutomationExecutionList
```
**出力:**
```
AutomationExecutionId : 4105a4fc-f944-11e6-9d32-8fb2db27a909
AutomationExecutionStatus : Failed
DocumentName : AWS-UpdateLinuxAmi
DocumentVersion : 1
ExecutedBy : admin
ExecutionEndTime : 2/22/2017 9:17:08 PM
ExecutionStartTime : 2/22/2017 9:17:02 PM
LogFile :
Outputs : {[createImage.ImageId, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
```
**例 2: この例では、AutomationExecutionStatus の「Success」以外の実行について、ExecutionID、ドキュメント、実行開始/終了タイムスタンプを表示します。**
```
Get-SSMAutomationExecutionList | Where-Object AutomationExecutionStatus -ne "Success" | Select-Object AutomationExecutionId, DocumentName, AutomationExecutionStatus, ExecutionStartTime, ExecutionEndTime | Format-Table -AutoSize
```
**出力:**
```
AutomationExecutionId DocumentName AutomationExecutionStatus ExecutionStartTime ExecutionEndTime
--------------------- ------------ ------------------------- ------------------ ----------------
e1d2bad3-4567-8901-ae23-456c7c8901be AWS-UpdateWindowsAmi Cancelled 4/16/2019 5:37:04 AM 4/16/2019 5:47:29 AM
61234567-a7f8-90e1-2b34-567b8bf9012c Fixed-UpdateAmi Cancelled 4/16/2019 5:33:04 AM 4/16/2019 5:40:15 AM
91234d56-7e89-0ac1-2aee-34ea5d6a7c89 AWS-UpdateWindowsAmi Failed 4/16/2019 5:22:46 AM 4/16/2019 5:27:29 AM
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeAutomationExecutions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-SSMAutomationStepExecution`
次のコード例は、`Get-SSMAutomationStepExecution` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、オートメーションワークフローにおけるすべてのアクティブなステップの実行と、終了したステップの実行に関する情報を表示します。**
```
Get-SSMAutomationStepExecution -AutomationExecutionId e1d2bad3-4567-8901-ae23-456c7c8901be | Select-Object StepName, Action, StepStatus
```
**出力:**
```
StepName Action StepStatus
-------- ------ ----------
LaunchInstance aws:runInstances Success
OSCompatibilityCheck aws:runCommand Success
RunPreUpdateScript aws:runCommand Success
UpdateEC2Config aws:runCommand Cancelled
UpdateSSMAgent aws:runCommand Pending
UpdateAWSPVDriver aws:runCommand Pending
UpdateAWSEnaNetworkDriver aws:runCommand Pending
UpdateAWSNVMe aws:runCommand Pending
InstallWindowsUpdates aws:runCommand Pending
RunPostUpdateScript aws:runCommand Pending
RunSysprepGeneralize aws:runCommand Pending
StopInstance aws:changeInstanceState Pending
CreateImage aws:createImage Pending
TerminateInstance aws:changeInstanceState Pending
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeAutomationStepExecutions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMAvailablePatch`
次のコード例は、`Get-SSMAvailablePatch` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Windows Server 2012 で利用でき、MSRC 重要度が「緊急」のすべてのパッチを取得します。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
$filter1 = @{Key="PRODUCT";Values=@("WindowsServer2012")}
$filter2 = @{Key="MSRC_SEVERITY";Values=@("Critical")}
Get-SSMAvailablePatch -Filter $filter1,$filter2
```
**出力:**
```
Classification : SecurityUpdates
ContentUrl : https://support.microsoft.com/en-us/kb/2727528
Description : A security issue has been identified that could allow an unauthenticated remote attacker to compromise your system and gain control
over it. You can help protect your system by installing this update from Microsoft. After you install this update, you may have to
restart your system.
Id : 1eb507be-2040-4eeb-803d-abc55700b715
KbNumber : KB2727528
Language : All
MsrcNumber : MS12-072
MsrcSeverity : Critical
Product : WindowsServer2012
ProductFamily : Windows
ReleaseDate : 11/13/2012 6:00:00 PM
Title : Security Update for Windows Server 2012 (KB2727528)
Vendor : Microsoft
...
```
**例 2: PowerShell バージョン 2 では、New-Object を使用して各フィルターを作成する必要があります。**
```
$filter1 = New-Object Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter
$filter1.Key = "PRODUCT"
$filter1.Values = "WindowsServer2012"
$filter2 = New-Object Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter
$filter2.Key = "MSRC_SEVERITY"
$filter2.Values = "Critical"
Get-SSMAvailablePatch -Filter $filter1,$filter2
```
**例 3: この例では、過去 20 日間にリリースされた、Windows Server 2019 に一致する製品に適用されるすべてのパッチの更新情報を取得します。**
```
Get-SSMAvailablePatch | Where-Object ReleaseDate -ge (Get-Date).AddDays(-20) | Where-Object Product -eq "WindowsServer2019" | Select-Object ReleaseDate, Product, Title
```
**出力:**
```
ReleaseDate Product Title
----------- ------- -----
4/9/2019 5:00:12 PM WindowsServer2019 2019-04 Security Update for Adobe Flash Player for Windows Server 2019 for x64-based Systems (KB4493478)
4/9/2019 5:00:06 PM WindowsServer2019 2019-04 Cumulative Update for Windows Server 2019 for x64-based Systems (KB4493509)
4/2/2019 5:00:06 PM WindowsServer2019 2019-03 Servicing Stack Update for Windows Server 2019 for x64-based Systems (KB4493510)
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeAvailablePatches](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMCommand`
次のコード例は、`Get-SSMCommand` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、リクエストされたすべてのコマンドを一覧表示します。**
```
Get-SSMCommand
```
**出力:**
```
CommandId : 4b75a163-d39a-4d97-87c9-98ae52c6be35
Comment : Apply association with id at update time: 4cc73e42-d5ae-4879-84f8-57e09c0efcd0
CompletedCount : 1
DocumentName : AWS-RefreshAssociation
ErrorCount : 0
ExpiresAfter : 2/24/2017 3:19:08 AM
InstanceIds : {i-0cb2b964d3e14fd9f}
MaxConcurrency : 50
MaxErrors : 0
NotificationConfig : Amazon.SimpleSystemsManagement.Model.NotificationConfig
OutputS3BucketName :
OutputS3KeyPrefix :
OutputS3Region :
Parameters : {[associationIds, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
RequestedDateTime : 2/24/2017 3:18:08 AM
ServiceRole :
Status : Success
StatusDetails : Success
TargetCount : 1
Targets : {}
```
**例 2: この例では、特定のコマンドのステータスを取得します。**
```
Get-SSMCommand -CommandId "4b75a163-d39a-4d97-87c9-98ae52c6be35"
```
**例 3: この例では、2019-04-01T00:00:00Z より後に呼び出されたすべての SSM コマンドを取得します。 **
```
Get-SSMCommand -Filter @{Key="InvokedAfter";Value="2019-04-01T00:00:00Z"} | Select-Object CommandId, DocumentName, Status, RequestedDateTime | Sort-Object -Property RequestedDateTime -Descending
```
**出力:**
```
CommandId DocumentName Status RequestedDateTime
--------- ------------ ------ -----------------
edb1b23e-456a-7adb-aef8-90e-012ac34f AWS-RunPowerShellScript Cancelled 4/16/2019 5:45:23 AM
1a2dc3fb-4567-890d-a1ad-234b5d6bc7d9 AWS-ConfigureAWSPackage Success 4/6/2019 9:19:42 AM
12c3456c-7e90-4f12-1232-1234f5b67893 KT-Retrieve-Cloud-Type-Win Failed 4/2/2019 4:13:07 AM
fe123b45-240c-4123-a2b3-234bdd567ecf AWS-RunInspecChecks Failed 4/1/2019 2:27:31 PM
1eb23aa4-567d-4123-12a3-4c1c2ab34561 AWS-RunPowerShellScript Success 4/1/2019 1:05:55 PM
1c2f3bb4-ee12-4bc1-1a23-12345eea123e AWS-RunInspecChecks Failed 4/1/2019 11:13:09 AM
```
+ API の詳細については、「AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListCommands](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMCommandInvocation`
次のコード例は、`Get-SSMCommandInvocation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、コマンドのすべての呼び出しを一覧表示します。**
```
Get-SSMCommandInvocation -CommandId "b8eac879-0541-439d-94ec-47a80d554f44" -Detail $true
```
**出力:**
```
CommandId : b8eac879-0541-439d-94ec-47a80d554f44
CommandPlugins : {aws:runShellScript}
Comment : IP config
DocumentName : AWS-RunShellScript
InstanceId : i-0cb2b964d3e14fd9f
InstanceName :
NotificationConfig : Amazon.SimpleSystemsManagement.Model.NotificationConfig
RequestedDateTime : 2/22/2017 8:13:16 PM
ServiceRole :
StandardErrorUrl :
StandardOutputUrl :
Status : Success
StatusDetails : Success
TraceOutput :
```
**例 2: この例では、コマンド ID e1eb2e3c-ed4c-5123-45c1-234f5612345f の呼び出し用の CommandPlugins を一覧表示します。**
```
Get-SSMCommandInvocation -CommandId e1eb2e3c-ed4c-5123-45c1-234f5612345f -Detail:$true | Select-Object -ExpandProperty CommandPlugins
```
**出力:**
```
Name : aws:runPowerShellScript
Output : Completed 17.7 KiB/17.7 KiB (40.1 KiB/s) with 1 file(s) remainingdownload: s3://dd-aess-r-ctmer/KUMO.png to ..\..\programdata\KUMO.png
kumo available
OutputS3BucketName :
OutputS3KeyPrefix :
OutputS3Region : eu-west-1
ResponseCode : 0
ResponseFinishDateTime : 4/3/2019 11:53:23 AM
ResponseStartDateTime : 4/3/2019 11:53:21 AM
StandardErrorUrl :
StandardOutputUrl :
Status : Success
StatusDetails : Success
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListCommandInvocations](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMCommandInvocationDetail`
次のコード例は、`Get-SSMCommandInvocationDetail` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インスタンスで実行されたコマンドの詳細情報を表示します。**
```
Get-SSMCommandInvocationDetail -InstanceId "i-0cb2b964d3e14fd9f" -CommandId "b8eac879-0541-439d-94ec-47a80d554f44"
```
**出力:**
```
CommandId : b8eac879-0541-439d-94ec-47a80d554f44
Comment : IP config
DocumentName : AWS-RunShellScript
ExecutionElapsedTime : PT0.004S
ExecutionEndDateTime : 2017-02-22T20:13:16.651Z
ExecutionStartDateTime : 2017-02-22T20:13:16.651Z
InstanceId : i-0cb2b964d3e14fd9f
PluginName : aws:runShellScript
ResponseCode : 0
StandardErrorContent :
StandardErrorUrl :
StandardOutputContent :
StandardOutputUrl :
Status : Success
StatusDetails : Success
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetCommandInvocation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMComplianceItemList`
次のコード例は、`Get-SSMComplianceItemList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、任意のリソース ID とタイプのコンプライアンス項目リストを一覧表示し、コンプライアンスタイプを「関連付け」でフィルタリングします。**
```
Get-SSMComplianceItemList -ResourceId i-1a2caf345f67d0dc2 -ResourceType ManagedInstance -Filter @{Key="ComplianceType";Values="Association"}
```
**出力:**
```
ComplianceType : Association
Details : {[DocumentName, AWS-GatherSoftwareInventory], [DocumentVersion, 1]}
ExecutionSummary : Amazon.SimpleSystemsManagement.Model.ComplianceExecutionSummary
Id : 123a45a1-c234-1234-1245-67891236db4e
ResourceId : i-1a2caf345f67d0dc2
ResourceType : ManagedInstance
Severity : UNSPECIFIED
Status : COMPLIANT
Title :
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListComplianceItems](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMComplianceSummaryList`
次のコード例は、`Get-SSMComplianceSummaryList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、すべてのコンプライアンスタイプの準拠リソースと非準拠リソースの集計カウントを返します。**
```
Get-SSMComplianceSummaryList
```
**出力:**
```
ComplianceType CompliantSummary NonCompliantSummary
-------------- ---------------- -------------------
FleetTotal Amazon.SimpleSystemsManagement.Model.CompliantSummary Amazon.SimpleSystemsManagement.Model.NonCompliantSummary
Association Amazon.SimpleSystemsManagement.Model.CompliantSummary Amazon.SimpleSystemsManagement.Model.NonCompliantSummary
Custom:InSpec Amazon.SimpleSystemsManagement.Model.CompliantSummary Amazon.SimpleSystemsManagement.Model.NonCompliantSummary
Patch Amazon.SimpleSystemsManagement.Model.CompliantSummary Amazon.SimpleSystemsManagement.Model.NonCompliantSummary
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListComplianceSummaries](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMConnectionStatus`
次のコード例は、`Get-SSMConnectionStatus` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インスタンスが接続され、Session Manager 接続を受信する準備ができているかどうかを判断するため、インスタンスの Session Manager 接続ステータスを取得します。**
```
Get-SSMConnectionStatus -Target i-0a1caf234f12d3dc4
```
**出力:**
```
Status Target
------ ------
Connected i-0a1caf234f12d3dc4
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetConnectionStatus](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMDefaultPatchBaseline`
次のコード例は、`Get-SSMDefaultPatchBaseline` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、デフォルトのパッチベースラインを表示します。**
```
Get-SSMDefaultPatchBaseline
```
**出力:**
```
arn:aws:ssm:us-west-2:123456789012:patchbaseline/pb-04fb4ae6142167966
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetDefaultPatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMDeployablePatchSnapshotForInstance`
次のコード例は、`Get-SSMDeployablePatchSnapshotForInstance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インスタンスで使用されるパッチベースラインの現在のスナップショットを表示します。このコマンドは、インスタンス認証情報を使用してインスタンスから実行する必要があります。この例では、インスタンス認証情報が使用されるようにするため、Credentials パラメータに `Amazon.Runtime.InstanceProfileAWSCredentials` オブジェクトを渡します。**
```
$credentials = [Amazon.Runtime.InstanceProfileAWSCredentials]::new()
Get-SSMDeployablePatchSnapshotForInstance -SnapshotId "4681775b-098f-4435-a956-0ef33373ac11" -InstanceId "i-0cb2b964d3e14fd9f" -Credentials $credentials
```
**出力:**
```
InstanceId SnapshotDownloadUrl
---------- -------------------
i-0cb2b964d3e14fd9f https://patch-baseline-snapshot-us-west-2.s3-us-west-2.amazonaws.com/853d0d3db0f0cafe...1692/4681775b-098f-4435...
```
**例 2: この例は、完全な SnapshotDownloadUrl を取得する方法を示しています。このコマンドは、インスタンス認証情報を使用してインスタンスから実行する必要があります。この例では、インスタンス認証情報が使用されるようにするため PowerShell セッションが `Amazon.Runtime.InstanceProfileAWSCredentials` オブジェクトを使用するように設定しています。**
```
Set-AWSCredential -Credential ([Amazon.Runtime.InstanceProfileAWSCredentials]::new())
(Get-SSMDeployablePatchSnapshotForInstance -SnapshotId "4681775b-098f-4435-a956-0ef33373ac11" -InstanceId "i-0cb2b964d3e14fd9f").SnapshotDownloadUrl
```
**出力:**
```
https://patch-baseline-snapshot-us-west-2.s3-us-west-2.amazonaws.com/853d0d3db0f0cafe...
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetDeployablePatchSnapshotForInstance](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMDocument`
次のコード例は、`Get-SSMDocument` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ドキュメントのコンテンツを返します。**
```
Get-SSMDocument -Name "RunShellScript"
```
**出力:**
```
Content
-------
{...
```
**例 2: この例では、ドキュメントの完全なコンテンツを表示します。**
```
(Get-SSMDocument -Name "RunShellScript").Content
{
"schemaVersion":"2.0",
"description":"Run an updated script",
"parameters":{
"commands":{
"type":"StringList",
"description":"(Required) Specify a shell script or a command to run.",
"minItems":1,
"displayType":"textarea"
}
},
"mainSteps":[
{
"action":"aws:runShellScript",
"name":"runShellScript",
"inputs":{
"commands":"{{ commands }}"
}
},
{
"action":"aws:runPowerShellScript",
"name":"runPowerShellScript",
"inputs":{
"commands":"{{ commands }}"
}
}
]
}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetDocument](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMDocumentDescription`
次のコード例は、`Get-SSMDocumentDescription` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ドキュメントに関する情報を返します。**
```
Get-SSMDocumentDescription -Name "RunShellScript"
```
**出力:**
```
CreatedDate : 2/24/2017 5:25:13 AM
DefaultVersion : 1
Description : Run an updated script
DocumentType : Command
DocumentVersion : 1
Hash : f775e5df4904c6fa46686c4722fae9de1950dace25cd9608ff8d622046b68d9b
HashType : Sha256
LatestVersion : 1
Name : RunShellScript
Owner : 123456789012
Parameters : {commands}
PlatformTypes : {Linux}
SchemaVersion : 2.0
Sha1 :
Status : Active
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeDocument](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMDocumentList`
次のコード例は、`Get-SSMDocumentList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: アカウント内のすべての設定ドキュメントを一覧表示します。**
```
Get-SSMDocumentList
```
**出力:**
```
DocumentType : Command
DocumentVersion : 1
Name : AWS-ApplyPatchBaseline
Owner : Amazon
PlatformTypes : {Windows}
SchemaVersion : 1.2
DocumentType : Command
DocumentVersion : 1
Name : AWS-ConfigureAWSPackage
Owner : Amazon
PlatformTypes : {Windows, Linux}
SchemaVersion : 2.0
DocumentType : Command
DocumentVersion : 1
Name : AWS-ConfigureCloudWatch
Owner : Amazon
PlatformTypes : {Windows}
SchemaVersion : 1.2
...
```
**例 2: この例では、名前が「プラットフォーム」と一致するすべてのオートメーションドキュメントを取得します。**
```
Get-SSMDocumentList -DocumentFilterList @{Key="DocumentType";Value="Automation"} | Where-Object Name -Match "Platform"
```
**出力:**
```
DocumentFormat : JSON
DocumentType : Automation
DocumentVersion : 7
Name : KT-Get-Platform
Owner : 987654123456
PlatformTypes : {Windows, Linux}
SchemaVersion : 0.3
Tags : {}
TargetType :
VersionName :
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListDocuments](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMDocumentPermission`
次のコード例は、`Get-SSMDocumentPermission` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ドキュメントのすべてのバージョンを一覧表示します。**
```
Get-SSMDocumentVersionList -Name "RunShellScript"
```
**出力:**
```
CreatedDate DocumentVersion IsDefaultVersion Name
----------- --------------- ---------------- ----
2/24/2017 5:25:13 AM 1 True RunShellScript
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeDocumentPermission](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-SSMDocumentVersionList`
次のコード例は、`Get-SSMDocumentVersionList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ドキュメントのすべてのバージョンを一覧表示します。**
```
Get-SSMDocumentVersionList -Name "AWS-UpdateSSMAgent"
```
**出力:**
```
CreatedDate : 6/1/2021 5:19:10 PM
DocumentFormat : JSON
DocumentVersion : 1
IsDefaultVersion : True
Name : AWS-UpdateSSMAgent
Status : Active
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListDocumentVersions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMEffectiveInstanceAssociationList`
次のコード例は、`Get-SSMEffectiveInstanceAssociationList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インスタンスの有効な関連付けを記述します。**
```
Get-SSMEffectiveInstanceAssociationList -InstanceId "i-0000293ffd8c57862" -MaxResult 5
```
**出力:**
```
AssociationId Content
------------- -------
d8617c07-2079-4c18-9847-1655fc2698b0 {...
```
**例 2: この例では、インスタンスの有効な関連付けの内容を記述します。**
```
(Get-SSMEffectiveInstanceAssociationList -InstanceId "i-0000293ffd8c57862" -MaxResult 5).Content
```
**出力:**
```
{
"schemaVersion": "1.2",
"description": "Update the Amazon SSM Agent to the latest version or specified version.",
"parameters": {
"version": {
"default": "",
"description": "(Optional) A specific version of the Amazon SSM Agent to install. If not specified, the agen
t will be updated to the latest version.",
"type": "String"
},
"allowDowngrade": {
"default": "false",
"description": "(Optional) Allow the Amazon SSM Agent service to be downgraded to an earlier version. If set
to false, the service can be upgraded to newer versions only (default). If set to true, specify the earlier version.",
"type": "String",
"allowedValues": [
"true",
"false"
]
}
},
"runtimeConfig": {
"aws:updateSsmAgent": {
"properties": [
{
"agentName": "amazon-ssm-agent",
"source": "https://s3.{Region}.amazonaws.com/amazon-ssm-{Region}/ssm-agent-manifest.json",
"allowDowngrade": "{{ allowDowngrade }}",
"targetVersion": "{{ version }}"
}
]
}
}
}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeEffectiveInstanceAssociations](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMEffectivePatchesForPatchBaseline`
次のコード例は、`Get-SSMEffectivePatchesForPatchBaseline` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、すべてのパッチベースラインを一覧表示します。結果の最大表示件数は 1 です。**
```
Get-SSMEffectivePatchesForPatchBaseline -BaselineId "pb-0a2f1059b670ebd31" -MaxResult 1
```
**出力:**
```
Patch PatchStatus
----- -----------
Amazon.SimpleSystemsManagement.Model.Patch Amazon.SimpleSystemsManagement.Model.PatchStatus
```
**例 2: この例では、すべてのパッチベースラインのパッチステータスを表示します。結果の最大表示件数は 1 です。**
```
(Get-SSMEffectivePatchesForPatchBaseline -BaselineId "pb-0a2f1059b670ebd31" -MaxResult 1).PatchStatus
```
**出力:**
```
ApprovalDate DeploymentStatus
------------ ----------------
12/21/2010 6:00:00 PM APPROVED
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeEffectivePatchesForPatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMInstanceAssociationsStatus`
次のコード例は、`Get-SSMInstanceAssociationsStatus` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インスタンスの関連付けの詳細情報を表示します。**
```
Get-SSMInstanceAssociationsStatus -InstanceId "i-0000293ffd8c57862"
```
**出力:**
```
AssociationId : d8617c07-2079-4c18-9847-1655fc2698b0
DetailedStatus : Pending
DocumentVersion : 1
ErrorCode :
ExecutionDate : 2/20/2015 8:31:11 AM
ExecutionSummary : temp_status_change
InstanceId : i-0000293ffd8c57862
Name : AWS-UpdateSSMAgent
OutputUrl :
Status : Pending
```
**例 2: この例では、指定されたインスタンス ID におけるインスタンスの関連付けのステータスを確認し、それらの関連付けの実行ステータスを表示します。**
```
Get-SSMInstanceAssociationsStatus -InstanceId i-012e3cb4df567e8aa | ForEach-Object {Get-SSMAssociationExecution -AssociationId .AssociationId}
```
**出力:**
```
AssociationId : 512a34a5-c678-1234-1234-12345678db9e
AssociationVersion : 2
CreatedTime : 3/2/2019 8:53:29 AM
DetailedStatus :
ExecutionId : 512a34a5-c678-1234-1234-12345678db9e
LastExecutionDate : 1/1/0001 12:00:00 AM
ResourceCountByStatus : {Success=9}
Status : Success
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeInstanceAssociationsStatus](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Get-SSMInstanceInformation`
次のコード例は、`Get-SSMInstanceInformation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、各インスタンスの詳細情報を表示します。**
```
Get-SSMInstanceInformation
```
**出力:**
```
ActivationId :
AgentVersion : 2.0.672.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : ip-172-31-44-222.us-west-2.compute.internal
IamRole :
InstanceId : i-0cb2b964d3e14fd9f
IPAddress : 172.31.44.222
IsLatestVersion : True
LastAssociationExecutionDate : 2/24/2017 3:18:09 AM
LastPingDateTime : 2/24/2017 3:35:03 AM
LastSuccessfulAssociationExecutionDate : 2/24/2017 3:18:09 AM
Name :
PingStatus : ConnectionLost
PlatformName : Amazon Linux AMI
PlatformType : Linux
PlatformVersion : 2016.09
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
```
**例 2: この例では、-Filter パラメータを使用して、 `AgentVersion`が `us-east-1`のリージョン内の AWS Systems Manager インスタンスのみに結果をフィルタリングする方法を示します`2.2.800.0`。有効な -Filter キー値のリストは、InstanceInformation の API リファレンストピック (https://docs.aws.amazon.com/systems-manager/latest/APIReference/API\$1InstanceInformation.html\$1systemsmanager-Type-InstanceInformation-ActivationId) で確認できます。**
```
$Filters = @{
Key="AgentVersion"
Values="2.2.800.0"
}
Get-SSMInstanceInformation -Region us-east-1 -Filter $Filters
```
**出力:**
```
ActivationId :
AgentVersion : 2.2.800.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : EXAMPLE-EXAMPLE.WORKGROUP
IamRole :
InstanceId : i-EXAMPLEb0792d98ce
IPAddress : 10.0.0.01
IsLatestVersion : False
LastAssociationExecutionDate : 8/16/2018 12:02:50 AM
LastPingDateTime : 8/16/2018 7:40:27 PM
LastSuccessfulAssociationExecutionDate : 8/16/2018 12:02:50 AM
Name :
PingStatus : Online
PlatformName : Microsoft Windows Server 2016 Datacenter
PlatformType : Windows
PlatformVersion : 10.0.14393
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
ActivationId :
AgentVersion : 2.2.800.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : EXAMPLE-EXAMPLE.WORKGROUP
IamRole :
InstanceId : i-EXAMPLEac7501d023
IPAddress : 10.0.0.02
IsLatestVersion : False
LastAssociationExecutionDate : 8/16/2018 12:00:20 AM
LastPingDateTime : 8/16/2018 7:40:35 PM
LastSuccessfulAssociationExecutionDate : 8/16/2018 12:00:20 AM
Name :
PingStatus : Online
PlatformName : Microsoft Windows Server 2016 Datacenter
PlatformType : Windows
PlatformVersion : 10.0.14393
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
```
**例 3: この例では、-InstanceInformationFilterList パラメータを使用して、 `Windows`または `us-east-1``PlatformTypes`を持つリージョン内の AWS Systems Manager インスタンスのみに結果をフィルタリングする方法を示します`Linux`。有効な -InstanceInformationFilterList キー値のリストは、InstanceInformationFilter の API リファレンストピック (https://docs.aws.amazon.com/systems-manager/latest/APIReference/API\$1InstanceInformationFilter.html) で確認できます。**
```
$Filters = @{
Key="PlatformTypes"
ValueSet=("Windows","Linux")
}
Get-SSMInstanceInformation -Region us-east-1 -InstanceInformationFilterList $Filters
```
**出力:**
```
ActivationId :
AgentVersion : 2.2.800.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : EXAMPLE-EXAMPLE.WORKGROUP
IamRole :
InstanceId : i-EXAMPLEb0792d98ce
IPAddress : 10.0.0.27
IsLatestVersion : False
LastAssociationExecutionDate : 8/16/2018 12:02:50 AM
LastPingDateTime : 8/16/2018 7:40:27 PM
LastSuccessfulAssociationExecutionDate : 8/16/2018 12:02:50 AM
Name :
PingStatus : Online
PlatformName : Ubuntu Server 18.04 LTS
PlatformType : Linux
PlatformVersion : 18.04
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
ActivationId :
AgentVersion : 2.2.800.0
AssociationOverview : Amazon.SimpleSystemsManagement.Model.InstanceAggregatedAssociationOverview
AssociationStatus : Success
ComputerName : EXAMPLE-EXAMPLE.WORKGROUP
IamRole :
InstanceId : i-EXAMPLEac7501d023
IPAddress : 10.0.0.100
IsLatestVersion : False
LastAssociationExecutionDate : 8/16/2018 12:00:20 AM
LastPingDateTime : 8/16/2018 7:40:35 PM
LastSuccessfulAssociationExecutionDate : 8/16/2018 12:00:20 AM
Name :
PingStatus : Online
PlatformName : Microsoft Windows Server 2016 Datacenter
PlatformType : Windows
PlatformVersion : 10.0.14393
RegistrationDate : 1/1/0001 12:00:00 AM
ResourceType : EC2Instance
```
**例 4: この例では、ssm マネージドインスタンスを一覧表示し、InstanceId、PingStatus、LastPingDateTime、PlatformName を csv ファイルにエクスポートします。**
```
Get-SSMInstanceInformation | Select-Object InstanceId, PingStatus, LastPingDateTime, PlatformName | Export-Csv Instance-details.csv -NoTypeInformation
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeInstanceInformation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMInstancePatch`
次のコード例は、`Get-SSMInstancePatch` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インスタンスのパッチコンプライアンスの詳細を取得します。**
```
Get-SSMInstancePatch -InstanceId "i-08ee91c0b17045407"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeInstancePatches](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMInstancePatchState`
次のコード例は、`Get-SSMInstancePatchState` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インスタンスのパッチの概要状態を取得します。**
```
Get-SSMInstancePatchState -InstanceId "i-08ee91c0b17045407"
```
**例 2: この例では、2 つのインスタンスにおけるパッチの概要状態を取得します。**
```
Get-SSMInstancePatchState -InstanceId "i-08ee91c0b17045407","i-09a618aec652973a9"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeInstancePatchStates](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMInstancePatchStatesForPatchGroup`
次のコード例は、`Get-SSMInstancePatchStatesForPatchGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、パッチグループにおけるインスタンスごとのパッチの概要状態を取得します。**
```
Get-SSMInstancePatchStatesForPatchGroup -PatchGroup "Production"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeInstancePatchStatesForPatchGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMInventory`
次のコード例は、`Get-SSMInventory` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インベントリのカスタムメタデータを取得します。**
```
Get-SSMInventory
```
**出力:**
```
Data Id
---- --
{[AWS:InstanceInformation, Amazon.SimpleSystemsManagement.Model.InventoryResultItem]} i-0cb2b964d3e14fd9f
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetInventory](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMInventoryEntriesList`
次のコード例は、`Get-SSMInventoryEntriesList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インスタンスのすべてのカスタムインベントリエントリを一覧表示します。**
```
Get-SSMInventoryEntriesList -InstanceId "i-0cb2b964d3e14fd9f" -TypeName "Custom:RackInfo"
```
**出力:**
```
CaptureTime : 2016-08-22T10:01:01Z
Entries : {Amazon.Runtime.Internal.Util.AlwaysSendDictionary`2[System.String,System.String]}
InstanceId : i-0cb2b964d3e14fd9f
NextToken :
SchemaVersion : 1.0
TypeName : Custom:RackInfo
```
**例 2: この例では詳細を一覧表示します。**
```
(Get-SSMInventoryEntriesList -InstanceId "i-0cb2b964d3e14fd9f" -TypeName "Custom:RackInfo").Entries
```
**出力:**
```
Key Value
--- -----
RackLocation Bay B/Row C/Rack D/Shelf E
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListInventoryEntries](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMInventoryEntryList`
次のコード例は、`Get-SSMInventoryEntryList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インスタンスの `AWS:Network` タイプのインベントリエントリを取得します。**
```
Get-SSMInventoryEntryList -InstanceId mi-088dcb0ecea37b076 -TypeName AWS:Network | Select-Object -ExpandProperty Entries
```
**出力:**
```
Key Value
--- -----
DHCPServer 172.31.11.2
DNSServer 172.31.0.1
Gateway 172.31.11.2
IPV4 172.31.11.222
IPV6 fe12::3456:7da8:901a:12a3
MacAddress 1A:23:4E:5B:FB:67
Name Amazon Elastic Network Adapter
SubnetMask 255.255.240.0
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[Get-SSMInventoryEntryList](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMInventorySchema`
次のコード例は、`Get-SSMInventorySchema` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、アカウントのインベントリタイプ名のリストを返します。**
```
Get-SSMInventorySchema
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetInventorySchema](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMLatestEC2Image`
次のコード例は、`Get-SSMLatestEC2Image` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、最新の Windows AMI をすべて一覧表示します。**
```
PS Get-SSMLatestEC2Image -Path ami-windows-latest
```
**出力:**
```
Name Value
---- -----
Windows_Server-2008-R2_SP1-English-64Bit-SQL_2012_SP4_Express ami-0e5ddd288daff4fab
Windows_Server-2012-R2_RTM-Chinese_Simplified-64Bit-Base ami-0c5ea64e6bec1cb50
Windows_Server-2012-R2_RTM-Chinese_Traditional-64Bit-Base ami-09775eff0bf8c113d
Windows_Server-2012-R2_RTM-Dutch-64Bit-Base ami-025064b67e28cf5df
...
```
**例 2: この例では、us-west-2 リージョンの特定の Amazon Linux イメージの AMI ID を取得します。**
```
PS Get-SSMLatestEC2Image -Path ami-amazon-linux-latest -ImageName amzn-ami-hvm-x86_64-ebs -Region us-west-2
```
**出力:**
```
ami-09b92cd132204c704
```
**例 3: この例では、指定されたワイルドカード表現に一致する最新の Windows AMI をすべて一覧表示します。**
```
Get-SSMLatestEC2Image -Path ami-windows-latest -ImageName *Windows*2019*English*
```
**出力:**
```
Name Value
---- -----
Windows_Server-2019-English-Full-SQL_2017_Web ami-085e9d27da5b73a42
Windows_Server-2019-English-STIG-Core ami-0bfd85c29148c7f80
Windows_Server-2019-English-Full-SQL_2019_Web ami-02099560d7fb11f20
Windows_Server-2019-English-Full-SQL_2016_SP2_Standard ami-0d7ae2d81c07bd598
...
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[Get-SSMLatestEC2Image](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMMaintenanceWindow`
次のコード例は、`Get-SSMMaintenanceWindow` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、メンテナンスウィンドウの詳細を取得します。**
```
Get-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d"
```
**出力:**
```
AllowUnassociatedTargets : False
CreatedDate : 2/20/2017 6:14:05 PM
Cutoff : 1
Duration : 2
Enabled : True
ModifiedDate : 2/20/2017 6:14:05 PM
Name : TestMaintWin
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMMaintenanceWindowExecution`
次のコード例は、`Get-SSMMaintenanceWindowExecution` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、メンテナンスウィンドウの実行の一部として実行されるタスクに関する情報を一覧表示します。**
```
Get-SSMMaintenanceWindowExecution -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**出力:**
```
EndTime : 2/21/2017 4:00:35 PM
StartTime : 2/21/2017 4:00:34 PM
Status : FAILED
StatusDetails : One or more tasks in the orchestration failed.
TaskIds : {ac0c6ae1-daa3-4a89-832e-d384503b6586}
WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetMaintenanceWindowExecution](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMMaintenanceWindowExecutionList`
次のコード例は、`Get-SSMMaintenanceWindowExecutionList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、メンテナンスウィンドウにおけるすべての実行を一覧表示します。**
```
Get-SSMMaintenanceWindowExecutionList -WindowId "mw-03eb9db42890fb82d"
```
**出力:**
```
EndTime : 2/20/2017 6:30:17 PM
StartTime : 2/20/2017 6:30:16 PM
Status : FAILED
StatusDetails : One or more tasks in the orchestration failed.
WindowExecutionId : 6f3215cf-4101-4fa0-9b7b-9523269599c7
WindowId : mw-03eb9db42890fb82d
```
**例 2: この例では、指定されたメンテナンスウィンドウにおける指定された日付より前のすべての実行を一覧表示します。**
```
$option1 = @{Key="ExecutedBefore";Values=@("2016-11-04T05:00:00Z")}
Get-SSMMaintenanceWindowExecutionList -WindowId "mw-03eb9db42890fb82d" -Filter $option1
```
**例 3: この例では、指定されたメンテナンスウィンドウにおける指定された日付より後のすべての実行を一覧表示します。**
```
$option1 = @{Key="ExecutedAfter";Values=@("2016-11-04T05:00:00Z")}
Get-SSMMaintenanceWindowExecutionList -WindowId "mw-03eb9db42890fb82d" -Filter $option1
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeMaintenanceWindowExecutions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMMaintenanceWindowExecutionTask`
次のコード例は、`Get-SSMMaintenanceWindowExecutionTask` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、メンテナンスウィンドウの実行の一部であったタスクに関する情報を一覧表示します。**
```
Get-SSMMaintenanceWindowExecutionTask -TaskId "ac0c6ae1-daa3-4a89-832e-d384503b6586" -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**出力:**
```
EndTime : 2/21/2017 4:00:35 PM
MaxConcurrency : 1
MaxErrors : 1
Priority : 10
ServiceRole : arn:aws:iam::123456789012:role/MaintenanceWindowsRole
StartTime : 2/21/2017 4:00:34 PM
Status : FAILED
StatusDetails : The maximum error count was exceeded.
TaskArn : AWS-RunShellScript
TaskExecutionId : ac0c6ae1-daa3-4a89-832e-d384503b6586
TaskParameters : {Amazon.Runtime.Internal.Util.AlwaysSendDictionary`2[System.String,Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskPara
meterValueExpression]}
Type : RUN_COMMAND
WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetMaintenanceWindowExecutionTask](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMMaintenanceWindowExecutionTaskInvocationList`
次のコード例は、`Get-SSMMaintenanceWindowExecutionTaskInvocationList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、メンテナンスウィンドウの実行の一部として実行される、タスクの呼び出しを一覧表示します。**
```
Get-SSMMaintenanceWindowExecutionTaskInvocationList -TaskId "ac0c6ae1-daa3-4a89-832e-d384503b6586" -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**出力:**
```
EndTime : 2/21/2017 4:00:34 PM
ExecutionId :
InvocationId : e274b6e1-fe56-4e32-bd2a-8073c6381d8b
OwnerInformation :
Parameters : {"documentName":"AWS-RunShellScript","instanceIds":["i-0000293ffd8c57862"],"parameters":{"commands":["df"]},"maxConcurrency":"1",
"maxErrors":"1"}
StartTime : 2/21/2017 4:00:34 PM
Status : FAILED
StatusDetails : The instance IDs list contains an invalid entry.
TaskExecutionId : ac0c6ae1-daa3-4a89-832e-d384503b6586
WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355
WindowTargetId :
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeMaintenanceWindowExecutionTaskInvocations](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMMaintenanceWindowExecutionTaskList`
次のコード例は、`Get-SSMMaintenanceWindowExecutionTaskList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、メンテナンスウィンドウの実行に関連するタスクを一覧表示します。**
```
Get-SSMMaintenanceWindowExecutionTaskList -WindowExecutionId "518d5565-5969-4cca-8f0e-da3b2a638355"
```
**出力:**
```
EndTime : 2/21/2017 4:00:35 PM
StartTime : 2/21/2017 4:00:34 PM
Status : SUCCESS
TaskArn : AWS-RunShellScript
TaskExecutionId : ac0c6ae1-daa3-4a89-832e-d384503b6586
TaskType : RUN_COMMAND
WindowExecutionId : 518d5565-5969-4cca-8f0e-da3b2a638355
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeMaintenanceWindowExecutionTasks](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMMaintenanceWindowList`
次のコード例は、`Get-SSMMaintenanceWindowList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、アカウントにおけるすべてのメンテナンスウィンドウを一覧表示します。**
```
Get-SSMMaintenanceWindowList
```
**出力:**
```
Cutoff : 1
Duration : 4
Enabled : True
Name : My-First-Maintenance-Window
WindowId : mw-06d59c1a07c022145
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeMaintenanceWindows](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMMaintenanceWindowTarget`
次のコード例は、`Get-SSMMaintenanceWindowTarget` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、メンテナンスウィンドウのすべてのターゲットを一覧表示します。**
```
Get-SSMMaintenanceWindowTarget -WindowId "mw-06cf17cbefcb4bf4f"
```
**出力:**
```
OwnerInformation : Single instance
ResourceType : INSTANCE
Targets : {InstanceIds}
WindowId : mw-06cf17cbefcb4bf4f
WindowTargetId : 350d44e6-28cc-44e2-951f-4b2c985838f6
OwnerInformation : Two instances in a list
ResourceType : INSTANCE
Targets : {InstanceIds}
WindowId : mw-06cf17cbefcb4bf4f
WindowTargetId : e078a987-2866-47be-bedd-d9cf49177d3a
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeMaintenanceWindowTargets](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMMaintenanceWindowTaskList`
次のコード例は、`Get-SSMMaintenanceWindowTaskList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、メンテナンスウィンドウのすべてのタスクを一覧表示します。**
```
Get-SSMMaintenanceWindowTaskList -WindowId "mw-06cf17cbefcb4bf4f"
```
**出力:**
```
LoggingInfo :
MaxConcurrency : 1
MaxErrors : 1
Priority : 10
ServiceRoleArn : arn:aws:iam::123456789012:role/MaintenanceWindowsRole
Targets : {InstanceIds}
TaskArn : AWS-RunShellScript
TaskParameters : {[commands, Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression]}
Type : RUN_COMMAND
WindowId : mw-06cf17cbefcb4bf4f
WindowTaskId : a23e338d-ff30-4398-8aa3-09cd052ebf17
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeMaintenanceWindowTasks](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMParameterHistory`
次のコード例は、`Get-SSMParameterHistory` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、パラメータの値の履歴を一覧表示します。**
```
Get-SSMParameterHistory -Name "Welcome"
```
**出力:**
```
Description :
KeyId :
LastModifiedDate : 3/3/2017 6:55:25 PM
LastModifiedUser : arn:aws:iam::123456789012:user/admin
Name : Welcome
Type : String
Value : helloWorld
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetParameterHistory](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMParameterList`
次のコード例は、`Get-SSMParameterList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、すべてのパラメータを一覧表示します。**
```
Get-SSMParameterList
```
**出力:**
```
Description :
KeyId :
LastModifiedDate : 3/3/2017 6:58:23 PM
LastModifiedUser : arn:aws:iam::123456789012:user/admin
Name : Welcome
Type : String
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeParameters](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMParameterValue`
次のコード例は、`Get-SSMParameterValue` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、パラメータの値を一覧表示します。**
```
Get-SSMParameterValue -Name "Welcome"
```
**出力:**
```
InvalidParameters Parameters
----------------- ----------
{} {Welcome}
```
**例 2: この例では、値の詳細を一覧表示します。**
```
(Get-SSMParameterValue -Name "Welcome").Parameters
```
**出力:**
```
Name Type Value
---- ---- -----
Welcome String Good day, Sunshine!
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetParameters](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMPatchBaseline`
次のコード例は、`Get-SSMPatchBaseline` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、すべてのパッチベースラインを一覧表示します。**
```
Get-SSMPatchBaseline
```
**出力:**
```
BaselineDescription BaselineId BaselineName
------------------- ---------- ------------
Default Patch Baseline Provided by AWS. arn:aws:ssm:us-west-2:123456789012:patchbaseline/pb-04fb4ae6142167966 AWS-DefaultP...
Baseline containing all updates approved for production systems pb-045f10b4f382baeda Production-B...
Baseline containing all updates approved for production systems pb-0a2f1059b670ebd31 Production-B...
```
**例 2: この例では、 が提供するすべてのパッチベースラインを一覧表示します AWS。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
$filter1 = @{Key="OWNER";Values=@("AWS")}
```
**出力:**
```
Get-SSMPatchBaseline -Filter $filter1
```
**例 3: この例では、所有者しているすべてのパッチベースラインを一覧表示します。この例で使用される構文には、PowerShell バージョン 3 以降が必要です。**
```
$filter1 = @{Key="OWNER";Values=@("Self")}
```
**出力:**
```
Get-SSMPatchBaseline -Filter $filter1
```
**例 4: PowerShell バージョン 2 では、New-Object を使用して各タグを作成する必要があります。**
```
$filter1 = New-Object Amazon.SimpleSystemsManagement.Model.PatchOrchestratorFilter
$filter1.Key = "OWNER"
$filter1.Values = "AWS"
Get-SSMPatchBaseline -Filter $filter1
```
**出力:**
```
BaselineDescription BaselineId BaselineName DefaultBaselin
e
------------------- ---------- ------------ --------------
Default Patch Baseline Provided by AWS. arn:aws:ssm:us-west-2:123456789012:patchbaseline/pb-04fb4ae6142167966 AWS-DefaultPatchBaseline True
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribePatchBaselines](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMPatchBaselineDetail`
次のコード例は、`Get-SSMPatchBaselineDetail` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、パッチベースラインの詳細を表示します。**
```
Get-SSMPatchBaselineDetail -BaselineId "pb-03da896ca3b68b639"
```
**出力:**
```
ApprovalRules : Amazon.SimpleSystemsManagement.Model.PatchRuleGroup
ApprovedPatches : {}
BaselineId : pb-03da896ca3b68b639
CreatedDate : 3/3/2017 5:02:19 PM
Description : Baseline containing all updates approved for production systems
GlobalFilters : Amazon.SimpleSystemsManagement.Model.PatchFilterGroup
ModifiedDate : 3/3/2017 5:02:19 PM
Name : Production-Baseline
PatchGroups : {}
RejectedPatches : {}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetPatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMPatchBaselineForPatchGroup`
次のコード例は、`Get-SSMPatchBaselineForPatchGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、パッチグループのパッチベースラインを表示します。**
```
Get-SSMPatchBaselineForPatchGroup -PatchGroup "Production"
```
**出力:**
```
BaselineId PatchGroup
---------- ----------
pb-045f10b4f382baeda Production
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[GetPatchBaselineForPatchGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMPatchGroup`
次のコード例は、`Get-SSMPatchGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、パッチグループの登録を一覧表示します。**
```
Get-SSMPatchGroup
```
**出力:**
```
BaselineIdentity PatchGroup
---------------- ----------
Amazon.SimpleSystemsManagement.Model.PatchBaselineIdentity Production
```
+ API の詳細については、「AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribePatchGroups](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMPatchGroupState`
次のコード例は、`Get-SSMPatchGroupState` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、パッチグループのパッチコンプライアンスの概要を取得します。**
```
Get-SSMPatchGroupState -PatchGroup "Production"
```
**出力:**
```
Instances : 4
InstancesWithFailedPatches : 1
InstancesWithInstalledOtherPatches : 4
InstancesWithInstalledPatches : 3
InstancesWithMissingPatches : 0
InstancesWithNotApplicablePatches : 0
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribePatchGroupState](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMResourceComplianceSummaryList`
次のコード例は、`Get-SSMResourceComplianceSummaryList` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、リソースレベルの概要数を取得します。概要には、「Windows10」に一致する製品の準拠ステータスと非準拠ステータス、および詳細なコンプライアンス項目の重要度数に関する情報が含まれます。MaxResult のデフォルトは、パラメータが指定されていない場合は 100 であり、この値は有効ではないため、MaxResult パラメータが追加され、値は 50 に設定されます。**
```
$FilterValues = @{
"Key"="Product"
"Type"="EQUAL"
"Values"="Windows10"
}
Get-SSMResourceComplianceSummaryList -Filter $FilterValues -MaxResult 50
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListResourceComplianceSummaries](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-SSMResourceTag`
次のコード例は、`Get-SSMResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、メンテナンスウィンドウのタグを一覧表示します。**
```
Get-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow"
```
**出力:**
```
Key Value
--- -----
Stack Production
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ListTagsForResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-SSMActivation`
次のコード例は、`New-SSMActivation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、マネージドインスタンスを作成します。**
```
New-SSMActivation -DefaultInstanceName "MyWebServers" -IamRole "SSMAutomationRole" -RegistrationLimit 10
```
**出力:**
```
ActivationCode ActivationId
-------------- ------------
KWChhOxBTiwDcKE9BlKC 08e51e79-1e36-446c-8e63-9458569c1363
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateActivation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-SSMAssociation`
次のコード例は、`New-SSMAssociation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インスタンス ID を使用して、設定ドキュメントをインスタンスに関連付けます。**
```
New-SSMAssociation -InstanceId "i-0cb2b964d3e14fd9f" -Name "AWS-UpdateSSMAgent"
```
**出力:**
```
Name : AWS-UpdateSSMAgent
InstanceId : i-0000293ffd8c57862
Date : 2/23/2017 6:55:22 PM
Status.Name : Associated
Status.Date : 2/20/2015 8:31:11 AM
Status.Message : Associated with AWS-UpdateSSMAgent
Status.AdditionalInfo :
```
**例 2: この例では、ターゲットを使用して、設定ドキュメントをインスタンスに関連付けます。**
```
$target = @{Key="instanceids";Values=@("i-0cb2b964d3e14fd9f")}
New-SSMAssociation -Name "AWS-UpdateSSMAgent" -Target $target
```
**出力:**
```
Name : AWS-UpdateSSMAgent
InstanceId :
Date : 3/1/2017 6:22:21 PM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
**例 3: この例では、ターゲットとパラメータを使用して、設定ドキュメントをインスタンスに関連付けます。**
```
$target = @{Key="instanceids";Values=@("i-0cb2b964d3e14fd9f")}
$params = @{
"action"="configure"
"mode"="ec2"
"optionalConfigurationSource"="ssm"
"optionalConfigurationLocation"=""
"optionalRestart"="yes"
}
New-SSMAssociation -Name "Configure-CloudWatch" -AssociationName "CWConfiguration" -Target $target -Parameter $params
```
**出力:**
```
Name : Configure-CloudWatch
InstanceId :
Date : 5/17/2018 3:17:44 PM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
**例 4: この例では、`AWS-GatherSoftwareInventory` を使用して、リージョン内におけるすべてのインスタンスとの関連付けを作成します。また、収集するパラメータにカスタムファイルとレジストリの場所を指定します。**
```
$params = [Collections.Generic.Dictionary[String,Collections.Generic.List[String]]]::new()
$params["windowsRegistry"] ='[{"Path":"HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\MachineImage","Recursive":false,"ValueNames":["AMIName"]}]'
$params["files"] = '[{"Path":"C:\Program Files","Pattern":["*.exe"],"Recursive":true}, {"Path":"C:\ProgramData","Pattern":["*.log"],"Recursive":true}]'
New-SSMAssociation -AssociationName new-in-mum -Name AWS-GatherSoftwareInventory -Target @{Key="instanceids";Values="*"} -Parameter $params -region ap-south-1 -ScheduleExpression "rate(720 minutes)"
```
**出力:**
```
Name : AWS-GatherSoftwareInventory
InstanceId :
Date : 6/9/2019 8:57:56 AM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateAssociation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-SSMAssociationFromBatch`
次のコード例は、`New-SSMAssociationFromBatch` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、設定ドキュメントを複数のインスタンスに関連付けます。出力では、成功したオペレーションと失敗したオペレーションのリストが返されます (該当する場合)。**
```
$option1 = @{InstanceId="i-0cb2b964d3e14fd9f";Name=@("AWS-UpdateSSMAgent")}
$option2 = @{InstanceId="i-0000293ffd8c57862";Name=@("AWS-UpdateSSMAgent")}
New-SSMAssociationFromBatch -Entry $option1,$option2
```
**出力:**
```
Failed Successful
------ ----------
{} {Amazon.SimpleSystemsManagement.Model.FailedCreateAssociation, Amazon.SimpleSystemsManagement.Model.FailedCreateAsso...
```
**例 2: この例では、成功したオペレーションの詳細を表示します。**
```
$option1 = @{InstanceId="i-0cb2b964d3e14fd9f";Name=@("AWS-UpdateSSMAgent")}
$option2 = @{InstanceId="i-0000293ffd8c57862";Name=@("AWS-UpdateSSMAgent")}
(New-SSMAssociationFromBatch -Entry $option1,$option2).Successful
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateAssociationBatch](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-SSMDocument`
次のコード例は、`New-SSMDocument` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、アカウントにドキュメントを作成します。ドキュメントは JSON 形式である必要があります。設定ドキュメントの記述については、「SSM API Reference」の「Configuration Document」を参照してください。**
```
New-SSMDocument -Content (Get-Content -Raw "c:\temp\RunShellScript.json") -Name "RunShellScript" -DocumentType "Command"
```
**出力:**
```
CreatedDate : 3/1/2017 1:21:33 AM
DefaultVersion : 1
Description : Run an updated script
DocumentType : Command
DocumentVersion : 1
Hash : 1d5ce820e999ff051eb4841ed887593daf77120fd76cae0d18a53cc42e4e22c1
HashType : Sha256
LatestVersion : 1
Name : RunShellScript
Owner : 809632081692
Parameters : {commands}
PlatformTypes : {Linux}
SchemaVersion : 2.0
Sha1 :
Status : Creating
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateDocument](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-SSMMaintenanceWindow`
次のコード例は、`New-SSMMaintenanceWindow` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、そのウィンドウは、毎週火曜日の午後 4 時に 4 時間実行され (カットオフは 1 時間)、関連付けられていないターゲットを許可する、指定された名前の新しいメンテナンスウィンドウを作成します。**
```
New-SSMMaintenanceWindow -Name "MyMaintenanceWindow" -Duration 4 -Cutoff 1 -AllowUnassociatedTarget $true -Schedule "cron(0 16 ? * TUE *)"
```
**出力:**
```
mw-03eb53e1ea7383998
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-SSMPatchBaseline`
次のコード例は、`New-SSMPatchBaseline` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、本番環境で Windows Server 2019 を実行しているマネージドインスタンスに対して、Microsoft からリリースされてから 7 日後にパッチを承認するパッチベースラインを作成します。**
```
$rule = New-Object Amazon.SimpleSystemsManagement.Model.PatchRule
$rule.ApproveAfterDays = 7
$ruleFilters = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilterGroup
$patchFilter = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilter
$patchFilter.Key="PRODUCT"
$patchFilter.Values="WindowsServer2019"
$severityFilter = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilter
$severityFilter.Key="MSRC_SEVERITY"
$severityFilter.Values.Add("Critical")
$severityFilter.Values.Add("Important")
$severityFilter.Values.Add("Moderate")
$classificationFilter = New-Object Amazon.SimpleSystemsManagement.Model.PatchFilter
$classificationFilter.Key = "CLASSIFICATION"
$classificationFilter.Values.Add( "SecurityUpdates" )
$classificationFilter.Values.Add( "Updates" )
$classificationFilter.Values.Add( "UpdateRollups" )
$classificationFilter.Values.Add( "CriticalUpdates" )
$ruleFilters.PatchFilters.Add($severityFilter)
$ruleFilters.PatchFilters.Add($classificationFilter)
$ruleFilters.PatchFilters.Add($patchFilter)
$rule.PatchFilterGroup = $ruleFilters
New-SSMPatchBaseline -Name "Production-Baseline-Windows2019" -Description "Baseline containing all updates approved for production systems" -ApprovalRules_PatchRule $rule
```
**出力:**
```
pb-0z4z6221c4296b23z
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreatePatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Register-SSMDefaultPatchBaseline`
次のコード例は、`Register-SSMDefaultPatchBaseline` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、パッチベースラインをデフォルトのパッチベースラインとして登録します。**
```
Register-SSMDefaultPatchBaseline -BaselineId "pb-03da896ca3b68b639"
```
**出力:**
```
pb-03da896ca3b68b639
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[RegisterDefaultPatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Register-SSMPatchBaselineForPatchGroup`
次のコード例は、`Register-SSMPatchBaselineForPatchGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、パッチグループのパッチベースラインを登録します。**
```
Register-SSMPatchBaselineForPatchGroup -BaselineId "pb-03da896ca3b68b639" -PatchGroup "Production"
```
**出力:**
```
BaselineId PatchGroup
---------- ----------
pb-03da896ca3b68b639 Production
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[RegisterPatchBaselineForPatchGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Register-SSMTargetWithMaintenanceWindow`
次のコード例は、`Register-SSMTargetWithMaintenanceWindow` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インスタンスをメンテナンスウィンドウに登録します。**
```
$option1 = @{Key="InstanceIds";Values=@("i-0000293ffd8c57862")}
Register-SSMTargetWithMaintenanceWindow -WindowId "mw-06cf17cbefcb4bf4f" -Target $option1 -OwnerInformation "Single instance" -ResourceType "INSTANCE"
```
**出力:**
```
d8e47760-23ed-46a5-9f28-927337725398
```
**例 2: この例では、複数のインスタンスをメンテナンスウィンドウに登録します。**
```
$option1 = @{Key="InstanceIds";Values=@("i-0000293ffd8c57862","i-0cb2b964d3e14fd9f")}
Register-SSMTargetWithMaintenanceWindow -WindowId "mw-06cf17cbefcb4bf4f" -Target $option1 -OwnerInformation "Single instance" -ResourceType "INSTANCE"
```
**出力:**
```
6ab5c208-9fc4-4697-84b7-b02a6cc25f7d
```
**例 3: この例では、EC2 タグを使用して、インスタンスをメンテナンスウィンドウに登録します。**
```
$option1 = @{Key="tag:Environment";Values=@("Production")}
Register-SSMTargetWithMaintenanceWindow -WindowId "mw-06cf17cbefcb4bf4f" -Target $option1 -OwnerInformation "Production Web Servers" -ResourceType "INSTANCE"
```
**出力:**
```
2994977e-aefb-4a71-beac-df620352f184
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[RegisterTargetWithMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Register-SSMTaskWithMaintenanceWindow`
次のコード例は、`Register-SSMTaskWithMaintenanceWindow` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インスタンス ID を使用して、タスクをメンテナンスウィンドウに登録します。出力はタスク ID です。**
```
$parameters = @{}
$parameterValues = New-Object Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression
$parameterValues.Values = @("Install")
$parameters.Add("Operation", $parameterValues)
Register-SSMTaskWithMaintenanceWindow -WindowId "mw-03a342e62c96d31b0" -ServiceRoleArn "arn:aws:iam::123456789012:role/MaintenanceWindowsRole" -MaxConcurrency 1 -MaxError 1 -TaskArn "AWS-RunShellScript" -Target @{ Key="InstanceIds";Values="i-0000293ffd8c57862" } -TaskType "RUN_COMMAND" -Priority 10 -TaskParameter $parameters
```
**出力:**
```
f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
**例 2: この例では、ターゲット ID を使用して、タスクをメンテナンスウィンドウに登録します。出力はタスク ID です。**
```
$parameters = @{}
$parameterValues = New-Object Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression
$parameterValues.Values = @("Install")
$parameters.Add("Operation", $parameterValues)
register-ssmtaskwithmaintenancewindow -WindowId "mw-03a342e62c96d31b0" -ServiceRoleArn "arn:aws:iam::123456789012:role/MaintenanceWindowsRole" -MaxConcurrency 1 -MaxError 1 -TaskArn "AWS-RunShellScript" -Target @{ Key="WindowTargetIds";Values="350d44e6-28cc-44e2-951f-4b2c985838f6" } -TaskType "RUN_COMMAND" -Priority 10 -TaskParameter $parameters
```
**出力:**
```
f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
**例 3: この例では、run コマンドドキュメント `AWS-RunPowerShellScript` のパラメータオブジェクトを作成し、ターゲット ID を使用して任意のメンテナンスウィンドウを持つタスクを作成します。返される出力はタスク ID です。**
```
$parameters = [Collections.Generic.Dictionary[String,Collections.Generic.List[String]]]::new()
$parameters.Add("commands",@("ipconfig","dir env:\computername"))
$parameters.Add("executionTimeout",@(3600))
$props = @{
WindowId = "mw-0123e4cce56ff78ae"
ServiceRoleArn = "arn:aws:iam::123456789012:role/MaintenanceWindowsRole"
MaxConcurrency = 1
MaxError = 1
TaskType = "RUN_COMMAND"
TaskArn = "AWS-RunPowerShellScript"
Target = @{Key="WindowTargetIds";Values="fe1234ea-56d7-890b-12f3-456b789bee0f"}
Priority = 1
RunCommand_Parameter = $parameters
Name = "set-via-cmdlet"
}
Register-SSMTaskWithMaintenanceWindow @props
```
**出力:**
```
f1e2ef34-5678-12e3-456a-12334c5c6cbe
```
**例 4: この例では、 という名前のドキュメントを使用して AWS Systems Manager Automation タスクを登録します`Create-Snapshots`。**
```
$automationParameters = @{}
$automationParameters.Add( "instanceId", @("{{ TARGET_ID }}") )
$automationParameters.Add( "AutomationAssumeRole", @("{arn:aws:iam::111111111111:role/AutomationRole}") )
$automationParameters.Add( "SnapshotTimeout", @("PT20M") )
Register-SSMTaskWithMaintenanceWindow -WindowId mw-123EXAMPLE456`
-ServiceRoleArn "arn:aws:iam::123456789012:role/MW-Role"`
-MaxConcurrency 1 -MaxError 1 -TaskArn "CreateVolumeSnapshots"`
-Target @{ Key="WindowTargetIds";Values="4b5acdf4-946c-4355-bd68-4329a43a5fd1" }`
-TaskType "AUTOMATION"`
-Priority 4`
-Automation_DocumentVersion '$DEFAULT' -Automation_Parameter $automationParameters -Name "Create-Snapshots"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[RegisterTaskWithMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-SSMActivation`
次のコード例は、`Remove-SSMActivation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、アクティベーションを削除します。コマンドが成功した場合、出力はありません。**
```
Remove-SSMActivation -ActivationId "08e51e79-1e36-446c-8e63-9458569c1363"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteActivation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-SSMAssociation`
次のコード例は、`Remove-SSMAssociation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インスタンスとドキュメント間の関連付けを削除します。コマンドが成功した場合、出力はありません。**
```
Remove-SSMAssociation -InstanceId "i-0cb2b964d3e14fd9f" -Name "AWS-UpdateSSMAgent"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteAssociation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-SSMDocument`
次のコード例は、`Remove-SSMDocument` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ドキュメントを削除します。コマンドが成功した場合、出力はありません。**
```
Remove-SSMDocument -Name "RunShellScript"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteDocument](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-SSMMaintenanceWindow`
次のコード例は、`Remove-SSMMaintenanceWindow` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、メンテナンスウィンドウを削除します。**
```
Remove-SSMMaintenanceWindow -WindowId "mw-06d59c1a07c022145"
```
**出力:**
```
mw-06d59c1a07c022145
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-SSMParameter`
次のコード例は、`Remove-SSMParameter` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例ではパラメータを削除します。コマンドが成功した場合、出力はありません。**
```
Remove-SSMParameter -Name "helloWorld"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteParameter](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-SSMPatchBaseline`
次のコード例は、`Remove-SSMPatchBaseline` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、パッチベースラインを削除します。**
```
Remove-SSMPatchBaseline -BaselineId "pb-045f10b4f382baeda"
```
**出力:**
```
pb-045f10b4f382baeda
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeletePatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-SSMResourceTag`
次のコード例は、`Remove-SSMResourceTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、メンテナンスウィンドウからタグを削除します。コマンドが成功した場合、出力はありません。**
```
Remove-SSMResourceTag -ResourceId "mw-03eb9db42890fb82d" -ResourceType "MaintenanceWindow" -TagKey "Production"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[RemoveTagsFromResource](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Send-SSMCommand`
次のコード例は、`Send-SSMCommand` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ターゲットインスタンスで echo コマンドを実行します。**
```
Send-SSMCommand -DocumentName "AWS-RunPowerShellScript" -Parameter @{commands = "echo helloWorld"} -Target @{Key="instanceids";Values=@("i-0cb2b964d3e14fd9f")}
```
**出力:**
```
CommandId : d8d190fc-32c1-4d65-a0df-ff5ff3965524
Comment :
CompletedCount : 0
DocumentName : AWS-RunPowerShellScript
ErrorCount : 0
ExpiresAfter : 3/7/2017 10:48:37 PM
InstanceIds : {}
MaxConcurrency : 50
MaxErrors : 0
NotificationConfig : Amazon.SimpleSystemsManagement.Model.NotificationConfig
OutputS3BucketName :
OutputS3KeyPrefix :
OutputS3Region :
Parameters : {[commands, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
RequestedDateTime : 3/7/2017 9:48:37 PM
ServiceRole :
Status : Pending
StatusDetails : Pending
TargetCount : 0
Targets : {instanceids}
```
**例 2: この例は、ネストされたパラメータを受け入れるコマンドを実行する方法を示しています。**
```
Send-SSMCommand -DocumentName "AWS-RunRemoteScript" -Parameter @{ sourceType="GitHub";sourceInfo='{"owner": "me","repository": "amazon-ssm","path": "Examples/Install-Win32OpenSSH"}'; "commandLine"=".\Install-Win32OpenSSH.ps1"} -InstanceId i-0cb2b964d3e14fd9f
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[SendCommand](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Start-SSMAutomationExecution`
次のコード例は、`Start-SSMAutomationExecution` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、オートメーションロール、AMI ソース ID、および Amazon EC2 インスタンスロールを指定するドキュメントを実行します。**
```
Start-SSMAutomationExecution -DocumentName AWS-UpdateLinuxAmi -Parameter @{'AutomationAssumeRole'='arn:aws:iam::123456789012:role/SSMAutomationRole';'SourceAmiId'='ami-f173cc91';'InstanceIamRole'='EC2InstanceRole'}
```
**出力:**
```
3a532a4f-0382-11e7-9df7-6f11185f6dd1
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[StartAutomationExecution](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Start-SSMSession`
次のコード例は、`Start-SSMSession` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、Session Manager のセッションのターゲットへの接続を開始し、ポート転送を有効にします。注: AWSCredentials を使用して設定していない場合は、Region パラメータを追加する必要があります。**
```
Start-SSMSession -Target 'i-064578e5e7454488f' -DocumentName 'AWS-StartPortForwardingSession' -Parameter @{ localPortNumber = '8080'; portNumber = '80' } -Region 'us-west-1'
```
**出力:**
```
Starting session with SessionId: testUser-xi4glew849asyeryde34u4dfsdfy
Port 8080 opened for sessionId testUser-xi4glew849asyeryde34u4dfsdfy.
Waiting for connections...
```
**例 2: この例では、Session Manager セッションに指定されたインスタンスを使用してインタラクティブセッションを作成します。**
```
Start-SSMSession -Target 'i-1234567890abcdef0' -Region 'us-west-1'
```
**出力:**
```
Starting session with SessionId : testUser-xi4glew849asyeryde34u4dfsdfy
Windows PowerShell
Copyright (C) Microsoft Corporation. All rights reserved.
Install the latest PowerShell for new features and improvements!
PS C:\Windows\system32> whoami
ec2amaz-fnsdrwv\ec2-test-user
PS C:\Windows\system32>
```
**例 3: この例では、セッションに接続せずにセッションを作成し、セッションへの接続に必要な SessionId、StreamUrl、TokenValue のプロパティを返します。**
```
Start-SSMSession -Target 'i-1234567890abcdef0' -Region 'us-west-1' -DisablePluginInvocation
```
**出力:**
```
SessionId : testUser-xi4glew849asyeryde34u4dfsdfy
StreamUrl : {StreamUrl value redacted}
TokenValue : {Token value redacted}
ContentLength : 1207
HttpStatusCode : OK
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[StartSession](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Stop-SSMAutomationExecution`
次のコード例は、`Stop-SSMAutomationExecution` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、オートメーションの実行を停止します。コマンドが成功した場合、出力はありません。**
```
Stop-SSMAutomationExecution -AutomationExecutionId "4105a4fc-f944-11e6-9d32-8fb2db27a909"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[StopAutomationExecution](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Stop-SSMCommand`
次のコード例は、`Stop-SSMCommand` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、コマンドのキャンセルを試みます。オペレーションが成功した場合、出力はありません。**
```
Stop-SSMCommand -CommandId "9ded293e-e792-4440-8e3e-7b8ec5feaa38"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CancelCommand](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Unregister-SSMManagedInstance`
次のコード例は、`Unregister-SSMManagedInstance` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、マネージドインスタンスを登録解除します。コマンドが成功した場合、出力はありません。**
```
Unregister-SSMManagedInstance -InstanceId "mi-08ab247cdf1046573"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeregisterManagedInstance](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Unregister-SSMPatchBaselineForPatchGroup`
次のコード例は、`Unregister-SSMPatchBaselineForPatchGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、パッチグループをパッチベースラインから登録解除します。**
```
Unregister-SSMPatchBaselineForPatchGroup -BaselineId "pb-045f10b4f382baeda" -PatchGroup "Production"
```
**出力:**
```
BaselineId PatchGroup
---------- ----------
pb-045f10b4f382baeda Production
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeregisterPatchBaselineForPatchGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Unregister-SSMTargetFromMaintenanceWindow`
次のコード例は、`Unregister-SSMTargetFromMaintenanceWindow` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、メンテナンスウィンドウからターゲットを削除します。**
```
Unregister-SSMTargetFromMaintenanceWindow -WindowTargetId "6ab5c208-9fc4-4697-84b7-b02a6cc25f7d" -WindowId "mw-06cf17cbefcb4bf4f"
```
**出力:**
```
WindowId WindowTargetId
-------- --------------
mw-06cf17cbefcb4bf4f 6ab5c208-9fc4-4697-84b7-b02a6cc25f7d
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeregisterTargetFromMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Unregister-SSMTaskFromMaintenanceWindow`
次のコード例は、`Unregister-SSMTaskFromMaintenanceWindow` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、メンテナンスウィンドウからタスクを削除します。**
```
Unregister-SSMTaskFromMaintenanceWindow -WindowTaskId "f34a2c47-ddfd-4c85-a88d-72366b69af1b" -WindowId "mw-03a342e62c96d31b0"
```
**出力:**
```
WindowId WindowTaskId
-------- ------------
mw-03a342e62c96d31b0 f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeregisterTaskFromMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-SSMAssociation`
次のコード例は、`Update-SSMAssociation` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、新しいドキュメントバージョンとの関連付けを更新します。**
```
Update-SSMAssociation -AssociationId "93285663-92df-44cb-9f26-2292d4ecc439" -DocumentVersion "1"
```
**出力:**
```
Name : AWS-UpdateSSMAgent
InstanceId :
Date : 3/1/2017 6:22:21 PM
Status.Name :
Status.Date :
Status.Message :
Status.AdditionalInfo :
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateAssociation](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-SSMAssociationStatus`
次のコード例は、`Update-SSMAssociationStatus` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、インスタンスと設定ドキュメント間の関連付けのステータスを更新します。**
```
Update-SSMAssociationStatus -Name "AWS-UpdateSSMAgent" -InstanceId "i-0000293ffd8c57862" -AssociationStatus_Date "2015-02-20T08:31:11Z" -AssociationStatus_Name "Pending" -AssociationStatus_Message "temporary_status_change" -AssociationStatus_AdditionalInfo "Additional-Config-Needed"
```
**出力:**
```
Name : AWS-UpdateSSMAgent
InstanceId : i-0000293ffd8c57862
Date : 2/23/2017 6:55:22 PM
Status.Name : Pending
Status.Date : 2/20/2015 8:31:11 AM
Status.Message : temporary_status_change
Status.AdditionalInfo : Additional-Config-Needed
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateAssociationStatus](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-SSMDocument`
次のコード例は、`Update-SSMDocument` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: これは、指定した JSON ファイルの更新内容を含むドキュメントの新しいバージョンを作成するためのものです。ドキュメントは JSON 形式である必要があります。ドキュメントバージョンは、「Get-SSMDocumentVersionList」コマンドレットで取得できます。**
```
Update-SSMDocument -Name RunShellScript -DocumentVersion "1" -Content (Get-Content -Raw "c:\temp\RunShellScript.json")
```
**出力:**
```
CreatedDate : 3/1/2017 2:59:17 AM
DefaultVersion : 1
Description : Run an updated script
DocumentType : Command
DocumentVersion : 2
Hash : 1d5ce820e999ff051eb4841ed887593daf77120fd76cae0d18a53cc42e4e22c1
HashType : Sha256
LatestVersion : 2
Name : RunShellScript
Owner : 809632081692
Parameters : {commands}
PlatformTypes : {Linux}
SchemaVersion : 2.0
Sha1 :
Status : Updating
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateDocument](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-SSMDocumentDefaultVersion`
次のコード例は、`Update-SSMDocumentDefaultVersion` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: ここではドキュメントのデフォルトバージョンを更新します。利用可能なドキュメントバージョンは、「Get-SSMDocumentVersionList」コマンドレットで取得できます。**
```
Update-SSMDocumentDefaultVersion -Name "RunShellScript" -DocumentVersion "2"
```
**出力:**
```
DefaultVersion Name
-------------- ----
2 RunShellScript
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateDocumentDefaultVersion](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-SSMMaintenanceWindow`
次のコード例は、`Update-SSMMaintenanceWindow` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、メンテナンスウィンドウの名前を更新します。**
```
Update-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" -Name "My-Renamed-MW"
```
**出力:**
```
AllowUnassociatedTargets : False
Cutoff : 1
Duration : 2
Enabled : True
Name : My-Renamed-MW
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
**例 2: この例では、メンテナンスウィンドウを有効にします。**
```
Update-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" -Enabled $true
```
**出力:**
```
AllowUnassociatedTargets : False
Cutoff : 1
Duration : 2
Enabled : True
Name : My-Renamed-MW
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
**例 3: この例では、メンテナンスウィンドウを無効にします。**
```
Update-SSMMaintenanceWindow -WindowId "mw-03eb9db42890fb82d" -Enabled $false
```
**出力:**
```
AllowUnassociatedTargets : False
Cutoff : 1
Duration : 2
Enabled : False
Name : My-Renamed-MW
Schedule : cron(0 */30 * * * ? *)
WindowId : mw-03eb9db42890fb82d
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-SSMManagedInstanceRole`
次のコード例は、`Update-SSMManagedInstanceRole` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、マネージドインスタンスのロールを更新します。コマンドが成功した場合、出力はありません。**
```
Update-SSMManagedInstanceRole -InstanceId "mi-08ab247cdf1046573" -IamRole "AutomationRole"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdateManagedInstanceRole](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Update-SSMPatchBaseline`
次のコード例は、`Update-SSMPatchBaseline` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、2 つのパッチを拒否済み、1 つのパッチを承認済みとして既存のパッチベースラインに追加します。**
```
Update-SSMPatchBaseline -BaselineId "pb-03da896ca3b68b639" -RejectedPatch "KB2032276","MS10-048" -ApprovedPatch "KB2124261"
```
**出力:**
```
ApprovalRules : Amazon.SimpleSystemsManagement.Model.PatchRuleGroup
ApprovedPatches : {KB2124261}
BaselineId : pb-03da896ca3b68b639
CreatedDate : 3/3/2017 5:02:19 PM
Description : Baseline containing all updates approved for production systems
GlobalFilters : Amazon.SimpleSystemsManagement.Model.PatchFilterGroup
ModifiedDate : 3/3/2017 5:22:10 PM
Name : Production-Baseline
RejectedPatches : {KB2032276, MS10-048}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[UpdatePatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Write-SSMComplianceItem`
次のコード例は、`Write-SSMComplianceItem` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、任意のマネージドインスタンスのカスタムコンプライアンス項目を書き込みます。**
```
$item = [Amazon.SimpleSystemsManagement.Model.ComplianceItemEntry]::new()
$item.Id = "07Jun2019-3"
$item.Severity="LOW"
$item.Status="COMPLIANT"
$item.Title="Fin-test-1 - custom"
Write-SSMComplianceItem -ResourceId mi-012dcb3ecea45b678 -ComplianceType Custom:VSSCompliant2 -ResourceType ManagedInstance -Item $item -ExecutionSummary_ExecutionTime "07-Jun-2019"
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutComplianceItems](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `Write-SSMInventory`
次のコード例は、`Write-SSMInventory` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、ラックの場所情報をインスタンスに割り当てます。コマンドが成功した場合、出力はありません。**
```
$data = New-Object "System.Collections.Generic.Dictionary[System.String,System.String]"
$data.Add("RackLocation", "Bay B/Row C/Rack D/Shelf F")
$items = New-Object "System.Collections.Generic.List[System.Collections.Generic.Dictionary[System.String, System.String]]"
$items.Add($data)
$customInventoryItem = New-Object Amazon.SimpleSystemsManagement.Model.InventoryItem
$customInventoryItem.CaptureTime = "2016-08-22T10:01:01Z"
$customInventoryItem.Content = $items
$customInventoryItem.TypeName = "Custom:TestRackInfo2"
$customInventoryItem.SchemaVersion = "1.0"
$inventoryItems = @($customInventoryItem)
Write-SSMInventory -InstanceId "i-0cb2b964d3e14fd9f" -Item $inventoryItems
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutInventory](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Write-SSMParameter`
次のコード例は、`Write-SSMParameter` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例ではパラメータを作成します。コマンドが成功した場合、出力はありません。**
```
Write-SSMParameter -Name "Welcome" -Type "String" -Value "helloWorld"
```
**例 2: この例ではパラメータを変更します。コマンドが成功した場合、出力はありません。**
```
Write-SSMParameter -Name "Welcome" -Type "String" -Value "Good day, Sunshine!" -Overwrite $true
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[PutParameter](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用した Amazon Translate の例
次のコード例は、Amazon Translate で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `ConvertTo-TRNTargetLanguage`
次のコード例は、`ConvertTo-TRNTargetLanguage` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定された英語テキストをフランス語に変換します。変換するテキストは、-Text パラメータとして渡すこともできます。**
```
"Hello World" | ConvertTo-TRNTargetLanguage -SourceLanguageCode en -TargetLanguageCode fr
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[TranslateText](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# AWS WAFV2 Tools for PowerShell V5 を使用した の例
次のコード例は、 で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています AWS WAFV2。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `New-WAF2WebACL`
次のコード例は、`New-WAF2WebACL` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このコマンドは、「waf-test」という名前の新しいウェブ ACL を作成します。サービス API ドキュメントによると、「DefaultAction」は必須プロパティです。したがって、「-DefaultAction\$1Allow」または「-DefaultAction\$1Block」の値を指定する必要があります。「-DefaultAction\$1Allow」と「-DefaultAction\$1Block」は必須プロパティではないため、上記の例に示すように、値「@\$1\$1」をプレースホルダーとして使用できます。**
```
New-WAF2WebACL -Name "waf-test" -Scope REGIONAL -Region eu-west-1 -VisibilityConfig_CloudWatchMetricsEnabled $true -VisibilityConfig_SampledRequestsEnabled $true -VisibilityConfig_MetricName "waf-test" -Description "Test" -DefaultAction_Allow @{}
```
**出力:**
```
ARN : arn:aws:wafv2:eu-west-1:139480602983:regional/webacl/waf-test/19460b3f-db14-4b9a-8e23-a417e1eb007f
Description : Test
Id : 19460b3f-db14-4b9a-8e23-a417e1eb007f
LockToken : 5a0cd5eb-d911-4341-b313-b429e6d6b6ab
Name : waf-test
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateWebAcl](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
# Tools for PowerShell V5 を使用した WorkSpaces の例
次のコード例は、WorkSpaces で AWS Tools for PowerShell V5 を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `Approve-WKSIpRule`
次のコード例は、`Approve-WKSIpRule` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、既存の IP グループにルールを追加します。**
```
$Rule = @(
@{IPRule = "10.1.0.0/0"; RuleDesc = "First Rule Added"},
@{IPRule = "10.2.0.0/0"; RuleDesc = "Second Rule Added"}
)
Approve-WKSIpRule -GroupId wsipg-abcnx2fcw -UserRule $Rule
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[AuthorizeIpRules](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Copy-WKSWorkspaceImage`
次のコード例は、`Copy-WKSWorkspaceImage` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定 ID を持つワークスペースイメージを、us-west-2 から「CopiedImageTest」という名前の現在のリージョンにコピーします。**
```
Copy-WKSWorkspaceImage -Name CopiedImageTest -SourceRegion us-west-2 -SourceImageId wsi-djfoedhw6
```
**出力:**
```
wsi-456abaqfe
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5)」の[CopyWorkspaceImage](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Edit-WKSClientProperty`
次のコード例は、`Edit-WKSClientProperty` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、WorkSpaces クライアントの再接続を有効にします**
```
Edit-WKSClientProperty -Region us-west-2 -ClientProperties_ReconnectEnabled "ENABLED" -ResourceId d-123414a369
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ModifyClientProperties](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Edit-WKSSelfServicePermission`
次のコード例は、`Edit-WKSSelfServicePermission` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、セルフサービスのアクセス許可を有効にして、指定ディレクトリのコンピューティングタイプを変更し、ボリュームサイズを増やせるようにします。**
```
Edit-WKSSelfservicePermission -Region us-west-2 -ResourceId d-123454a369 -SelfservicePermissions_ChangeComputeType ENABLED -SelfservicePermissions_IncreaseVolumeSize ENABLED
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ModifySelfservicePermissions](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Edit-WKSWorkspaceAccessProperty`
次のコード例は、`Edit-WKSWorkspaceAccessProperty` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定ディレクトリの Android と Chrome OS で Workspace アクセスを有効にします。**
```
Edit-WKSWorkspaceAccessProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceAccessProperties_DeviceTypeAndroid ALLOW -WorkspaceAccessProperties_DeviceTypeChromeOs ALLOW
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ModifyWorkspaceAccessProperties](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Edit-WKSWorkspaceCreationProperty`
次のコード例は、`Edit-WKSWorkspaceCreationProperty` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このサンプルでは、Workspace の作成中にインターネットアクセスとメンテナンスモードをデフォルト値として true に設定します。**
```
Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ModifyWorkspaceCreationProperties](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Edit-WKSWorkspaceProperty`
次のコード例は、`Edit-WKSWorkspaceProperty` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このサンプルは、指定された Workspace の Workspace 実行モードプロパティを Auto Stop に変更します。**
```
Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ModifyWorkspaceProperties](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Edit-WKSWorkspaceState`
次のコード例は、`Edit-WKSWorkspaceState` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このサンプルは、指定された Workspace の状態を Available に変更します。**
```
Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[ModifyWorkspaceState](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-WKSClientProperty`
次のコード例は、`Get-WKSClientProperty` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定ディレクトリのワークスペースクライアントのクライアントプロパティを取得します。**
```
Get-WKSClientProperty -ResourceId d-223562a123
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeClientProperties](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-WKSIpGroup`
次のコード例は、`Get-WKSIpGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定リージョン内の指定 IP グループの詳細を取得します。**
```
Get-WKSIpGroup -Region us-east-1 -GroupId wsipg-8m1234v45
```
**出力:**
```
GroupDesc GroupId GroupName UserRules
--------- ------- --------- ---------
wsipg-8m1234v45 TestGroup {Amazon.WorkSpaces.Model.IpRuleItem, Amazon.WorkSpaces.Model.IpRuleItem}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeIpGroups](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-WKSTag`
次のコード例は、`Get-WKSTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このサンプルは、指定された Workspace のタグを取得します。**
```
Get-WKSTag -WorkspaceId ws-w361s234r -Region us-west-2
```
**出力:**
```
Key Value
--- -----
auto-delete no
purpose Workbench
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-WKSWorkspace`
次のコード例は、`Get-WKSWorkspace` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: すべての WorkSpaces の詳細をパイプラインに取得します。**
```
Get-WKSWorkspace
```
**出力:**
```
BundleId : wsb-1a2b3c4d
ComputerName :
DirectoryId : d-1a2b3c4d
ErrorCode :
ErrorMessage :
IpAddress :
RootVolumeEncryptionEnabled : False
State : PENDING
SubnetId :
UserName : myuser
UserVolumeEncryptionEnabled : False
VolumeEncryptionKey :
WorkspaceId : ws-1a2b3c4d
WorkspaceProperties : Amazon.WorkSpaces.Model.WorkspaceProperties
```
**例 2: このコマンドは、`us-west-2` リージョンのワークスペースの `WorkSpaceProperties` の子プロパティの値を表示します。`WorkSpaceProperties` の子プロパティの詳細については、https://docs.aws.amazon.com/workspaces/latest/api/API\$1WorkspaceProperties.html を参照してください。**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties
```
**出力:**
```
ComputeTypeName : STANDARD
RootVolumeSizeGib : 80
RunningMode : AUTO_STOP
RunningModeAutoStopTimeoutInMinutes : 60
UserVolumeSizeGib : 50
```
**例 3: このコマンドは、`us-west-2` リージョン内のワークスペースにおける `WorkSpaceProperties` の子プロパティ `RootVolumeSizeGib` の値を表示します。GiB 単位のルートボリュームサイズは 80 です。**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties.RootVolumeSizeGib
```
**出力:**
```
80
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-WKSWorkspaceBundle`
次のコード例は、`Get-WKSWorkspaceBundle` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このサンプルは、現在のリージョンのすべての Workspace バンドルの詳細を取得します。**
```
Get-WKSWorkspaceBundle
```
**出力:**
```
BundleId : wsb-sfhdgv342
ComputeType : Amazon.WorkSpaces.Model.ComputeType
Description : This bundle is custom
ImageId : wsi-235aeqges
LastUpdatedTime : 12/26/2019 06:44:07
Name : CustomBundleTest
Owner : 233816212345
RootStorage : Amazon.WorkSpaces.Model.RootStorage
UserStorage : Amazon.WorkSpaces.Model.UserStorage
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeWorkspaceBundles](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-WKSWorkspaceDirectory`
次のコード例は、`Get-WKSWorkspaceDirectory` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このサンプルは、登録されたディレクトリの詳細を一覧表示します。**
```
Get-WKSWorkspaceDirectory
```
**出力:**
```
Alias : TestWorkspace
CustomerUserName : Administrator
DirectoryId : d-123414a369
DirectoryName : TestDirectory.com
DirectoryType : MicrosoftAD
DnsIpAddresses : {172.31.43.45, 172.31.2.97}
IamRoleId : arn:aws:iam::761234567801:role/workspaces_RoleDefault
IpGroupIds : {}
RegistrationCode : WSpdx+4RRT43
SelfservicePermissions : Amazon.WorkSpaces.Model.SelfservicePermissions
State : REGISTERED
SubnetIds : {subnet-1m3m7b43, subnet-ard11aba}
Tenancy : SHARED
WorkspaceAccessProperties : Amazon.WorkSpaces.Model.WorkspaceAccessProperties
WorkspaceCreationProperties : Amazon.WorkSpaces.Model.DefaultWorkspaceCreationProperties
WorkspaceSecurityGroupId : sg-0ed2441234a123c43
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeWorkspaceDirectories](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-WKSWorkspaceImage`
次のコード例は、`Get-WKSWorkspaceImage` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、リージョン内のすべてのイメージの詳細をすべて取得します。**
```
Get-WKSWorkspaceImage
```
**出力:**
```
Description :This image is copied from another image
ErrorCode :
ErrorMessage :
ImageId : wsi-345ahdjgo
Name : CopiedImageTest
OperatingSystem : Amazon.WorkSpaces.Model.OperatingSystem
RequiredTenancy : DEFAULT
State : AVAILABLE
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeWorkspaceImages](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-WKSWorkspaceSnapshot`
次のコード例は、`Get-WKSWorkspaceSnapshot` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定ワークスペース用に作成された最新のスナップショットのタイムスタンプを示します。**
```
Get-WKSWorkspaceSnapshot -WorkspaceId ws-w361s100v
```
**出力:**
```
RebuildSnapshots RestoreSnapshots
---------------- ----------------
{Amazon.WorkSpaces.Model.Snapshot} {Amazon.WorkSpaces.Model.Snapshot}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeWorkspaceSnapshots](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Get-WKSWorkspacesConnectionStatus`
次のコード例は、`Get-WKSWorkspacesConnectionStatus` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このサンプルは、指定された Workspace の接続ステータスを取得します。**
```
Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DescribeWorkspacesConnectionStatus](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
### `New-WKSIpGroup`
次のコード例は、`New-WKSIpGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、FreshEmptyIpGroup という名前の空の IP グループを作成します**
```
New-WKSIpGroup -GroupName "FreshNewIPGroup"
```
**出力:**
```
wsipg-w45rty4ty
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateIpGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-WKSTag`
次のコード例は、`New-WKSTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、`ws-wsname` という名前のワークスペースに新しいタグを追加します。タグのキーは「Name」で、キー値は `AWS_Workspace` です。**
```
$tag = New-Object Amazon.WorkSpaces.Model.Tag
$tag.Key = "Name"
$tag.Value = "AWS_Workspace"
New-WKSTag -Region us-west-2 -WorkspaceId ws-wsname -Tag $tag
```
**例 2: この例では、`ws-wsname` という名前のワークスペースに複数のタグを追加します。1 つのタグには「Name」のキーと `AWS_Workspace` のキー値があり、もう 1 つのタグには「Stage」のタグキーと「Test」のキー値があります。**
```
$tag = New-Object Amazon.WorkSpaces.Model.Tag
$tag.Key = "Name"
$tag.Value = "AWS_Workspace"
$tag2 = New-Object Amazon.WorkSpaces.Model.Tag
$tag2.Key = "Stage"
$tag2.Value = "Test"
New-WKSTag -Region us-west-2 -WorkspaceId ws-wsname -Tag $tag,$tag2
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `New-WKSWorkspace`
次のコード例は、`New-WKSWorkspace` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定されたバンドル、ディレクトリ、ユーザーの WorkSpace を作成します。**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME"}
```
**例 2: この例では、複数の WorkSpaces を作成します。**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_1"},@{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_2"}
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[CreateWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Register-WKSIpGroup`
次のコード例は、`Register-WKSIpGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このサンプルは、指定 IP グループを指定ディレクトリに登録します。**
```
Register-WKSIpGroup -GroupId wsipg-23ahsdres -DirectoryId d-123412e123
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[AssociateIpGroups](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Register-WKSWorkspaceDirectory`
次のコード例は、`Register-WKSWorkspaceDirectory` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このサンプルは、Workspaces Service の指定されたディレクトリを登録します。**
```
Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[RegisterWorkspaceDirectory](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-WKSIpGroup`
次のコード例は、`Remove-WKSIpGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: この例では、指定 IP グループを削除します。**
```
Remove-WKSIpGroup -GroupId wsipg-32fhgtred
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-WKSIpGroup (DeleteIpGroup)" on target "wsipg-32fhgtred".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteIpGroup](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-WKSTag`
次のコード例は、`Remove-WKSTag` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このサンプルは、Workspace に関連付けられたタグを削除します。**
```
Remove-WKSTag -ResourceId ws-w10b3abcd -TagKey "Type"
```
**出力:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-WKSTag (DeleteTags)" on target "ws-w10b3abcd".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DeleteTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Remove-WKSWorkspace`
次のコード例は、`Remove-WKSWorkspace` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 複数の WorkSpaces を終了します。-Force スイッチを使用すると、コマンドレットの確認を求めるプロンプトが表示されなくなります。**
```
Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force
```
**例 2: すべての WorkSpaces のコレクションを取得し、Remove-WKSWorkspace の -WorkSpaceId パラメータに ID をパイプして、すべての WorkSpaces を終了します。コマンドレットは、各 WorkSpace が終了する前にプロンプトを表示します。確認を非表示にするには、-Force スイッチを追加します。**
```
Get-WKSWorkspaces | Remove-WKSWorkspace
```
**例 3: この例では、終了する WorkSpaces を定義する TerminateRequest オブジェクトを渡す方法を示します。-Force スイッチが指定されていない限り、コマンドレットは続行する前に確認を求めます。**
```
$arrRequest = @()
$request1 = New-Object Amazon.WorkSpaces.Model.TerminateRequest
$request1.WorkspaceId = 'ws-12345678'
$arrRequest += $request1
$request2 = New-Object Amazon.WorkSpaces.Model.TerminateRequest
$request2.WorkspaceId = 'ws-abcdefgh'
$arrRequest += $request2
Remove-WKSWorkspace -Request $arrRequest
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[TerminateWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Reset-WKSWorkspace`
次のコード例は、`Reset-WKSWorkspace` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定された WorkSpace を再構築します。**
```
Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**例 2: すべての WorkSpaces のコレクションを取得し、Reset-WKSWorkspace の -WorkSpaceId パラメータに ID をパイプして、WorkSpaces を再構築します。**
```
Get-WKSWorkspaces | Reset-WKSWorkspace
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[RebuildWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Restart-WKSWorkspace`
次のコード例は、`Restart-WKSWorkspace` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 指定された WorkSpace を再起動します。**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**例 2: 複数の WorkSpaces を再起動します。**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"
```
**例 3: すべての WorkSpaces のコレクションを取得し、Restart-WKSWorkspace の -WorkSpaceId パラメータに ID をパイプして、WorkSpaces を再起動します。**
```
Get-WKSWorkspaces | Restart-WKSWorkspace
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[RebootWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Stop-WKSWorkspace`
次のコード例は、`Stop-WKSWorkspace` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: 複数の WorkSpaces を停止します。**
```
Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"
```
**例 2: すべての WorkSpaces のコレクションを取得し、Stop-WKSWorkspace の -WorkSpaceId パラメータに ID をパイプして、WorkSpaces を停止します。**
```
Get-WKSWorkspaces | Stop-WKSWorkspace
```
**例 3: この例では、停止する WorkSpaces を定義する StopRequest オブジェクトを渡す方法を示します。**
```
$arrRequest = @()
$request1 = New-Object Amazon.WorkSpaces.Model.StopRequest
$request1.WorkspaceId = 'ws-12345678'
$arrRequest += $request1
$request2 = New-Object Amazon.WorkSpaces.Model.StopRequest
$request2.WorkspaceId = 'ws-abcdefgh'
$arrRequest += $request2
Stop-WKSWorkspace -Request $arrRequest
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[StopWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**
### `Unregister-WKSIpGroup`
次のコード例は、`Unregister-WKSIpGroup` を使用する方法を示しています。
**Tools for PowerShell V5**
**例 1: このサンプルは、指定ディレクトリから指定 IP グループを登録解除します。**
```
Unregister-WKSIpGroup -GroupId wsipg-12abcdphq -DirectoryId d-123454b123
```
+ API の詳細については、AWS Tools for PowerShell コマンドレットリファレンス (V5) の「[DisassociateIpGroups](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。**