Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . inspector2 ]

list-coverage

Description

Lists coverage details for you environment.

See also: AWS API Documentation

list-coverage 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: coveredResources

Synopsis

  list-coverage
[--filter-criteria <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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.

lambdaFunctionName -> (list)

Returns coverage statistics for AWS Lambda functions filtered by function names.

(structure)

Contains details of a coverage string filter.

comparison -> (string)

The operator to compare strings on.

value -> (string)

The value to compare strings on.

lambdaFunctionRuntime -> (list)

Returns coverage statistics for AWS Lambda functions filtered by runtime.

(structure)

Contains details of a coverage string filter.

comparison -> (string)

The operator to compare strings on.

value -> (string)

The value to compare strings on.

lambdaFunctionTags -> (list)

Returns coverage statistics for AWS Lambda functions filtered by tag.

(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.

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. The values can be AWS_EC2_INSTANCE or AWS_ECR_REPOSITORY .

(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}],lambdaFunctionName=[{comparison=string,value=string},{comparison=string,value=string}],lambdaFunctionRuntime=[{comparison=string,value=string},{comparison=string,value=string}],lambdaFunctionTags=[{comparison=string,key=string,value=string},{comparison=string,key=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"
    }
    ...
  ],
  "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"
    }
    ...
  ]
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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 .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

coveredResources -> (list)

An object that contains details on the covered resources in your environment.

(structure)

An object that contains details about a resource covered by Amazon Inspector.

accountId -> (string)

The Amazon Web Services account ID of the covered resource.

resourceId -> (string)

The ID of the covered resource.

resourceMetadata -> (structure)

An object that contains details about the metadata.

ec2 -> (structure)

An object that contains metadata details for an Amazon EC2 instance.

amiId -> (string)

The ID of the Amazon Machine Image (AMI) used to launch the instance.

platform -> (string)

The platform of the instance.

tags -> (map)

The tags attached to the instance.

key -> (string)

value -> (string)

ecrImage -> (structure)

An object that contains details about the container metadata for an Amazon ECR image.

tags -> (list)

Tags associated with the Amazon ECR image metadata.

(string)

ecrRepository -> (structure)

An object that contains details about the repository an Amazon ECR image resides in.

name -> (string)

The name of the Amazon ECR repository.

scanFrequency -> (string)

The frequency of scans.

lambdaFunction -> (structure)

An object that contains metadata details for an AWS Lambda function.

functionName -> (string)

The name of a function.

functionTags -> (map)

The resource tags on an AWS Lambda function.

key -> (string)

value -> (string)

layers -> (list)

The layers for an AWS Lambda function. A Lambda function can have up to five layers.

(string)

runtime -> (string)

An AWS Lambda function's runtime.

resourceType -> (string)

The type of the covered resource.

scanStatus -> (structure)

The status of the scan covering the resource.

reason -> (string)

The reason for the scan.

statusCode -> (string)

The status code of the scan.

scanType -> (string)

The Amazon Inspector scan type covering the resource.

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.