ResourceGroupsTaggingAPI / Client / get_compliance_summary

get_compliance_summary#

ResourceGroupsTaggingAPI.Client.get_compliance_summary(**kwargs)#

Returns a table that shows counts of resources that are noncompliant with their tag policies.

For more information on tag policies, see Tag Policies in the Organizations User Guide.

You can call this operation only from the organization’s management account and from the us-east-1 Region.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

See also: AWS API Documentation

Request Syntax

response = client.get_compliance_summary(
    TargetIdFilters=[
        'string',
    ],
    RegionFilters=[
        'string',
    ],
    ResourceTypeFilters=[
        'string',
    ],
    TagKeyFilters=[
        'string',
    ],
    GroupBy=[
        'TARGET_ID'|'REGION'|'RESOURCE_TYPE',
    ],
    MaxResults=123,
    PaginationToken='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:

    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) –

  • MaxResults (integer) – Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

  • PaginationToken (string) – Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

Return type:

dict

Returns:

Response Syntax

{
    'SummaryList': [
        {
            'LastUpdated': 'string',
            'TargetId': 'string',
            'TargetIdType': 'ACCOUNT'|'OU'|'ROOT',
            'Region': 'string',
            'ResourceType': 'string',
            'NonCompliantResources': 123
        },
    ],
    'PaginationToken': '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.

    • PaginationToken (string) –

      A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

Exceptions

  • ResourceGroupsTaggingAPI.Client.exceptions.ConstraintViolationException

  • ResourceGroupsTaggingAPI.Client.exceptions.InternalServiceException

  • ResourceGroupsTaggingAPI.Client.exceptions.InvalidParameterException

  • ResourceGroupsTaggingAPI.Client.exceptions.ThrottledException