AWS API Changes

2020/12/04 - Amazon Simple Systems Manager (SSM) - 5 new8 updated api methods

Changes Update ssm client to latest version

CreateOpsMetadata (new)

Link ¶

If you create a new application in AppManager, Systems Manager calls this API action to specify information about the new application, including the application type.

See also: AWS API Documentation

Request Syntax

client.create_ops_metadata(
    ResourceId='string',
    Metadata={
        'string': {
            'Value': 'string'
        }
    }
)

type ResourceId:

string

param ResourceId:

[REQUIRED]

A resource ID for a new AppManager application.

type Metadata:

dict

param Metadata:

Metadata for a new AppManager application.

(string) --
- (dict) --
  
  Metadata to assign to an AppManager application.
  - Value (string) --
    
    Metadata value to assign to an AppManager application.

rtype:

dict

returns:

Response Syntax

{
    'OpsMetadataArn': 'string'
}

Response Structure

(dict) --
- OpsMetadataArn (string) --
  
  The Amazon Resource Name (ARN) of the OpsMetadata Object or blob created by the call.

ListOpsMetadata (new)

Link ¶

Systems Manager calls this API action when displaying all AppManager OpsMetadata objects or blobs.

See also: AWS API Documentation

Request Syntax

client.list_ops_metadata(
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

type Filters:

list

param Filters:

One or more filters to limit the number of OpsMetadata objects returned by the call.

(dict) --

A filter to limit the number of OpsMetadata objects displayed.
- Key (string) -- [REQUIRED]
  
  A filter key.
- Values (list) -- [REQUIRED]
  
  A filter value.
  - (string) --

type MaxResults:

integer

param MaxResults:

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

type NextToken:

string

param NextToken:

A token to start the list. Use this token to get the next set of results.

rtype:

dict

returns:

Response Syntax

{
    'OpsMetadataList': [
        {
            'ResourceId': 'string',
            'OpsMetadataArn': 'string',
            'LastModifiedDate': datetime(2015, 1, 1),
            'LastModifiedUser': 'string',
            'CreationDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- OpsMetadataList (list) --
  
  Returns a list of OpsMetadata objects.
  - (dict) --
    
    Operational metadata for an application in AppManager.
    - ResourceId (string) --
      
      The ID of the AppManager application.
    - OpsMetadataArn (string) --
      
      The Amazon Resource Name (ARN) of the OpsMetadata Object or blob.
    - LastModifiedDate (datetime) --
      
      The date the OpsMetadata object was last updated.
    - LastModifiedUser (string) --
      
      The user name who last updated the OpsMetadata object.
    - CreationDate (datetime) --
      
      The date the OpsMetadata objects was created.
- NextToken (string) --
  
  The token for the next set of items to return. Use this token to get the next set of results.

GetOpsMetadata (new)

Link ¶

View operational metadata related to an application in AppManager.

See also: AWS API Documentation

Request Syntax

client.get_ops_metadata(
    OpsMetadataArn='string',
    MaxResults=123,
    NextToken='string'
)

type OpsMetadataArn:

string

param OpsMetadataArn:

[REQUIRED]

The Amazon Resource Name (ARN) of an OpsMetadata Object to view.

type MaxResults:

integer

param MaxResults:

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

type NextToken:

string

param NextToken:

A token to start the list. Use this token to get the next set of results.

rtype:

dict

returns:

Response Syntax

{
    'ResourceId': 'string',
    'Metadata': {
        'string': {
            'Value': 'string'
        }
    },
    'NextToken': 'string'
}

Response Structure

(dict) --
- ResourceId (string) --
  
  The resource ID of the AppManager application.
- Metadata (dict) --
  
  OpsMetadata for an AppManager application.
  - (string) --
    - (dict) --
      
      Metadata to assign to an AppManager application.
      - Value (string) --
        
        Metadata value to assign to an AppManager application.
- NextToken (string) --
  
  The token for the next set of items to return. Use this token to get the next set of results.

UpdateOpsMetadata (new)

Link ¶

Systems Manager calls this API action when you edit OpsMetadata in AppManager.

See also: AWS API Documentation

Request Syntax

client.update_ops_metadata(
    OpsMetadataArn='string',
    MetadataToUpdate={
        'string': {
            'Value': 'string'
        }
    },
    KeysToDelete=[
        'string',
    ]
)

type OpsMetadataArn:

string

param OpsMetadataArn:

[REQUIRED]

The Amazon Resoure Name (ARN) of the OpsMetadata Object to update.

type MetadataToUpdate:

dict

param MetadataToUpdate:

Metadata to add to an OpsMetadata object.

(string) --
- (dict) --
  
  Metadata to assign to an AppManager application.
  - Value (string) --
    
    Metadata value to assign to an AppManager application.

type KeysToDelete:

list

param KeysToDelete:

The metadata keys to delete from the OpsMetadata object.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'OpsMetadataArn': 'string'
}

Response Structure

(dict) --
- OpsMetadataArn (string) --
  
  The Amazon Resource Name (ARN) of the OpsMetadata Object that was updated.

DeleteOpsMetadata (new)

Link ¶

Delete OpsMetadata related to an application.

See also: AWS API Documentation

Request Syntax

client.delete_ops_metadata(
    OpsMetadataArn='string'
)

type OpsMetadataArn:

string

param OpsMetadataArn:

[REQUIRED]

The Amazon Resource Name (ARN) of an OpsMetadata Object to delete.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

CreatePatchBaseline (updated)

Link ¶
Changes (request)

{'OperatingSystem': {'MACOS'}}

Creates a patch baseline.

See also: AWS API Documentation

Request Syntax

client.create_patch_baseline(
    OperatingSystem='WINDOWS'|'AMAZON_LINUX'|'AMAZON_LINUX_2'|'UBUNTU'|'REDHAT_ENTERPRISE_LINUX'|'SUSE'|'CENTOS'|'ORACLE_LINUX'|'DEBIAN'|'MACOS',
    Name='string',
    GlobalFilters={
        'PatchFilters': [
            {
                'Key': 'ARCH'|'ADVISORY_ID'|'BUGZILLA_ID'|'PATCH_SET'|'PRODUCT'|'PRODUCT_FAMILY'|'CLASSIFICATION'|'CVE_ID'|'EPOCH'|'MSRC_SEVERITY'|'NAME'|'PATCH_ID'|'SECTION'|'PRIORITY'|'REPOSITORY'|'RELEASE'|'SEVERITY'|'SECURITY'|'VERSION',
                'Values': [
                    'string',
                ]
            },
        ]
    },
    ApprovalRules={
        'PatchRules': [
            {
                'PatchFilterGroup': {
                    'PatchFilters': [
                        {
                            'Key': 'ARCH'|'ADVISORY_ID'|'BUGZILLA_ID'|'PATCH_SET'|'PRODUCT'|'PRODUCT_FAMILY'|'CLASSIFICATION'|'CVE_ID'|'EPOCH'|'MSRC_SEVERITY'|'NAME'|'PATCH_ID'|'SECTION'|'PRIORITY'|'REPOSITORY'|'RELEASE'|'SEVERITY'|'SECURITY'|'VERSION',
                            'Values': [
                                'string',
                            ]
                        },
                    ]
                },
                'ComplianceLevel': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'INFORMATIONAL'|'UNSPECIFIED',
                'ApproveAfterDays': 123,
                'ApproveUntilDate': 'string',
                'EnableNonSecurity': True|False
            },
        ]
    },
    ApprovedPatches=[
        'string',
    ],
    ApprovedPatchesComplianceLevel='CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'INFORMATIONAL'|'UNSPECIFIED',
    ApprovedPatchesEnableNonSecurity=True|False,
    RejectedPatches=[
        'string',
    ],
    RejectedPatchesAction='ALLOW_AS_DEPENDENCY'|'BLOCK',
    Description='string',
    Sources=[
        {
            'Name': 'string',
            'Products': [
                'string',
            ],
            'Configuration': 'string'
        },
    ],
    ClientToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type OperatingSystem:

string

param OperatingSystem:

Defines the operating system the patch baseline applies to. The Default value is WINDOWS.

type Name:

string

param Name:

[REQUIRED]

The name of the patch baseline.

type GlobalFilters:

dict

param GlobalFilters:

A set of global filters used to include patches in the baseline.

PatchFilters (list) -- [REQUIRED]

The set of patch filters that make up the group.
- (dict) --
  
  Defines which patches should be included in a patch baseline.
  
  A patch filter consists of a key and a set of values. The filter key is a patch property. For example, the available filter keys for WINDOWS are PATCH_SET, PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, and MSRC_SEVERITY. The filter values define a matching criterion for the patch property indicated by the key. For example, if the filter key is PRODUCT and the filter values are ["Office 2013", "Office 2016"], then the filter accepts all patches where product name is either "Office 2013" or "Office 2016". The filter values can be exact values for the patch property given as a key, or a wildcard (*), which matches all values.
  
  You can view lists of valid values for the patch properties by running the DescribePatchProperties command. For information about which patch properties can be used with each major operating system, see DescribePatchProperties.
  - Key (string) -- [REQUIRED]
    
    The key for the filter.
    
    Run the DescribePatchProperties command to view lists of valid keys for each operating system type.
  - Values (list) -- [REQUIRED]
    
    The value for the filter key.
    
    Run the DescribePatchProperties command to view lists of valid values for each key based on operating system type.
    - (string) --

type ApprovalRules:

dict

param ApprovalRules:

A set of rules used to include patches in the baseline.

PatchRules (list) -- [REQUIRED]

The rules that make up the rule group.
- (dict) --
  
  Defines an approval rule for a patch baseline.
  - PatchFilterGroup (dict) -- [REQUIRED]
    
    The patch filter group that defines the criteria for the rule.
    - PatchFilters (list) -- [REQUIRED]
      
      The set of patch filters that make up the group.
      - (dict) --
        
        Defines which patches should be included in a patch baseline.
        
        A patch filter consists of a key and a set of values. The filter key is a patch property. For example, the available filter keys for WINDOWS are PATCH_SET, PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, and MSRC_SEVERITY. The filter values define a matching criterion for the patch property indicated by the key. For example, if the filter key is PRODUCT and the filter values are ["Office 2013", "Office 2016"], then the filter accepts all patches where product name is either "Office 2013" or "Office 2016". The filter values can be exact values for the patch property given as a key, or a wildcard (*), which matches all values.
        
        You can view lists of valid values for the patch properties by running the DescribePatchProperties command. For information about which patch properties can be used with each major operating system, see DescribePatchProperties.
        
        Key (string) -- [REQUIRED]
        
        The key for the filter.
        
        Run the DescribePatchProperties command to view lists of valid keys for each operating system type.
        
        Values (list) -- [REQUIRED]
        
        The value for the filter key.
        
        Run the DescribePatchProperties command to view lists of valid values for each key based on operating system type.
        
        (string) --
  - ComplianceLevel (string) --
    
    A compliance severity level for all approved patches in a patch baseline.
  - ApproveAfterDays (integer) --
    
    The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of 7 means that patches are approved seven days after they are released. Not supported on Ubuntu Server.
  - ApproveUntilDate (string) --
    
    The cutoff date for auto approval of released patches. Any patches released on or before this date are installed automatically. Not supported on Ubuntu Server.
    
    Enter dates in the format YYYY-MM-DD. For example, 2020-12-31.
  - EnableNonSecurity (boolean) --
    
    For instances identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is 'false'. Applies to Linux instances only.

type ApprovedPatches:

list

param ApprovedPatches:

A list of explicitly approved patches for the baseline.

For information about accepted formats for lists of approved patches and rejected patches, see About package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide.

(string) --

type ApprovedPatchesComplianceLevel:

string

param ApprovedPatchesComplianceLevel:

Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED.

type ApprovedPatchesEnableNonSecurity:

boolean

param ApprovedPatchesEnableNonSecurity:

Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.

type RejectedPatches:

list

param RejectedPatches:

A list of explicitly rejected patches for the baseline.

(string) --

type RejectedPatchesAction:

string

param RejectedPatchesAction:

The action for Patch Manager to take on patches included in the RejectedPackages list.

ALLOW_AS_DEPENDENCY: A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified.
BLOCK: Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.

type Description:

string

param Description:

A description of the patch baseline.

type Sources:

list

param Sources:

Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.

(dict) --

Information about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only.
- Name (string) -- [REQUIRED]
  
  The name specified to identify the patch source.
- Products (list) -- [REQUIRED]
  
  The specific operating system versions a patch repository applies to, such as "Ubuntu16.04", "AmazonLinux2016.09", "RedhatEnterpriseLinux7.2" or "Suse12.7". For lists of supported product values, see PatchFilter.
  - (string) --
- Configuration (string) -- [REQUIRED]
  
  The value of the yum repo configuration. For example:
  
  [main]
  
  cachedir=/var/cache/yum/$basesearch$releasever
  
  keepcache=0
  
  debuglevel=2

type ClientToken:

string

param ClientToken:

User-provided idempotency token.

This field is autopopulated if not provided.

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 a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. In this case, you could specify the following key name/value pairs:

Key=PatchSeverity,Value=Critical
Key=OS,Value=Windows

(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

{
    'BaselineId': 'string'
}

Response Structure

(dict) --
- BaselineId (string) --
  
  The ID of the created patch baseline.

DescribePatchBaselines (updated)

Link ¶
Changes (response)

{'BaselineIdentities': {'OperatingSystem': {'MACOS'}}}

Lists the patch baselines in your AWS account.

See also: AWS API Documentation

Request Syntax

client.describe_patch_baselines(
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

type Filters:

list

param Filters:

Each element in the array is a structure containing:

Key: (string, "NAME_PREFIX" or "OWNER")

Value: (array of strings, exactly 1 entry, between 1 and 255 characters)

(dict) --

Defines a filter used in Patch Manager APIs.
- Key (string) --
  
  The key for the filter.
- Values (list) --
  
  The value for the filter.
  - (string) --

type MaxResults:

integer

param MaxResults:

The maximum number of patch baselines to return (per page).

type NextToken:

string

param NextToken:

The token for the next set of items to return. (You received this token from a previous call.)

rtype:

dict

returns:

Response Syntax

{
    'BaselineIdentities': [
        {
            'BaselineId': 'string',
            'BaselineName': 'string',
            'OperatingSystem': 'WINDOWS'|'AMAZON_LINUX'|'AMAZON_LINUX_2'|'UBUNTU'|'REDHAT_ENTERPRISE_LINUX'|'SUSE'|'CENTOS'|'ORACLE_LINUX'|'DEBIAN'|'MACOS',
            'BaselineDescription': 'string',
            'DefaultBaseline': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- BaselineIdentities (list) --
  
  An array of PatchBaselineIdentity elements.
  - (dict) --
    
    Defines the basic information about a patch baseline.
    - BaselineId (string) --
      
      The ID of the patch baseline.
    - BaselineName (string) --
      
      The name of the patch baseline.
    - OperatingSystem (string) --
      
      Defines the operating system the patch baseline applies to. The Default value is WINDOWS.
    - BaselineDescription (string) --
      
      The description of the patch baseline.
    - DefaultBaseline (boolean) --
      
      Whether this is the default baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
- NextToken (string) --
  
  The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

DescribePatchGroups (updated)

Link ¶
Changes (response)

{'Mappings': {'BaselineIdentity': {'OperatingSystem': {'MACOS'}}}}

Lists all patch groups that have been registered with patch baselines.

See also: AWS API Documentation

Request Syntax

client.describe_patch_groups(
    MaxResults=123,
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string'
)

type MaxResults:

integer

param MaxResults:

The maximum number of patch groups to return (per page).

type Filters:

list

param Filters:

One or more filters. Use a filter to return a more specific list of results.

For DescribePatchGroups,valid filter keys include the following:

NAME_PREFIX: The name of the patch group. Wildcards (*) are accepted.
OPERATING_SYSTEM: The supported operating system type to return results for. For valid operating system values, see GetDefaultPatchBaselineRequest$OperatingSystem in CreatePatchBaseline. Examples:
- --filters Key=NAME_PREFIX,Values=MyPatchGroup*
- --filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2

(dict) --

Defines a filter used in Patch Manager APIs.
- Key (string) --
  
  The key for the filter.
- Values (list) --
  
  The value for the filter.
  - (string) --

type NextToken:

string

param NextToken:

The token for the next set of items to return. (You received this token from a previous call.)

rtype:

dict

returns:

Response Syntax

{
    'Mappings': [
        {
            'PatchGroup': 'string',
            'BaselineIdentity': {
                'BaselineId': 'string',
                'BaselineName': 'string',
                'OperatingSystem': 'WINDOWS'|'AMAZON_LINUX'|'AMAZON_LINUX_2'|'UBUNTU'|'REDHAT_ENTERPRISE_LINUX'|'SUSE'|'CENTOS'|'ORACLE_LINUX'|'DEBIAN'|'MACOS',
                'BaselineDescription': 'string',
                'DefaultBaseline': True|False
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Mappings (list) --
  
  Each entry in the array contains:
  
  PatchGroup: string (between 1 and 256 characters, Regex: ^([p{L}p{Z}p{N}_.:/=+-@]*)$)
  
  PatchBaselineIdentity: A PatchBaselineIdentity element.
  - (dict) --
    
    The mapping between a patch group and the patch baseline the patch group is registered with.
    - PatchGroup (string) --
      
      The name of the patch group registered with the patch baseline.
    - BaselineIdentity (dict) --
      
      The patch baseline the patch group is registered with.
      - BaselineId (string) --
        
        The ID of the patch baseline.
      - BaselineName (string) --
        
        The name of the patch baseline.
      - OperatingSystem (string) --
        
        Defines the operating system the patch baseline applies to. The Default value is WINDOWS.
      - BaselineDescription (string) --
        
        The description of the patch baseline.
      - DefaultBaseline (boolean) --
        
        Whether this is the default baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
- NextToken (string) --
  
  The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

DescribePatchProperties (updated)

Link ¶
Changes (request)

{'OperatingSystem': {'MACOS'}}

Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.

The following section lists the properties that can be used in filters for each major operating system type:

AMAZON_LINUX