/ - Amazon Simple Systems Manager (SSM)

Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "Name": "string", "VersionName": "string", "DocumentVersion": "string", "DocumentFormat": "YAML" }'

{ "Name": "string", "CreatedDate": "string", "DisplayName": "string", "VersionName": "string", "DocumentVersion": "string", "Status": "Creating", "StatusInformation": "string", "Content": "string", "DocumentType": "Command", "DocumentFormat": "YAML", "Requires": [], "AttachmentsContent": [], "ReviewStatus": "APPROVED" }

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Name

string

required

The name of the SSM document.

Match pattern:

^[a-zA-Z0-9_\-.:/]{3,128}$

VersionName

string

optional

An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and can't be changed.

Match pattern:

^[a-zA-Z0-9_\-.]{1,128}$

DocumentVersion

string

optional

The document version for which you want information.

Match pattern:

([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

DocumentFormat

enum<string>

optional

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

Allowed values:

YAMLJSONTEXT

Examples

Responses

🟢200Success

application/json

Body

Name

string

optional

The name of the SSM document.

Match pattern:

^[a-zA-Z0-9_\-.:/]{3,128}$

CreatedDate

string <date-time>

optional

The date the SSM document was created.

DisplayName

string

optional

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.

<= 1024 characters

Match pattern:

^[\w\.\-\:\/ ]*$

VersionName

string

optional

The version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.

Match pattern:

^[a-zA-Z0-9_\-.]{1,128}$

DocumentVersion

string

optional

The document version.

Match pattern:

([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

Status

enum<string>

optional

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

Allowed values:

CreatingActiveUpdatingDeletingFailed

StatusInformation

string

optional

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

Content

string

optional

The contents of the SSM document.

>= 1 characters

DocumentType

enum<string>

optional

The document type.

Allowed values:

CommandPolicyAutomationSessionPackageApplicationConfigurationApplicationConfigurationSchemaDeploymentStrategyChangeCalendarAutomation.ChangeTemplateProblemAnalysisProblemAnalysisTemplateCloudFormationConformancePackTemplateQuickSetup

DocumentFormat

enum<string>

optional

The document format, either JSON or YAML.

Allowed values:

YAMLJSONTEXT

Requires

array[object (DocumentRequires) {4}]

optional

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

>= 1 items

Name

string

required

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

Match pattern:

^[a-zA-Z0-9_\-.:/]{3,128}$

Version

string

optional

The document version required by the current document.

Match pattern:

([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

RequireType

string

optional

The document type of the required SSM document.

<= 128 characters

Match pattern:

^[a-zA-Z0-9_\-.]{1,128}$

VersionName

string

optional

Match pattern:

^[a-zA-Z0-9_\-.]{1,128}$

AttachmentsContent

array[object (AttachmentContent) {5}]

optional

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

Name

string

optional

The name of an attachment.

Match pattern:

^[a-zA-Z0-9_\-.]{3,128}$

Size

integer

optional

The size of an attachment in bytes.

Hash

string

optional

The cryptographic hash value of the document content.

<= 256 characters

HashType

enum<string>

optional

The hash algorithm used to calculate the hash value.

Allowed value:

Sha256

Url

string

optional

The URL location of the attachment content.

ReviewStatus

enum<string>

optional

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.

Allowed values:

APPROVEDNOT_REVIEWEDPENDINGREJECTED

🟠480InternalServerError

🟠481InvalidDocument

🟠482InvalidDocumentVersion