Skip to content
AWS for Query.Farm

aws.ssm.describe_document

Example SQL Queries

SELECT * FROM
aws.ssm.describe_document
WHERE
"name" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
name Required Input Column

The name of the SSM document.

VARCHAR
document_version Input Column

The document version for which you want information. Can be a specific version or the default version.

VARCHAR
version_name Input Column

An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
document

Information about the SSM document.

STRUCT(
    "sha1" VARCHAR,
    "hash" VARCHAR,
    "hash_type" VARCHAR,
    "name" VARCHAR,
    "display_name" VARCHAR,
    "version_name" VARCHAR,
    "owner" VARCHAR,
    "created_date" TIMESTAMP_S,
    "status" VARCHAR,
    "status_information" VARCHAR,
    "document_version" VARCHAR,
    "description" VARCHAR,
    "parameters" STRUCT(
        "name" VARCHAR,
        "type" VARCHAR,
        "description" VARCHAR,
        "default_value" VARCHAR
    )[],
    "platform_types" VARCHAR[],
    "document_type" VARCHAR,
    "schema_version" VARCHAR,
    "latest_version" VARCHAR,
    "default_version" VARCHAR,
    "document_format" VARCHAR,
    "target_type" VARCHAR,
    "tags" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[],
    "attachments_information" STRUCT(
        "name" VARCHAR
    )[],
    "requires" STRUCT(
        "name" VARCHAR,
        "version" VARCHAR,
        "require_type" VARCHAR,
        "version_name" VARCHAR
    )[],
    "author" VARCHAR,
    "review_information" STRUCT(
        "reviewed_time" TIMESTAMP_S,
        "status" VARCHAR,
        "reviewer" VARCHAR
    )[],
    "approved_version" VARCHAR,
    "pending_review_version" VARCHAR,
    "review_status" VARCHAR,
    "category" VARCHAR[],
    "category_enum" VARCHAR[]
)
Show child fields
document.approved_version

The version of the document currently approved for use in the organization.

document.attachments_information[]
Show child fields
document.attachments_information[].name

The name of the attachment.

document.author

The user in your organization who created the document.

document.category[]
document.category_enum[]
document.created_date

The date when the document was created.

document.default_version

The default version.

document.description

A description of the document.

document.display_name

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

document.document_format

The document format, either JSON or YAML.

document.document_type

The type of document.

document.document_version

The document version.

document.hash

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

document.hash_type

The hash type of the document. Valid values include Sha256 or Sha1.

Sha1 hashes have been deprecated.

document.latest_version

The latest version of the document.

document.name

The name of the SSM document.

document.owner

The Amazon Web Services user that created the document.

document.parameters[]
Show child fields
document.parameters[].default_value

If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.

document.parameters[].description

A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.

document.parameters[].name

The name of the parameter.

document.parameters[].type

The type of parameter. The type can be either String or StringList.

document.pending_review_version

The version of the document that is currently under review.

document.platform_types[]
document.requires[]
Show child fields
document.requires[].name

The name of the required SSM document. The name can be an Amazon Resource Name (ARN).

document.requires[].require_type

The document type of the required SSM document.

document.requires[].version

The document version required by the current document.

document.requires[].version_name

An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

document.review_information[]
Show child fields
document.review_information[].reviewed_time

The time that the reviewer took action on the document review request.

document.review_information[].reviewer

The reviewer assigned to take action on the document review request.

document.review_information[].status

The current status of the document review request.

document.review_status

The current status of the review.

document.schema_version

The schema version.

document.sha1

The SHA1 hash of the document, which you can use for verification.

document.status

The status of the SSM document.

document.status_information

A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

document.tags[]
Show child fields
document.tags[].key

The name of the tag.

document.tags[].value

The value of the tag.

document.target_type

The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

document.version_name

The version of the artifact associated with the document.