/ - Amazon Simple Systems Manager (SSM)

Describes 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", "DocumentVersion": "string", "VersionName": "string" }'

{ "Document": { "Sha1": "string", "Hash": "string", "HashType": "Sha256", "Name": "string", "DisplayName": "string", "VersionName": "string", "Owner": "string", "CreatedDate": "string", "Status": "Creating", "StatusInformation": "string", "DocumentVersion": "string", "Description": "string", "Parameters": [], "PlatformTypes": [], "DocumentType": "Command", "SchemaVersion": "string", "LatestVersion": "string", "DefaultVersion": "string", "DocumentFormat": "YAML", "TargetType": "string", "Tags": [], "AttachmentsInformation": [], "Requires": [], "Author": "string", "ReviewInformation": [], "ApprovedVersion": "string", "PendingReviewVersion": "string", "ReviewStatus": "APPROVED", "Category": [], "CategoryEnum": [] } }

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}$

DocumentVersion

string

optional

The document version for which you want information. Can be a specific version or the default version.

Match pattern:

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

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}$

Examples

Responses

🟢200Success

application/json

Body

Document

object

optional

Information about the SSM document.

Sha1

string

optional

The SHA1 hash of the document, which you can use for verification.

Hash

string

optional

The Sha256 or Sha1 hash created by the system when the document was created.

<= 256 characters

HashType

enum<string>

optional

The hash type of the document. Valid values include Sha256 or Sha1.

Allowed values:

Sha256Sha1

Name

string

optional

The name of the SSM document.

Match pattern:

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

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.

Match pattern:

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

Owner

string

optional

The Amazon Web Services user that created the document.

CreatedDate

string <date-time>

optional

The date when the document was created.

Status

enum<string>

optional

The status of the SSM document.

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

DocumentVersion

string

optional

The document version.

Match pattern:

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

Description

string

optional

A description of the document.

Parameters

array[object (DocumentParameter) {4}]

optional

A description of the parameters for a document.

PlatformTypes

array[string]

optional

The list of operating system (OS) platforms compatible with this SSM document.

Allowed values:

WindowsLinuxMacOS

DocumentType

enum<string>

optional

The type of document.

Allowed values:

CommandPolicyAutomationSessionPackageApplicationConfigurationApplicationConfigurationSchemaDeploymentStrategyChangeCalendarAutomation.ChangeTemplateProblemAnalysisProblemAnalysisTemplateCloudFormationConformancePackTemplateQuickSetup

SchemaVersion

string

optional

The schema version.

Match pattern:

([0-9]+)\.([0-9]+)

LatestVersion

string

optional

The latest version of the document.

Match pattern:

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

DefaultVersion

string

optional

The default version.

Match pattern:

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

DocumentFormat

enum<string>

optional

The document format, either JSON or YAML.

Allowed values:

YAMLJSONTEXT

TargetType

string

optional

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.

<= 200 characters

Match pattern:

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