AWS CLI Command Reference

[ aws . inspector2 ]

list-coverage-statistics

Description

Lists Amazon Inspector coverage statistics for your environment.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-coverage-statistics is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: countsByGroup

Synopsis

  list-coverage-statistics
[--filter-criteria <value>]
[--group-by <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--filter-criteria (structure)

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.

(structure)

Contains details of a coverage string filter.

comparison -> (string)

The operator to compare strings on.

value -> (string)

The value to compare strings on.

ec2InstanceTags -> (list)

The Amazon EC2 instance tags to filter on.

(structure)

Contains details of a coverage map filter.

comparison -> (string)

The operator to compare coverage on.

key -> (string)

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.

(structure)

Contains details of a coverage string filter.

comparison -> (string)

The operator to compare strings on.

value -> (string)

The value to compare strings on.

ecrRepositoryName -> (list)

The Amazon ECR repository name to filter on.

(structure)

Contains details of a coverage string filter.

comparison -> (string)

The operator to compare strings on.

value -> (string)

The value to compare strings on.

resourceId -> (list)

An array of Amazon Web Services resource IDs to return coverage statistics for.

(structure)

Contains details of a coverage string filter.

comparison -> (string)

The operator to compare strings on.

value -> (string)

The value to compare strings on.

resourceType -> (list)

An array of Amazon Web Services resource types to return coverage statistics for.

(structure)

Contains details of a coverage string filter.

comparison -> (string)

The operator to compare strings on.

value -> (string)

The value to compare strings on.

scanStatusCode -> (list)

The scan status code to filter on.

(structure)

Contains details of a coverage string filter.

comparison -> (string)

The operator to compare strings on.

value -> (string)

The value to compare strings on.

scanStatusReason -> (list)

The scan status reason to filter on.

(structure)

Contains details of a coverage string filter.

comparison -> (string)

The operator to compare strings on.

value -> (string)

The value to compare strings on.

scanType -> (list)

An array of Amazon Inspector scan types to return coverage statistics for.

(structure)

Contains details of a coverage string filter.

comparison -> (string)

The operator to compare strings on.

value -> (string)

The value to compare strings on.

Shorthand Syntax:

accountId=[{comparison=string,value=string},{comparison=string,value=string}],ec2InstanceTags=[{comparison=string,key=string,value=string},{comparison=string,key=string,value=string}],ecrImageTags=[{comparison=string,value=string},{comparison=string,value=string}],ecrRepositoryName=[{comparison=string,value=string},{comparison=string,value=string}],resourceId=[{comparison=string,value=string},{comparison=string,value=string}],resourceType=[{comparison=string,value=string},{comparison=string,value=string}],scanStatusCode=[{comparison=string,value=string},{comparison=string,value=string}],scanStatusReason=[{comparison=string,value=string},{comparison=string,value=string}],scanType=[{comparison=string,value=string},{comparison=string,value=string}]

JSON Syntax:

{
  "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"
    }
    ...
  ],
  "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"
    }
    ...
  ]
}

--group-by (string)

The value to group the results by.

Possible values:

  • SCAN_STATUS_CODE

  • SCAN_STATUS_REASON

  • ACCOUNT_ID

  • RESOURCE_TYPE

  • ECR_REPOSITORY_NAME

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

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

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

countsByGroup -> (list)

An array with the number for each group.

(structure)

a structure that contains information on the count of resources within a group.

count -> (long)

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 -> (long)

The total number for all groups.

© Copyright 2018, Amazon Web Services. Created using Sphinx.