ConfigService / Client / describe_conformance_pack_status

describe_conformance_pack_status#

ConfigService.Client.describe_conformance_pack_status(**kwargs)#

Provides one or more conformance packs deployment status.

Note

If there are no conformance packs then you will see an empty result.

See also: AWS API Documentation

Request Syntax

response = client.describe_conformance_pack_status(
    ConformancePackNames=[
        'string',
    ],
    Limit=123,
    NextToken='string'
)
Parameters:

  • ConformancePackNames (list) –

    Comma-separated list of conformance pack names.

    • (string) –

  • Limit (integer) – The maximum number of conformance packs status returned on each page.

  • NextToken (string) – The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Return type:

dict

Returns:

Response Syntax

{
    'ConformancePackStatusDetails': [
        {
            'ConformancePackName': 'string',
            'ConformancePackId': 'string',
            'ConformancePackArn': 'string',
            'ConformancePackState': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
            'StackArn': 'string',
            'ConformancePackStatusReason': 'string',
            'LastUpdateRequestedTime': datetime(2015, 1, 1),
            'LastUpdateCompletedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ConformancePackStatusDetails (list) –

      A list of ConformancePackStatusDetail objects.

      • (dict) –

        Status details of a conformance pack.

        • ConformancePackName (string) –

          Name of the conformance pack.

        • ConformancePackId (string) –

          ID of the conformance pack.

        • ConformancePackArn (string) –

          Amazon Resource Name (ARN) of comformance pack.

        • ConformancePackState (string) –

          Indicates deployment status of conformance pack.

          Config sets the state of the conformance pack to:

          • CREATE_IN_PROGRESS when a conformance pack creation is in progress for an account.

          • CREATE_COMPLETE when a conformance pack has been successfully created in your account.

          • CREATE_FAILED when a conformance pack creation failed in your account.

          • DELETE_IN_PROGRESS when a conformance pack deletion is in progress.

          • DELETE_FAILED when a conformance pack deletion failed in your account.

        • StackArn (string) –

          Amazon Resource Name (ARN) of CloudFormation stack.

        • ConformancePackStatusReason (string) –

          The reason of conformance pack creation failure.

        • LastUpdateRequestedTime (datetime) –

          Last time when conformation pack creation and update was requested.

        • LastUpdateCompletedTime (datetime) –

          Last time when conformation pack creation and update was successful.

    • NextToken (string) –

      The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Exceptions

  • ConfigService.Client.exceptions.InvalidLimitException

  • ConfigService.Client.exceptions.InvalidNextTokenException

  • ConfigService.Client.exceptions.InvalidParameterValueException