CmdID / aws / aws ssm

aws ssm describe-document

Describes the specified Amazon Web Services Systems Manager document (SSM document). AWS CLI reference

1 example 3 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To display details of a document

The following describe-document example displays details about a Systems Manager document in your AWS account.

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

--nameThe name of the SSM document.

Its output, shortened

{
    "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",
… 6 more lines

For more information, see Creating Systems Manager Documents in the AWS Systems Manager User Guide.

Options

3 in the AWS CLI reference

--document-versionThe document version for which you want information.

--nameThe name of the SSM document.

--version-nameAn optional field specifying the version of the artifact associated with the document.