AWS SDK またはコマンドラインツールListDocumentsで を使用する - AWS SDK コード例

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

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

AWS SDK またはコマンドラインツールListDocumentsで を使用する

以下のコード例は、ListDocuments の使用方法を示しています。

CLI
AWS CLI

例 1: ドキュメントを一覧表示するには

次のlist-documents例では、カスタムタグでタグ付けされたリクエスト元のアカウントが所有するドキュメントを一覧表示します。

aws ssm list-documents \ --filters Key=Owner,Values=Self Key=tag:DocUse,Values=Testing

出力:

{ "DocumentIdentifiers": [ { "Name": "Example", "Owner": "29884EXAMPLE", "PlatformTypes": [ "Windows", "Linux" ], "DocumentVersion": "1", "DocumentType": "Automation", "SchemaVersion": "0.3", "DocumentFormat": "YAML", "Tags": [ { "Key": "DocUse", "Value": "Testing" } ] } ] }

詳細については、AWS 「Systems Manager ユーザーガイド」のAWS 「Systems Manager ドキュメント」を参照してください。

例 2: 共有 ドキュメントを一覧表示するには

次のlist-documents例では、 が所有していないプライベート共有ドキュメントを含む共有ドキュメントを一覧表示します AWS。

aws ssm list-documents \ --filters Key=Name,Values=sharedDocNamePrefix Key=Owner,Values=Private

出力:

{ "DocumentIdentifiers": [ { "Name": "Example", "Owner": "12345EXAMPLE", "PlatformTypes": [ "Windows", "Linux" ], "DocumentVersion": "1", "DocumentType": "Command", "SchemaVersion": "0.3", "DocumentFormat": "YAML", "Tags": [] } ] }

詳細については、AWS 「Systems Manager ユーザーガイド」のAWS 「Systems Manager ドキュメント」を参照してください。

  • API の詳細については、「 コマンドリファレンスListDocuments」の「」を参照してください。 AWS CLI

PowerShell
のツール PowerShell

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