Skip to content
AWS for Query.Farm

aws.ssm.get_document

Example SQL Queries

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

Description

Gets the contents of 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_format Input Column

The document format, either JSON or YAML.

VARCHAR
document_version Input Column

The document version.

VARCHAR
version_name Input Column

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
attachments_content

A description of the document attachments, including names, locations, sizes, and so on.

STRUCT(
    "name" VARCHAR,
    "size" BIGINT,
    "hash" VARCHAR,
    "hash_type" VARCHAR,
    "url" VARCHAR
)[]
Show child fields
attachments_content[]
Show child fields
attachments_content[].hash

The cryptographic hash value of the document content.

attachments_content[].hash_type

The hash algorithm used to calculate the hash value.

attachments_content[].name

The name of an attachment.

attachments_content[].size

The size of an attachment in bytes.

attachments_content[].url

The URL location of the attachment content.

content

The contents of the SSM document.

VARCHAR
created_date

The date the SSM document was created.

TIMESTAMP_S
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.

VARCHAR
document_type

The document type.

VARCHAR
requires

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

STRUCT(
    "name" VARCHAR,
    "version" VARCHAR,
    "require_type" VARCHAR,
    "version_name" VARCHAR
)[]
Show child fields
requires[]
Show child fields
requires[].name

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

requires[].require_type

The document type of the required SSM document.

requires[].version

The document version required by the current 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.

review_status

The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.

Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

Only one version of an SSM document can be in review, or PENDING, at a time.

VARCHAR
status

The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting.

VARCHAR
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."

VARCHAR