SystemsManagerQuickSetup / Paginator / ListConfigurations

ListConfigurations

class SystemsManagerQuickSetup.Paginator.ListConfigurations

paginator = client.get_paginator('list_configurations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SystemsManagerQuickSetup.Client.list_configurations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ConfigurationDefinitionId='string',
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    ManagerArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ConfigurationDefinitionId (string) – The ID of the configuration definition.

• Filters (list) –

  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) –

• ManagerArn (string) – The ARN of the configuration manager.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

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'
        },
    ],

}

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.