Skip to content
AWS for Query.Farm

aws.ssm.list_documents

Example SQL Queries

SELECT * FROM
aws.ssm.list_documents;

Description

Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.

Table Definition

Column NameColumn Data Type
document_filter_list Input Column

This data type is deprecated. Instead, use Filters.

STRUCT(
    "key" VARCHAR,
    "value" VARCHAR
)[]
Show child fields
document_filter_list[]
Show child fields
document_filter_list[].key

The name of the filter.

document_filter_list[].value

The value of the filter.

filters Input Column

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2 

STRUCT(
    "key" VARCHAR,
    "values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].key

The name of the filter key.

filters[].values[]
_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
author

The user in your organization who created the document.

VARCHAR
created_date

The date the SSM document was created.

TIMESTAMP_S
display_name

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

VARCHAR
document_format

The document format, either JSON or YAML.

VARCHAR
document_type

The document type.

VARCHAR
document_version

The document version.

VARCHAR
name

The name of the SSM document.

VARCHAR
owner

The Amazon Web Services user that created the document.

VARCHAR
platform_types

The operating system platform. 

VARCHAR[]
Show child fields
platform_types[]
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 status of a document review.

VARCHAR
schema_version

The schema version.

VARCHAR
tags

The tags, or metadata, that have been applied to the document.

STRUCT(
    "key" VARCHAR,
    "value" VARCHAR
)[]
Show child fields
tags[]
Show child fields
tags[].key

The name of the tag.

tags[].value

The value of the tag.

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. 

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

VARCHAR