SSM / Client / create_document

create_document#

SSM.Client.create_document(**kwargs)#

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 Syntax

response = client.create_document(
    Content='string',
    Requires=[
        {
            'Name': 'string',
            'Version': 'string',
            'RequireType': 'string',
            'VersionName': 'string'
        },
    ],
    Attachments=[
        {
            'Key': 'SourceUrl'|'S3FileUrl'|'AttachmentReference',
            'Values': [
                'string',
            ],
            'Name': 'string'
        },
    ],
    Name='string',
    DisplayName='string',
    VersionName='string',
    DocumentType='Command'|'Policy'|'Automation'|'Session'|'Package'|'ApplicationConfiguration'|'ApplicationConfigurationSchema'|'DeploymentStrategy'|'ChangeCalendar'|'Automation.ChangeTemplate'|'ProblemAnalysis'|'ProblemAnalysisTemplate'|'CloudFormation'|'ConformancePackTemplate'|'QuickSetup',
    DocumentFormat='YAML'|'JSON'|'TEXT',
    TargetType='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

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.
Requires (list) –
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.
- (dict) –
  
  An SSM document required by the current document.
  - Name (string) – [REQUIRED]
    
    The name of the required SSM document. The name can be an Amazon Resource Name (ARN).
  - Version (string) –
    
    The document version required by the current document.
  - RequireType (string) –
    
    The document type of the required SSM document.
  - VersionName (string) –
    
    An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can’t be changed.
Attachments (list) –
A list of key-value pairs that describe attachments to a version of a document.
- (dict) –
  
  Identifying information about a document attachment, including the file name and a key-value pair that identifies the location of an attachment to a document.
  - Key (string) –
    
    The key of a key-value pair that identifies the location of an attachment to a document.
  - Values (list) –
    
    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" ]
    - (string) –
  - Name (string) –
    
    The name of the document attachment file.
Name (string) –
[REQUIRED]

A name for the SSM document.
Warning
You can’t use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:
- aws
- amazon
- amzn
- AWSEC2
- AWSConfigRemediation
- AWSSupport
DisplayName (string) – 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.
VersionName (string) – 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.
DocumentType (string) –
The type of document to create.

Note
The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.
DocumentFormat (string) – Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
TargetType (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 Amazon Web Services resource and property types reference in the CloudFormation User Guide.
Tags (list) –
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-value pairs:
- Key=OS,Value=Windows
- Key=Environment,Value=Production
Note
To add tags to an existing SSM document, use the AddTagsToResource operation.
- (dict) –
  
  Metadata that you assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Amazon Web Services Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata.
  - Key (string) – [REQUIRED]
    
    The name of the tag.
  - Value (string) – [REQUIRED]
    
    The value of the tag.

Return type:

dict

Returns:

Response Syntax

{
    'DocumentDescription': {
        'Sha1': 'string',
        'Hash': 'string',
        'HashType': 'Sha256'|'Sha1',
        'Name': 'string',
        'DisplayName': 'string',
        'VersionName': 'string',
        'Owner': 'string',
        'CreatedDate': datetime(2015, 1, 1),
        'Status': 'Creating'|'Active'|'Updating'|'Deleting'|'Failed',
        'StatusInformation': 'string',
        'DocumentVersion': 'string',
        'Description': 'string',
        'Parameters': [
            {
                'Name': 'string',
                'Type': 'String'|'StringList',
                'Description': 'string',
                'DefaultValue': 'string'
            },
        ],
        'PlatformTypes': [
            'Windows'|'Linux'|'MacOS',
        ],
        'DocumentType': 'Command'|'Policy'|'Automation'|'Session'|'Package'|'ApplicationConfiguration'|'ApplicationConfigurationSchema'|'DeploymentStrategy'|'ChangeCalendar'|'Automation.ChangeTemplate'|'ProblemAnalysis'|'ProblemAnalysisTemplate'|'CloudFormation'|'ConformancePackTemplate'|'QuickSetup',
        'SchemaVersion': 'string',
        'LatestVersion': 'string',
        'DefaultVersion': 'string',
        'DocumentFormat': 'YAML'|'JSON'|'TEXT',
        'TargetType': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'AttachmentsInformation': [
            {
                'Name': 'string'
            },
        ],
        'Requires': [
            {
                'Name': 'string',
                'Version': 'string',
                'RequireType': 'string',
                'VersionName': 'string'
            },
        ],
        'Author': 'string',
        'ReviewInformation': [
            {
                'ReviewedTime': datetime(2015, 1, 1),
                'Status': 'APPROVED'|'NOT_REVIEWED'|'PENDING'|'REJECTED',
                'Reviewer': 'string'
            },
        ],
        'ApprovedVersion': 'string',
        'PendingReviewVersion': 'string',
        'ReviewStatus': 'APPROVED'|'NOT_REVIEWED'|'PENDING'|'REJECTED',
        'Category': [
            'string',
        ],
        'CategoryEnum': [
            'string',
        ]
    }
}

Response Structure

(dict) –
- DocumentDescription (dict) –
  
  Information about the SSM 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 SSM document.
  - DisplayName (string) –
    
    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.
  - VersionName (string) –
    
    The version of the artifact associated with the document.
  - Owner (string) –
    
    The Amazon Web Services user that created the document.
  - CreatedDate (datetime) –
    
    The date when the document was created.
  - Status (string) –
    
    The status of the SSM document.
  - StatusInformation (string) –
    
    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) –
    
    The document version.
  - Description (string) –
    
    A description of the document.
  - Parameters (list) –
    
    A description of the parameters for a document.
    - (dict) –
      
      Parameters specified in a Systems Manager document that run 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 operating system (OS) platforms compatible with this SSM 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 Amazon Web Services resource and property types reference in the CloudFormation User Guide.
  - Tags (list) –
    
    The tags, or metadata, that have been applied to the document.
    - (dict) –
      
      Metadata that you assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Amazon Web Services Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata.
      - 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, and so on.
    - (dict) –
      
      An attribute of an attachment, such as the attachment name.
      - Name (string) –
        
        The name of the attachment.
  - Requires (list) –
    
    A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
    - (dict) –
      
      An SSM document required by the current document.
      - Name (string) –
        
        The name of the required SSM document. The name can be an Amazon Resource Name (ARN).
      - Version (string) –
        
        The document version required by the current document.
      - RequireType (string) –
        
        The document type of the required SSM document.
      - VersionName (string) –
        
        An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can’t be changed.
  - Author (string) –
    
    The user in your organization who created the document.
  - ReviewInformation (list) –
    
    Details about the review of a document.
    - (dict) –
      
      Information about the result of a document review request.
      - ReviewedTime (datetime) –
        
        The time that the reviewer took action on the document review request.
      - Status (string) –
        
        The current status of the document review request.
      - Reviewer (string) –
        
        The reviewer assigned to take action on the document review request.
  - ApprovedVersion (string) –
    
    The version of the document currently approved for use in the organization.
  - PendingReviewVersion (string) –
    
    The version of the document that is currently under review.
  - ReviewStatus (string) –
    
    The current status of the review.
  - Category (list) –
    
    The classification of a document to help you identify and categorize its use.
    - (string) –
  - CategoryEnum (list) –
    
    The value that identifies a document’s category.
    - (string) –

Exceptions

SSM.Client.exceptions.DocumentAlreadyExists
SSM.Client.exceptions.MaxDocumentSizeExceeded
SSM.Client.exceptions.InternalServerError
SSM.Client.exceptions.InvalidDocumentContent
SSM.Client.exceptions.DocumentLimitExceeded
SSM.Client.exceptions.InvalidDocumentSchemaVersion