ConfigService / Client / describe_organization_conformance_packs

describe_organization_conformance_packs

ConfigService.Client.describe_organization_conformance_packs(**kwargs)

Returns a list of organization conformance packs.

Note

When you specify the limit and the next token, you receive a paginated response.

Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs.

For accounts within an organzation

If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won’t be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.

See also: AWS API Documentation

Request Syntax

response = client.describe_organization_conformance_packs(
    OrganizationConformancePackNames=[
        'string',
    ],
    Limit=123,
    NextToken='string'
)

Parameters:

• OrganizationConformancePackNames (list) –

  The name that you assign to an organization conformance pack.

  • (string) –

• Limit (integer) – The maximum number of organization config packs returned on each page. If you do no specify a number, Config uses the default. The default is 100.

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

Return type:

dict

Returns:

Response Syntax

{
    'OrganizationConformancePacks': [
        {
            'OrganizationConformancePackName': 'string',
            'OrganizationConformancePackArn': 'string',
            'DeliveryS3Bucket': 'string',
            'DeliveryS3KeyPrefix': 'string',
            'ConformancePackInputParameters': [
                {
                    'ParameterName': 'string',
                    'ParameterValue': 'string'
                },
            ],
            'ExcludedAccounts': [
                'string',
            ],
            'LastUpdateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • OrganizationConformancePacks (list) –

    Returns a list of OrganizationConformancePacks objects.

    • (dict) –

      An organization conformance pack that has information about conformance packs that Config creates in member accounts.

      • OrganizationConformancePackName (string) –

        The name you assign to an organization conformance pack.

      • OrganizationConformancePackArn (string) –

        Amazon Resource Name (ARN) of organization conformance pack.

      • DeliveryS3Bucket (string) –

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

        Note

        This field is optional.

      • DeliveryS3KeyPrefix (string) –

        Any folder structure you want to add to an 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.

      • ExcludedAccounts (list) –

        A comma-separated list of accounts excluded from organization conformance pack.

        • (string) –

      • LastUpdateTime (datetime) –

        Last time when organization conformation pack was updated.

  • NextToken (string) –

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

Exceptions

• ConfigService.Client.exceptions.NoSuchOrganizationConformancePackException

• ConfigService.Client.exceptions.InvalidNextTokenException

• ConfigService.Client.exceptions.InvalidLimitException

• ConfigService.Client.exceptions.OrganizationAccessDeniedException