documents_list_only
Lists documents
in a region or regions, for all properties use documents
Overview
Name | documents_list_only |
Type | Resource |
Description | The AWS::SSM::Document resource is an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which can be used to set up and run commands on your instances. |
Id | aws.ssm.documents_list_only |
Fields
Name | Datatype | Description |
---|---|---|
content | object | The content for the Systems Manager document in JSON, YAML or String format. |
attachments | array | A list of key and value pairs that describe attachments to a version of a document. |
name | string | A name for the Systems Manager document. |
version_name | string | An optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed. |
document_type | string | The type of document to create. |
document_format | string | Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format. |
target_type | string | Specify a target type to define the kinds of resources the document can run on. |
tags | array | Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. |
requires | array | A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document. |
update_method | string | Update method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
SELECT
examples
Lists all documents
in a region.
SELECT
region,
name
FROM aws.ssm.documents_list_only
WHERE region = 'us-east-1';
Permissions
For permissions required to operate on the documents_list_only
resource, see documents