list_coverage_statistics¶

list_coverage_statistics(**kwargs)¶

Lists Amazon Inspector coverage statistics for your environment.

Request Syntax

response = client.list_coverage_statistics(
    filterCriteria={
        'accountId': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ],
        'ecrImageTags': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrRepositoryName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionRuntime': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ],
        'resourceId': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceType': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanStatusCode': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanStatusReason': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanType': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ]
    },
    groupBy='SCAN_STATUS_CODE'|'SCAN_STATUS_REASON'|'ACCOUNT_ID'|'RESOURCE_TYPE'|'ECR_REPOSITORY_NAME',
    nextToken='string'
)

Parameters

filterCriteria (dict) --
An object that contains details on the filters to apply to the coverage data for your environment.
- accountId (list) --
  An array of Amazon Web Services account IDs to return coverage statistics for.
  - (dict) --
    Contains details of a coverage string filter.
    - comparison (string) -- [REQUIRED]
      The operator to compare strings on.
    - value (string) -- [REQUIRED]
      The value to compare strings on.
- ec2InstanceTags (list) --
  The Amazon EC2 instance tags to filter on.
  - (dict) --
    Contains details of a coverage map filter.
    - comparison (string) -- [REQUIRED]
      The operator to compare coverage on.
    - key (string) -- [REQUIRED]
      The tag key associated with the coverage map filter.
    - value (string) --
      The tag value associated with the coverage map filter.
- ecrImageTags (list) --
  The Amazon ECR image tags to filter on.
  - (dict) --
    Contains details of a coverage string filter.
    - comparison (string) -- [REQUIRED]
      The operator to compare strings on.
    - value (string) -- [REQUIRED]
      The value to compare strings on.
- ecrRepositoryName (list) --
  The Amazon ECR repository name to filter on.
  - (dict) --
    Contains details of a coverage string filter.
    - comparison (string) -- [REQUIRED]
      The operator to compare strings on.
    - value (string) -- [REQUIRED]
      The value to compare strings on.
- lambdaFunctionName (list) --
  Returns coverage statistics for AWS Lambda functions filtered by function names.
  - (dict) --
    Contains details of a coverage string filter.
    - comparison (string) -- [REQUIRED]
      The operator to compare strings on.
    - value (string) -- [REQUIRED]
      The value to compare strings on.
- lambdaFunctionRuntime (list) --
  Returns coverage statistics for AWS Lambda functions filtered by runtime.
  - (dict) --
    Contains details of a coverage string filter.
    - comparison (string) -- [REQUIRED]
      The operator to compare strings on.
    - value (string) -- [REQUIRED]
      The value to compare strings on.
- lambdaFunctionTags (list) --
  Returns coverage statistics for AWS Lambda functions filtered by tag.
  - (dict) --
    Contains details of a coverage map filter.
    - comparison (string) -- [REQUIRED]
      The operator to compare coverage on.
    - key (string) -- [REQUIRED]
      The tag key associated with the coverage map filter.
    - value (string) --
      The tag value associated with the coverage map filter.
- resourceId (list) --
  An array of Amazon Web Services resource IDs to return coverage statistics for.
  - (dict) --
    Contains details of a coverage string filter.
    - comparison (string) -- [REQUIRED]
      The operator to compare strings on.
    - value (string) -- [REQUIRED]
      The value to compare strings on.
- resourceType (list) --
  An array of Amazon Web Services resource types to return coverage statistics for. The values can be AWS_EC2_INSTANCE or AWS_ECR_REPOSITORY .
  - (dict) --
    Contains details of a coverage string filter.
    - comparison (string) -- [REQUIRED]
      The operator to compare strings on.
    - value (string) -- [REQUIRED]
      The value to compare strings on.
- scanStatusCode (list) --
  The scan status code to filter on.
  - (dict) --
    Contains details of a coverage string filter.
    - comparison (string) -- [REQUIRED]
      The operator to compare strings on.
    - value (string) -- [REQUIRED]
      The value to compare strings on.
- scanStatusReason (list) --
  The scan status reason to filter on.
  - (dict) --
    Contains details of a coverage string filter.
    - comparison (string) -- [REQUIRED]
      The operator to compare strings on.
    - value (string) -- [REQUIRED]
      The value to compare strings on.
- scanType (list) --
  An array of Amazon Inspector scan types to return coverage statistics for.
  - (dict) --
    Contains details of a coverage string filter.
    - comparison (string) -- [REQUIRED]
      The operator to compare strings on.
    - value (string) -- [REQUIRED]
      The value to compare strings on.
groupBy (string) -- The value to group the results by.
nextToken (string) -- A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Return type

dict

Returns

Response Syntax

{
    'countsByGroup': [
        {
            'count': 123,
            'groupKey': 'SCAN_STATUS_CODE'|'SCAN_STATUS_REASON'|'ACCOUNT_ID'|'RESOURCE_TYPE'|'ECR_REPOSITORY_NAME'
        },
    ],
    'nextToken': 'string',
    'totalCounts': 123
}

Response Structure

(dict) --
- countsByGroup (list) --
  
  An array with the number for each group.
  - (dict) --
    
    a structure that contains information on the count of resources within a group.
    - count (integer) --
      
      The number of resources.
    - groupKey (string) --
      
      The key associated with this group
- nextToken (string) --
  
  A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
- totalCounts (integer) --
  
  The total number for all groups.

Exceptions

Inspector2.Client.exceptions.ValidationException
Inspector2.Client.exceptions.ThrottlingException
Inspector2.Client.exceptions.InternalServerException

Table Of Contents

list_coverage_statistics¶