SystemsManagerQuickSetup / Client / list_configuration_managers

list_configuration_managers#

SystemsManagerQuickSetup.Client.list_configuration_managers(**kwargs)#

Returns Quick Setup configuration managers.

See also: AWS API Documentation

Request Syntax

response = client.list_configuration_managers(
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxItems=123,
    StartingToken='string'
)
Parameters:
  • 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) –

  • MaxItems (integer) – Specifies the maximum number of configuration managers that are returned by the request.

  • StartingToken (string) – The token to use when requesting a specific set of items from a list.

Return type:

dict

Returns:

Response Syntax

{
    'ConfigurationManagersList': [
        {
            'ConfigurationDefinitionSummaries': [
                {
                    'FirstClassParameters': {
                        'string': 'string'
                    },
                    'Id': 'string',
                    'Type': 'string',
                    'TypeVersion': 'string'
                },
            ],
            'Description': 'string',
            'ManagerArn': 'string',
            'Name': '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'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ConfigurationManagersList (list) –

      The configuration managers returned by the request.

      • (dict) –

        A summary of a Quick Setup configuration manager.

        • ConfigurationDefinitionSummaries (list) –

          A summary of the Quick Setup configuration definition.

          • (dict) –

            A summarized definition of a Quick Setup configuration definition.

            • FirstClassParameters (dict) –

              The common parameters and values for the configuration definition.

              • (string) –

                • (string) –

            • Id (string) –

              The ID of the configuration definition.

            • Type (string) –

              The type of the Quick Setup configuration used by the configuration definition.

            • TypeVersion (string) –

              The version of the Quick Setup type used by the configuration definition.

        • Description (string) –

          The description of the configuration.

        • ManagerArn (string) –

          The ARN of the Quick Setup configuration.

        • Name (string) –

          The name of the configuration

        • StatusSummaries (list) –

          Summaries of the state of the configuration manager. These summaries include an aggregate of the statuses from the configuration definition associated with 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.

    • NextToken (string) –

      The token to use when requesting the next set of configuration managers. If there are no additional operations to return, the string is empty.

Exceptions

  • SystemsManagerQuickSetup.Client.exceptions.ValidationException

  • SystemsManagerQuickSetup.Client.exceptions.ConflictException

  • SystemsManagerQuickSetup.Client.exceptions.InternalServerException

  • SystemsManagerQuickSetup.Client.exceptions.AccessDeniedException

  • SystemsManagerQuickSetup.Client.exceptions.ThrottlingException