AWS System Manager

List documents

このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

Return all Systems Manager (SSM) documents in the current Amazon Web Services account and region. Use a filter to limit the results.

Inputs

Expand All

フィールド

種類

説明

region [required]

enum

default: us-east-1

filters

[object]

One or more filters to return a more specific list of results.

Key

string

The name of the filter key.

Values

[string]

The value for the filter key.

Outputs

Expand All

フィールド

種類

説明

documentIdentifiers

[object]

The names of the SSM documents.

Name

string

The name of the SSM document.

CreatedDate

date-time

The date the SSM document was created.

DisplayName

string

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.

Owner

string

The Amazon Web Services user that created the document.

VersionName

string

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.

PlatformTypes

[string]

The operating system platform.

DocumentVersion

string

The document version.

DocumentType

string

The document type.

SchemaVersion

string

The schema version.

DocumentFormat

string

The document format, either JSON or YAML.

TargetType

string

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.

Tags

[object]

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

Key [required]

string

The name of the tag.

Value [required]

string

The value of the tag.

Requires

[object]

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

Name [required]

string

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

Version

string

The document version required by the current document.

RequireType

string

The document type of the required SSM document.

VersionName

string

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.

ReviewStatus

string

The current status of a document review.

Author

string

The user in your organization who created the document.

amzRequestId [required]

string