CLI で DescribeDocument を使用する - AWS Systems Manager

CLI で DescribeDocument を使用する

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

CLI
AWS CLI

ドキュメントの詳細情報を表示するには

次のdescribe-document の例では、AWS アカウントの Systems Manager ドキュメントに関する詳細情報を表示します。

aws ssm describe-document \
    --name "Example"

出力:

{
    "Document": {
        "Hash": "fc2410281f40779e694a8b95975d0f9f316da8a153daa94e3d9921102EXAMPLE",
        "HashType": "Sha256",
        "Name": "Example",
        "Owner": "29884EXAMPLE",
        "CreatedDate": 1583257938.266,
        "Status": "Active",
        "DocumentVersion": "1",
        "Description": "Document Example",
        "Parameters": [
            {
                "Name": "AutomationAssumeRole",
                "Type": "String",
                "Description": "(Required) The ARN of the role that allows Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses your IAM permissions to execute this document.",
                "DefaultValue": ""
            },
            {
                "Name": "InstanceId",
                "Type": "String",
                "Description": "(Required) The ID of the Amazon EC2 instance.",
                "DefaultValue": ""
            }
        ],
        "PlatformTypes": [
            "Windows",
            "Linux"
        ],
        "DocumentType": "Automation",
        "SchemaVersion": "0.3",
        "LatestVersion": "1",
        "DefaultVersion": "1",
        "DocumentFormat": "YAML",
        "Tags": []
    }
}

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

  • API の詳細については、「AWS CLI Command Reference」の「DescribeDocument」を参照してください。

PowerShell
Tools for PowerShell

例 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 Cmdlet リファレンス」の「DescribeDocument」を参照してください。

AWS SDK デベロッパーガイドとコード例の完全なリストについては、「AWS SDK で Systems Manager を使用する」を参照してください。このトピックには、使用開始方法に関する情報と、以前の SDK バージョンの詳細も含まれています。