AWS API Changes

2019/11/14 - Amazon Simple Systems Manager (SSM) - 2 updated api methods

Changes Updates support for adding attachments to Systems Manager Automation documents

CreateDocument (updated)

Link ¶
Changes (request)

{'Attachments': {'Key': ['S3FileUrl'], 'Name': 'string'}}

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

Request Syntax

client.create_document(
    Content='string',
    Attachments=[
        {
            'Key': 'SourceUrl'|'S3FileUrl',
            'Values': [
                'string',
            ],
            'Name': 'string'
        },
    ],
    Name='string',
    VersionName='string',
    DocumentType='Command'|'Policy'|'Automation'|'Session'|'Package',
    DocumentFormat='YAML'|'JSON',
    TargetType='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Content

string

param Content

[REQUIRED]

A valid JSON or YAML string.

type Attachments

list

param Attachments

A list of key and 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 is the URL of the location of a document attachment, such as the URL of an Amazon S3 bucket.
  - (string) --
- Name (string) --
  
  The name of the document attachment file.

type Name

string

param Name

[REQUIRED]

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

type VersionName

string

param 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 DocumentType

string

param DocumentType

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

type DocumentFormat

string

param DocumentFormat

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

type TargetType

string

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

type Tags

list

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

(dict) --

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) -- [REQUIRED]
  
  The name of the tag.
- Value (string) -- [REQUIRED]
  
  The value of the tag.

rtype

dict

returns

Response Syntax

{
    'DocumentDescription': {
        'Sha1': 'string',
        'Hash': 'string',
        'HashType': 'Sha256'|'Sha1',
        'Name': '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',
        ],
        'DocumentType': 'Command'|'Policy'|'Automation'|'Session'|'Package',
        'SchemaVersion': 'string',
        'LatestVersion': 'string',
        'DefaultVersion': 'string',
        'DocumentFormat': 'YAML'|'JSON',
        'TargetType': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'AttachmentsInformation': [
            {
                'Name': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- DocumentDescription (dict) --
  
  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 (datetime) --
    
    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.
    - (dict) --
      
      Parameters specified in a System 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 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.
    - (dict) --
      
      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.
    - (dict) --
      
      An attribute of an attachment, such as the attachment name.
      - Name (string) --
        
        The name of the attachment.

UpdateDocument (updated)

Link ¶
Changes (request)

{'Attachments': {'Key': ['S3FileUrl'], 'Name': 'string'}}

Updates one or more values for an SSM document.

See also: AWS API Documentation

Request Syntax

client.update_document(
    Content='string',
    Attachments=[
        {
            'Key': 'SourceUrl'|'S3FileUrl',
            'Values': [
                'string',
            ],
            'Name': 'string'
        },
    ],
    Name='string',
    VersionName='string',
    DocumentVersion='string',
    DocumentFormat='YAML'|'JSON',
    TargetType='string'
)

type Content

string

param Content

[REQUIRED]

A valid JSON or YAML string.

type Attachments

list

param Attachments

A list of key and 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 is the URL of the location of a document attachment, such as the URL of an Amazon S3 bucket.
  - (string) --
- Name (string) --
  
  The name of the document attachment file.

type Name

string

param Name

[REQUIRED]

The name of the document that you want to update.

type VersionName

string

param VersionName

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

type DocumentVersion

string

param DocumentVersion

(Required) The version of the document that you want to update.

type DocumentFormat

string

param DocumentFormat

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

type TargetType

string

param TargetType

Specify a new target type for the document.

rtype

dict

returns

Response Syntax

{
    'DocumentDescription': {
        'Sha1': 'string',
        'Hash': 'string',
        'HashType': 'Sha256'|'Sha1',
        'Name': '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',
        ],
        'DocumentType': 'Command'|'Policy'|'Automation'|'Session'|'Package',
        'SchemaVersion': 'string',
        'LatestVersion': 'string',
        'DefaultVersion': 'string',
        'DocumentFormat': 'YAML'|'JSON',
        'TargetType': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'AttachmentsInformation': [
            {
                'Name': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- DocumentDescription (dict) --
  
  A description of the document that was updated.
  - 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 (datetime) --
    
    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.
    - (dict) --
      
      Parameters specified in a System 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 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.
    - (dict) --
      
      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.
    - (dict) --
      
      An attribute of an attachment, such as the attachment name.
      - Name (string) --
        
        The name of the attachment.