ResourceGroupsTaggingAPI / Paginator / GetComplianceSummary

GetComplianceSummary

class ResourceGroupsTaggingAPI.Paginator.GetComplianceSummary

paginator = client.get_paginator('get_compliance_summary')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ResourceGroupsTaggingAPI.Client.get_compliance_summary().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    TargetIdFilters=[
        'string',
    ],
    RegionFilters=[
        'string',
    ],
    ResourceTypeFilters=[
        'string',
    ],
    TagKeyFilters=[
        'string',
    ],
    GroupBy=[
        'TARGET_ID'|'REGION'|'RESOURCE_TYPE',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• TargetIdFilters (list) –

  Specifies target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs.

  • (string) –

• RegionFilters (list) –

  Specifies a list of Amazon Web Services Regions to limit the output to. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.

  • (string) –

• ResourceTypeFilters (list) –

  Specifies that you want the response to include information for only resources of the specified types. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

  The string for each service name and resource type is the same as that embedded in a resource’s Amazon Resource Name (ARN). Consult the Amazon Web Services General Reference for the following:

  • For a list of service name strings, see Amazon Web Services Service Namespaces.

  • For resource type strings, see Example ARNs.

  • For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

  Note

  For the list of services whose resources you can tag using the Resource Groups Tagging API, see Services that support the Resource Groups Tagging API. If an Amazon Web Services service isn’t listed on that page, you might still be able to tag that service’s resources by using that service’s native tagging operations instead of using Resource Groups Tagging API operations. All tagged resources, whether the tagging used the Resource Groups Tagging API or not, are returned by the Get* operation.

  You can specify multiple resource types by using a comma separated array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.

  • (string) –

• TagKeyFilters (list) –

  Specifies that you want the response to include information for only resources that have tags with the specified tag keys. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.

  • (string) –

• GroupBy (list) –

  Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.

  • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'SummaryList': [
        {
            'LastUpdated': 'string',
            'TargetId': 'string',
            'TargetIdType': 'ACCOUNT'|'OU'|'ROOT',
            'Region': 'string',
            'ResourceType': 'string',
            'NonCompliantResources': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • SummaryList (list) –

    A table that shows counts of noncompliant resources.

    • (dict) –

      A count of noncompliant resources.

      • LastUpdated (string) –

        The timestamp that shows when this summary was generated in this Region.

      • TargetId (string) –

        The account identifier or the root identifier of the organization. If you don’t know the root ID, you can call the Organizations ListRoots API.

      • TargetIdType (string) –

        Whether the target is an account, an OU, or the organization root.

      • Region (string) –

        The Amazon Web Services Region that the summary applies to.

      • ResourceType (string) –

        The Amazon Web Services resource type.

      • NonCompliantResources (integer) –

        The count of noncompliant resources.

  • NextToken (string) –

    A token to resume pagination.