AWS CLI Command Reference

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-cis-scan-results-aggregated-by-target-resource

Description

Lists scan results aggregated by a target resource.

See also: AWS API Documentation

list-cis-scan-results-aggregated-by-target-resource 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: targetResourceAggregations

Synopsis

  list-cis-scan-results-aggregated-by-target-resource
[--filter-criteria <value>]
--scan-arn <value>
[--sort-by <value>]
[--sort-order <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)

The filter criteria.

accountIdFilters -> (list)

The criteria's account ID filters.

(structure)

The CIS string filter.

comparison -> (string)

The comparison value of the CIS string filter.

value -> (string)

The value of the CIS string filter.

checkIdFilters -> (list)

The criteria's check ID filters.

(structure)

The CIS string filter.

comparison -> (string)

The comparison value of the CIS string filter.

value -> (string)

The value of the CIS string filter.

failedChecksFilters -> (list)

The criteria's failed checks filters.

(structure)

The CIS number filter.

lowerInclusive -> (integer)

The CIS number filter's lower inclusive.

upperInclusive -> (integer)

The CIS number filter's upper inclusive.

platformFilters -> (list)

The criteria's platform filters.

(structure)

The CIS string filter.

comparison -> (string)

The comparison value of the CIS string filter.

value -> (string)

The value of the CIS string filter.

statusFilters -> (list)

The criteria's status filter.

(structure)

The CIS result status filter.

comparison -> (string)

The comparison value of the CIS result status filter.

value -> (string)

The value of the CIS result status filter.

targetResourceIdFilters -> (list)

The criteria's target resource ID filters.

(structure)

The CIS string filter.

comparison -> (string)

The comparison value of the CIS string filter.

value -> (string)

The value of the CIS string filter.

targetResourceTagFilters -> (list)

The criteria's target resource tag filters.

(structure)

The tag filter.

comparison -> (string)

The tag filter comparison value.

key -> (string)

The tag filter key.

value -> (string)

The tag filter value.

targetStatusFilters -> (list)

The criteria's target status filters.

(structure)

The CIS target status filter.

comparison -> (string)

The comparison value of the CIS target status filter.

value -> (string)

The value of the CIS target status filter.

targetStatusReasonFilters -> (list)

The criteria's target status reason filters.

(structure)

The CIS target status reason filter.

comparison -> (string)

The comparison value of the CIS target status reason filter.

value -> (string)

The value of the CIS target status reason filter.

Shorthand Syntax:

accountIdFilters=[{comparison=string,value=string},{comparison=string,value=string}],checkIdFilters=[{comparison=string,value=string},{comparison=string,value=string}],failedChecksFilters=[{lowerInclusive=integer,upperInclusive=integer},{lowerInclusive=integer,upperInclusive=integer}],platformFilters=[{comparison=string,value=string},{comparison=string,value=string}],statusFilters=[{comparison=string,value=string},{comparison=string,value=string}],targetResourceIdFilters=[{comparison=string,value=string},{comparison=string,value=string}],targetResourceTagFilters=[{comparison=string,key=string,value=string},{comparison=string,key=string,value=string}],targetStatusFilters=[{comparison=string,value=string},{comparison=string,value=string}],targetStatusReasonFilters=[{comparison=string,value=string},{comparison=string,value=string}]

JSON Syntax:

{
  "accountIdFilters": [
    {
      "comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
      "value": "string"
    }
    ...
  ],
  "checkIdFilters": [
    {
      "comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
      "value": "string"
    }
    ...
  ],
  "failedChecksFilters": [
    {
      "lowerInclusive": integer,
      "upperInclusive": integer
    }
    ...
  ],
  "platformFilters": [
    {
      "comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
      "value": "string"
    }
    ...
  ],
  "statusFilters": [
    {
      "comparison": "EQUALS",
      "value": "PASSED"|"FAILED"|"SKIPPED"
    }
    ...
  ],
  "targetResourceIdFilters": [
    {
      "comparison": "EQUALS"|"PREFIX"|"NOT_EQUALS",
      "value": "string"
    }
    ...
  ],
  "targetResourceTagFilters": [
    {
      "comparison": "EQUALS",
      "key": "string",
      "value": "string"
    }
    ...
  ],
  "targetStatusFilters": [
    {
      "comparison": "EQUALS",
      "value": "TIMED_OUT"|"CANCELLED"|"COMPLETED"
    }
    ...
  ],
  "targetStatusReasonFilters": [
    {
      "comparison": "EQUALS",
      "value": "SCAN_IN_PROGRESS"|"UNSUPPORTED_OS"|"SSM_UNMANAGED"
    }
    ...
  ]
}

--scan-arn (string)

The scan ARN.

--sort-by (string)

The sort by order.

Possible values:

  • RESOURCE_ID
  • FAILED_COUNTS
  • ACCOUNT_ID
  • PLATFORM
  • TARGET_STATUS
  • TARGET_STATUS_REASON

--sort-order (string)

The sort order.

Possible values:

  • ASC
  • DESC

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

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

nextToken -> (string)

The pagination token from a previous request that's used to retrieve the next page of results.

targetResourceAggregations -> (list)

The resource aggregations.

(structure)

The CIS target resource aggregation.

accountId -> (string)

The account ID for the CIS target resource.

platform -> (string)

The platform for the CIS target resource.

scanArn -> (string)

The scan ARN for the CIS target resource.

statusCounts -> (structure)

The target resource status counts.

failed -> (integer)

The number of checks that failed.

passed -> (integer)

The number of checks that passed.

skipped -> (integer)

The number of checks that were skipped.

targetResourceId -> (string)

The ID of the target resource.

targetResourceTags -> (map)

The tag for the target resource.

key -> (string)

value -> (list)

(string)

targetStatus -> (string)

The status of the target resource.

targetStatusReason -> (string)

The reason for the target resource.