/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Content": "string",
    "Requires": [],
    "Attachments": [],
    "Name": "string",
    "DisplayName": "string",
    "VersionName": "string",
    "DocumentType": "Command",
    "DocumentFormat": "YAML",
    "TargetType": "string",
    "Tags": []
}'

Response Example

200 - Example 1

{
    "DocumentDescription": {
        "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

Content

string

required

The content for the new SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content specified for input parameters at runtime. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

For examples, see the following topics in the Amazon Web Services Systems Manager User Guide.

>= 1 characters

Requires

array[object (DocumentRequires) {4}]

optional

A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AppConfig? in the AppConfig User Guide.

>= 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

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

Attachments

array[object (AttachmentsSource) {3}]

optional

A list of key-value pairs that describe attachments to a version of a document.

>= 0 items<= 20 items

Key

enum<string>

optional

The key of a key-value pair that identifies the location of an attachment to a document.

Allowed values:

SourceUrlS3FileUrlAttachmentReference

Values

array[string]

optional

The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify.

For the key SourceUrl, the value is an S3 bucket location. For example:

"Values": [ "s3://doc-example-bucket/my-folder" ]
For the key S3FileUrl, the value is a file in an S3 bucket. For example:

"Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]
For the key AttachmentReference, the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:

"Values": [ "MyOtherDocument/3/my-other-file.py" ]

However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:

"Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]

>= 1 items<= 1 items

Name

string

optional

The name of the document attachment file.

Match pattern:

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

Name

string

required

A name for the SSM document.

Match pattern:

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

DisplayName

string

optional

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.

<= 1024 characters

Match pattern:

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

VersionName

string

optional

An optional field specifying the version of the artifact you are creating with the document. For example, Release12.1. This value is unique across all versions of a document, and can't be changed.

Match pattern:

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

DocumentType

enum<string>

optional

The type of document to create.

Allowed values:

CommandPolicyAutomationSessionPackageApplicationConfigurationApplicationConfigurationSchemaDeploymentStrategyChangeCalendarAutomation.ChangeTemplateProblemAnalysisProblemAnalysisTemplateCloudFormationConformancePackTemplateQuickSetup

DocumentFormat

enum<string>

optional

Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.

Allowed values:

YAMLJSONTEXT

TargetType

string

optional

Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. 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\.\-\:\/]*$

Responses

🟢200Success

application/json

Body

DocumentDescription

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:

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\.\-\:\/]*$