Skip to main content

document_tags

Expands all tag keys and values for documents in a region

Overview

Namedocument_tags
TypeResource
DescriptionThe 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.
Idaws.ssm.document_tags

Fields

NameDatatypeDescription
contentobjectThe content for the Systems Manager document in JSON, YAML or String format.
attachmentsarrayA list of key and value pairs that describe attachments to a version of a document.
namestringA name for the Systems Manager document.
version_namestringAn 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_typestringThe type of document to create.
document_formatstringSpecify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.
target_typestringSpecify a target type to define the kinds of resources the document can run on.
requiresarrayA list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
update_methodstringUpdate method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.
tag_keystringTag key.
tag_valuestringTag value.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Expands tags for all documents in a region.

SELECT
region,
content,
attachments,
name,
version_name,
document_type,
document_format,
target_type,
requires,
update_method,
tag_key,
tag_value
FROM aws.ssm.document_tags
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the document_tags resource, see documents