Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ssm ]

create-document

Description

Creates a Systems Manager document.

After you create a document, you can use CreateAssociation to associate it with one or more running instances.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-document
--content <value>
[--attachments <value>]
--name <value>
[--version-name <value>]
[--document-type <value>]
[--document-format <value>]
[--target-type <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--content (string)

A valid JSON or YAML string.

--attachments (list)

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

Shorthand Syntax:

Key=string,Values=string,string ...

JSON Syntax:

[
  {
    "Key": "SourceUrl",
    "Values": ["string", ...]
  }
  ...
]

--name (string)

A name for the Systems Manager document.

Warning

Do not use the following to begin the names of documents you create. They are reserved by AWS for use as document prefixes:

  • aws
  • amazon
  • amzn

--version-name (string)

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.

--document-type (string)

The type of document to create. Valid document types include: Command , Policy , Automation , Session , and Package .

Possible values:

  • Command
  • Policy
  • Automation
  • Session
  • Package

--document-format (string)

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

Possible values:

  • YAML
  • JSON

--target-type (string)

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 Types Reference in the AWS CloudFormation User Guide .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To create a document

This example creates a document in your account. The document must be in JSON format. Note that file:// must be referenced followed by the path of the content file. For more information about writing a configuration document, see Configuration Document in the SSM API Reference.

Command:

aws ssm create-document --content "file://RunShellScript.json" --name "RunShellScript" --document-type "Command"

Output:

{
  "DocumentDescription": {
      "Status": "Creating",
      "Hash": "95cf32aa8c4c4e6f0eb81c4d0cc9a81aa5d209c2c67c703bdea7a233b5596eb
      "Name": "RunShellScript",
      "Parameters": [
          {
              "Type": "StringList",
              "Name": "commands",
              "Description": "(Required) Specify a shell script or a command to run."
          }
      ],
      "DocumentType": "Command",
      "PlatformTypes": [
          "Linux"
      ],
      "DocumentVersion": "1",
      "HashType": "Sha256",
      "CreatedDate": 1487871523.324,
      "Owner": "809632081692",
      "SchemaVersion": "2.0",
      "DefaultVersion": "1",
      "LatestVersion": "1",
      "Description": "Run a script"
  }
}

Output

DocumentDescription -> (structure)

Information about the Systems Manager document.

Sha1 -> (string)

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

Hash -> (string)

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

Note

Sha1 hashes have been deprecated.

HashType -> (string)

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

Note

Sha1 hashes have been deprecated.

Name -> (string)

The name of the Systems Manager document.

VersionName -> (string)

The version of the artifact associated with the document.

Owner -> (string)

The AWS user account that created the document.

CreatedDate -> (timestamp)

The date when the document was created.

Status -> (string)

The status of the Systems Manager document.

StatusInformation -> (string)

A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."

DocumentVersion -> (string)

The document version.

Description -> (string)

A description of the document.

Parameters -> (list)

A description of the parameters for a document.

(structure)

Parameters specified in a System Manager document that execute on the server when the command is run.

Name -> (string)

The name of the parameter.

Type -> (string)

The type of parameter. The type can be either String or StringList.

Description -> (string)

A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.

DefaultValue -> (string)

If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.

PlatformTypes -> (list)

The list of OS platforms compatible with this Systems Manager document.

(string)

DocumentType -> (string)

The type of document.

SchemaVersion -> (string)

The schema version.

LatestVersion -> (string)

The latest version of the document.

DefaultVersion -> (string)

The default version.

DocumentFormat -> (string)

The document format, either JSON or YAML.

TargetType -> (string)

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 AWS Resource Types Reference in the AWS CloudFormation User Guide .

Tags -> (list)

The tags, or metadata, that have been applied to the document.

(structure)

Metadata that you assign to your AWS resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Systems Manager, you can apply tags to documents, managed instances, Maintenance Windows, Parameter Store parameters, and patch baselines.

Key -> (string)

The name of the tag.

Value -> (string)

The value of the tag.

AttachmentsInformation -> (list)

Details about the document attachments, including names, locations, sizes, etc.

(structure)

An attribute of an attachment, such as the attachment name or size.

Name -> (string)