ConfigService / Client / describe_conformance_packs

describe_conformance_packs

ConfigService.Client.describe_conformance_packs(**kwargs)

Returns a list of one or more conformance packs.

See also: AWS API Documentation

Request Syntax

response = client.describe_conformance_packs(
    ConformancePackNames=[
        'string',
    ],
    Limit=123,
    NextToken='string'
)

Parameters:

• ConformancePackNames (list) –

  Comma-separated list of conformance pack names for which you want details. If you do not specify any names, Config returns details for all your conformance packs.

  • (string) –

• Limit (integer) – The maximum number of conformance packs 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

{
    'ConformancePackDetails': [
        {
            'ConformancePackName': 'string',
            'ConformancePackArn': 'string',
            'ConformancePackId': 'string',
            'DeliveryS3Bucket': 'string',
            'DeliveryS3KeyPrefix': 'string',
            'ConformancePackInputParameters': [
                {
                    'ParameterName': 'string',
                    'ParameterValue': 'string'
                },
            ],
            'LastUpdateRequestedTime': datetime(2015, 1, 1),
            'CreatedBy': 'string',
            'TemplateSSMDocumentDetails': {
                'DocumentName': 'string',
                'DocumentVersion': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • ConformancePackDetails (list) –

    Returns a list of ConformancePackDetail objects.

    • (dict) –

      Returns details of a conformance pack. A conformance pack is a collection of Config rules and remediation actions that can be easily deployed in an account and a region.

      • ConformancePackName (string) –

        Name of the conformance pack.

      • ConformancePackArn (string) –

        Amazon Resource Name (ARN) of the conformance pack.

      • ConformancePackId (string) –

        ID of the conformance pack.

      • DeliveryS3Bucket (string) –

        The name of the Amazon S3 bucket where Config stores conformance pack templates.

        Note

        This field is optional.

      • DeliveryS3KeyPrefix (string) –

        The prefix for the Amazon S3 bucket.

        Note

        This field is optional.

      • ConformancePackInputParameters (list) –

        A list of ConformancePackInputParameter objects.

        • (dict) –

          Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.

          • ParameterName (string) –

            One part of a key-value pair.

          • ParameterValue (string) –

            Another part of the key-value pair.

      • LastUpdateRequestedTime (datetime) –

        The last time a conformation pack update was requested.

      • CreatedBy (string) –

        The Amazon Web Services service that created the conformance pack.

      • TemplateSSMDocumentDetails (dict) –

        An object that contains the name or Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.

        • DocumentName (string) –

          The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, Config checks only your account and Amazon Web Services Region for the SSM document. If you want to use an SSM document from another Region or account, you must provide the ARN.

        • DocumentVersion (string) –

          The version of the SSM document to use to create a conformance pack. By default, Config uses the latest version.

          Note

          This field is optional.

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

• ConfigService.Client.exceptions.InvalidLimitException

• ConfigService.Client.exceptions.InvalidNextTokenException

• ConfigService.Client.exceptions.InvalidParameterValueException