将 DescribeDocument 与 CLI 配合使用 - AWS SDK 代码示例

AWS 文档 SDK 示例 GitHub 存储库中还有更多 AWS SDK 示例。

将 DescribeDocument 与 CLI 配合使用

以下代码示例演示如何使用 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 用户指南》中的创建 Systems Manager 文档。

  • 有关 API 详细信息，请参阅《AWS CLI Command Reference》中的 DescribeDocument。

PowerShell
Tools for PowerShell V4

示例 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 Reference（V4）》中的 DescribeDocument。

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 Cmdlet Reference (V5)》中的 DescribeDocument。