Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . inspector ]

list-assessment-runs

Description

Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

list-assessment-runs 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: assessmentRunArns

Synopsis

  list-assessment-runs
[--assessment-template-arns <value>]
[--filter <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--assessment-template-arns (list)

The ARNs that specify the assessment templates whose assessment runs you want to list.

Syntax:

"string" "string" ...

--filter (structure)

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

Shorthand Syntax:

namePattern=string,states=string,string,durationRange={minSeconds=integer,maxSeconds=integer},rulesPackageArns=string,string,startTimeRange={beginDate=timestamp,endDate=timestamp},completionTimeRange={beginDate=timestamp,endDate=timestamp},stateChangeTimeRange={beginDate=timestamp,endDate=timestamp}

JSON Syntax:

{
  "namePattern": "string",
  "states": ["CREATED"|"START_DATA_COLLECTION_PENDING"|"START_DATA_COLLECTION_IN_PROGRESS"|"COLLECTING_DATA"|"STOP_DATA_COLLECTION_PENDING"|"DATA_COLLECTED"|"START_EVALUATING_RULES_PENDING"|"EVALUATING_RULES"|"FAILED"|"ERROR"|"COMPLETED"|"COMPLETED_WITH_ERRORS"|"CANCELED", ...],
  "durationRange": {
    "minSeconds": integer,
    "maxSeconds": integer
  },
  "rulesPackageArns": ["string", ...],
  "startTimeRange": {
    "beginDate": timestamp,
    "endDate": timestamp
  },
  "completionTimeRange": {
    "beginDate": timestamp,
    "endDate": timestamp
  },
  "stateChangeTimeRange": {
    "beginDate": timestamp,
    "endDate": timestamp
  }
}

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

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

See 'aws help' for descriptions of global parameters.

Examples

To list assessment runs

The following list-assessment-runs command lists all existing assessment runs:

aws inspector list-assessment-runs

Output:

{
"assessmentRunArns": [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-v5D6fI3v" ]

}

For more information, see Amazon Inspector Assessment Templates and Assessment Runs in the Amazon Inspector guide.

Output

assessmentRunArns -> (list)

A list of ARNs that specifies the assessment runs that are returned by the action.

(string)

nextToken -> (string)

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.