SystemsManagerQuickSetup / Client / get_configuration_manager

get_configuration_manager#

SystemsManagerQuickSetup.Client.get_configuration_manager(**kwargs)#

Returns a configuration manager.

See also: AWS API Documentation

Request Syntax

response = client.get_configuration_manager(
    ManagerArn='string'
)
Parameters:

ManagerArn (string) –

[REQUIRED]

The ARN of the configuration manager.

Return type:

dict

Returns:

Response Syntax

{
    'ConfigurationDefinitions': [
        {
            'Id': 'string',
            'LocalDeploymentAdministrationRoleArn': 'string',
            'LocalDeploymentExecutionRoleName': 'string',
            'Parameters': {
                'string': 'string'
            },
            'Type': 'string',
            'TypeVersion': 'string'
        },
    ],
    'CreatedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'LastModifiedAt': datetime(2015, 1, 1),
    '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'
        },
    ],
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • ConfigurationDefinitions (list) –

      The configuration definitions association with the configuration manager.

      • (dict) –

        The definition of a Quick Setup configuration.

        • Id (string) –

          The ID of the configuration definition.

        • LocalDeploymentAdministrationRoleArn (string) –

          The ARN of the IAM role used to administrate local configuration deployments.

        • LocalDeploymentExecutionRoleName (string) –

          The name of the IAM role used to deploy local configurations.

        • Parameters (dict) –

          A list of key-value pairs containing the required parameters for the configuration type.

          • (string) –

            • (string) –

        • Type (string) –

          The type of the Quick Setup configuration.

        • TypeVersion (string) –

          The version of the Quick Setup type used.

    • CreatedAt (datetime) –

      The datetime stamp when the configuration manager was created.

    • Description (string) –

      The description of the configuration manager.

    • LastModifiedAt (datetime) –

      The datetime stamp when the configuration manager was last updated.

    • ManagerArn (string) –

      The ARN of the configuration manager.

    • Name (string) –

      The name of the configuration manager.

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

    • Tags (dict) –

      Key-value pairs of metadata to assign to the configuration manager.

      • (string) –

        • (string) –

Exceptions

  • SystemsManagerQuickSetup.Client.exceptions.ValidationException

  • SystemsManagerQuickSetup.Client.exceptions.ConflictException

  • SystemsManagerQuickSetup.Client.exceptions.InternalServerException

  • SystemsManagerQuickSetup.Client.exceptions.AccessDeniedException

  • SystemsManagerQuickSetup.Client.exceptions.ThrottlingException

  • SystemsManagerQuickSetup.Client.exceptions.ResourceNotFoundException