AWS API Changes

2024/11/22 - AWS Systems Manager QuickSetup - 2 new api methods

Changes Add methods that retrieve details about deployed configurations: ListConfigurations, GetConfiguration

ListConfigurations (new)

Link ¶

Returns configurations deployed by Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.

See also: AWS API Documentation

Request Syntax

client.list_configurations(
    ConfigurationDefinitionId='string',
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    ManagerArn='string',
    MaxItems=123,
    StartingToken='string'
)

type ConfigurationDefinitionId:

string

param ConfigurationDefinitionId:

The ID of the configuration definition.

type Filters:

list

param Filters:

Filters the results returned by the request.

(dict) --

A key-value pair to filter results.
- Key (string) -- [REQUIRED]
  
  The key for the filter.
- Values (list) -- [REQUIRED]
  
  The values for the filter keys.
  - (string) --

type ManagerArn:

string

param ManagerArn:

The ARN of the configuration manager.

type MaxItems:

integer

param MaxItems:

Specifies the maximum number of configurations that are returned by the request.

type StartingToken:

string

param StartingToken:

The token to use when requesting a specific set of items from a list.

rtype:

dict

returns:

Response Syntax

{
    'ConfigurationsList': [
        {
            'Account': 'string',
            'ConfigurationDefinitionId': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'FirstClassParameters': {
                'string': 'string'
            },
            'Id': 'string',
            'ManagerArn': 'string',
            'Region': 'string',
            'StatusSummaries': [
                {
                    'LastUpdatedAt': datetime(2015, 1, 1),
                    'Status': 'INITIALIZING'|'DEPLOYING'|'SUCCEEDED'|'DELETING'|'STOPPING'|'FAILED'|'STOPPED'|'DELETE_FAILED'|'STOP_FAILED'|'NONE',
                    'StatusDetails': {
                        'string': 'string'
                    },
                    'StatusMessage': 'string',
                    'StatusType': 'Deployment'|'AsyncExecutions'
                },
            ],
            'Type': 'string',
            'TypeVersion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ConfigurationsList (list) --
  
  An array of configurations.
  - (dict) --
    
    Details for a Quick Setup configuration.
    - Account (string) --
      
      The ID of the Amazon Web Services account where the configuration was deployed.
    - ConfigurationDefinitionId (string) --
      
      The ID of the configuration definition.
    - CreatedAt (datetime) --
      
      The datetime stamp when the configuration was created.
    - FirstClassParameters (dict) --
      
      The common parameters and values for the configuration definition.
      - (string) --
        
        (string) --
    - Id (string) --
      
      A service generated identifier for the configuration.
    - ManagerArn (string) --
      
      The ARN of the configuration manager.
    - Region (string) --
      
      The Amazon Web Services Region where the configuration was deployed.
    - StatusSummaries (list) --
      
      A summary of the state of the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more.
      - (dict) --
        
        A summarized description of the status.
        
        LastUpdatedAt (datetime) --
        
        The datetime stamp when the status was last updated.
        
        Status (string) --
        
        The current status.
        
        StatusDetails (dict) --
        
        Details about the status.
        
        (string) --
        
        (string) --
        
        StatusMessage (string) --
        
        When applicable, returns an informational message relevant to the current status and status type of the status summary object. We don't recommend implementing parsing logic around this value since the messages returned can vary in format.
        
        StatusType (string) --
        
        The type of a status summary.
    - Type (string) --
      
      The type of the Quick Setup configuration.
    - TypeVersion (string) --
      
      The version of the Quick Setup type used.
- 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.

GetConfiguration (new)

Link ¶

Returns details about the specified configuration.

See also: AWS API Documentation

Request Syntax

client.get_configuration(
    ConfigurationId='string'
)

type ConfigurationId:

string

param ConfigurationId:

[REQUIRED]

A service generated identifier for the configuration.

rtype:

dict

returns:

Response Syntax

{
    'Account': 'string',
    'ConfigurationDefinitionId': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Id': 'string',
    'LastModifiedAt': datetime(2015, 1, 1),
    'ManagerArn': 'string',
    'Parameters': {
        'string': 'string'
    },
    'Region': 'string',
    'StatusSummaries': [
        {
            'LastUpdatedAt': datetime(2015, 1, 1),
            'Status': 'INITIALIZING'|'DEPLOYING'|'SUCCEEDED'|'DELETING'|'STOPPING'|'FAILED'|'STOPPED'|'DELETE_FAILED'|'STOP_FAILED'|'NONE',
            'StatusDetails': {
                'string': 'string'
            },
            'StatusMessage': 'string',
            'StatusType': 'Deployment'|'AsyncExecutions'
        },
    ],
    'Type': 'string',
    'TypeVersion': 'string'
}

Response Structure

(dict) --
- Account (string) --
  
  The ID of the Amazon Web Services account where the configuration was deployed.
- ConfigurationDefinitionId (string) --
  
  The ID of the configuration definition.
- CreatedAt (datetime) --
  
  The datetime stamp when the configuration manager was created.
- Id (string) --
  
  A service generated identifier for the configuration.
- LastModifiedAt (datetime) --
  
  The datetime stamp when the configuration manager was last updated.
- ManagerArn (string) --
  
  The ARN of the configuration manager.
- Parameters (dict) --
  
  The parameters for the configuration definition type.
  - (string) --
    - (string) --
- Region (string) --
  
  The Amazon Web Services Region where the configuration was deployed.
- StatusSummaries (list) --
  
  A summary of the state of the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more.
  - (dict) --
    
    A summarized description of the status.
    - LastUpdatedAt (datetime) --
      
      The datetime stamp when the status was last updated.
    - Status (string) --
      
      The current status.
    - StatusDetails (dict) --
      
      Details about the status.
      - (string) --
        
        (string) --
    - StatusMessage (string) --
      
      When applicable, returns an informational message relevant to the current status and status type of the status summary object. We don't recommend implementing parsing logic around this value since the messages returned can vary in format.
    - StatusType (string) --
      
      The type of a status summary.
- Type (string) --
  
  The type of the Quick Setup configuration.
- TypeVersion (string) --
  
  The version of the Quick Setup type used.