CreateDocument - AWS Systems Manager

CreateDocument

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

Request Syntax

{ "Attachments": [ { "Key": "string", "Name": "string", "Values": [ "string" ] } ], "Content": "string", "DocumentFormat": "string", "DocumentType": "string", "Name": "string", "Requires": [ { "Name": "string", "Version": "string" } ], "Tags": [ { "Key": "string", "Value": "string" } ], "TargetType": "string", "VersionName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Attachments

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

Type: Array of AttachmentsSource objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: No

Content

The content for the new SSM document in JSON or YAML format. 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 AWS Systems Manager User Guide.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

DocumentFormat

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

Type: String

Valid Values: YAML | JSON | TEXT

Required: No

DocumentType

The type of document to create.

Type: String

Valid Values: Command | Policy | Automation | Session | Package | ApplicationConfiguration | ApplicationConfigurationSchema | DeploymentStrategy | ChangeCalendar

Required: No

Name

A name for the Systems Manager document.

Important

You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes:

  • aws-

  • amazon

  • amzn

Type: String

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

Required: Yes

Requires

A list of SSM documents required by a document. This parameter is used exclusively by AWS 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 AWS AppConfig in the AWS Systems Manager User Guide.

Type: Array of DocumentRequires objects

Array Members: Minimum number of 1 item.

Required: No

Tags

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. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key name/value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

Note

To add tags to an existing SSM document, use the AddTagsToResource action.

Type: Array of Tag objects

Array Members: Maximum number of 1000 items.

Required: No

TargetType

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 AWS resource and property types reference in the AWS CloudFormation User Guide.

Type: String

Length Constraints: Maximum length of 200.

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

Required: No

VersionName

An optional field specifying the version of the artifact you are creating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

Type: String

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

Required: No

Response Syntax

{ "DocumentDescription": { "AttachmentsInformation": [ { "Name": "string" } ], "CreatedDate": number, "DefaultVersion": "string", "Description": "string", "DocumentFormat": "string", "DocumentType": "string", "DocumentVersion": "string", "Hash": "string", "HashType": "string", "LatestVersion": "string", "Name": "string", "Owner": "string", "Parameters": [ { "DefaultValue": "string", "Description": "string", "Name": "string", "Type": "string" } ], "PlatformTypes": [ "string" ], "Requires": [ { "Name": "string", "Version": "string" } ], "SchemaVersion": "string", "Sha1": "string", "Status": "string", "StatusInformation": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TargetType": "string", "VersionName": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DocumentDescription

Information about the Systems Manager document.

Type: DocumentDescription object

Errors

For information about the errors that are common to all actions, see Common Errors.

DocumentAlreadyExists

The specified document already exists.

HTTP Status Code: 400

DocumentLimitExceeded

You can have at most 500 active Systems Manager documents.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

InvalidDocumentContent

The content for the document is not valid.

HTTP Status Code: 400

InvalidDocumentSchemaVersion

The version of the document schema is not supported.

HTTP Status Code: 400

MaxDocumentSizeExceeded

The size limit of a document is 64 KB.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of CreateDocument.

Sample Request

POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.CreateDocument Content-Type: application/x-amz-json-1.1 User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12 X-Amz-Date: 20200324T145550Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20200324/us-east-2/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 963 { "Content":"---\ndescription: \"Example\"\nschemaVersion: '0.3'\nassumeRole: \"{{ AutomationAssumeRole }}\""--truncated--, "Name":"Example", "DocumentType":"Automation", "DocumentFormat":"YAML" }

Sample Response

{ "DocumentDescription":{ "CreatedDate":1.585061751738E9, "DefaultVersion":"1", "Description":"Custom Automation Example", "DocumentFormat":"YAML", "DocumentType":"Automation", "DocumentVersion":"1", "Hash":"0d3d879b3ca072e03c12638d0255ebd004d2c65bd318f8354fcde820dEXAMPLE", "HashType":"Sha256", "LatestVersion":"1", "Name":"Example", "Owner":"111122223333", "Parameters":[ { "DefaultValue":"", "Description":"(Optional) The ARN of the role that allows Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses your IAM permissions to execute this document.", "Name":"AutomationAssumeRole", "Type":"String" }, { "DefaultValue":"", "Description":"(Required) The Instance Id to create an image of.", "Name":"InstanceId", "Type":"String" } ], "PlatformTypes":[ "Windows", "Linux" ], "SchemaVersion":"0.3", "Status":"Creating", "Tags":[ ] } }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: