AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . securityagent ]

batch-get-code-review-job-tasks

Description

Retrieves information about one or more tasks within a code review job.

See also: AWS API Documentation

Synopsis

  batch-get-code-review-job-tasks
--agent-space-id <value>
--code-review-job-task-ids <value>
[--cli-input-json <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>]
[--v2-debug]

Options

--agent-space-id (string)

The unique identifier of the agent space that contains the tasks.

--code-review-job-task-ids (list)

The list of task identifiers to retrieve.

(string)

Syntax:

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

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

codeReviewJobTasks -> (list)

The list of code review job tasks that were found.

(structure)

Represents an individual security test task within a code review job. Each task targets a specific risk type and executes independently.

taskId -> (string)

The unique identifier of the task.

codeReviewId -> (string)

The unique identifier of the code review associated with the task.

codeReviewJobId -> (string)

The unique identifier of the code review job that contains the task.

agentSpaceId -> (string)

The unique identifier of the agent space.

title -> (string)

The title of the task.

description -> (string)

A description of the task.

categories -> (list)

The list of categories assigned to the task.

(structure)

Represents a category assigned to a security testing task.

name -> (string)

The name of the category.

isPrimary -> (boolean)

Indicates whether this is the primary category for the task.

riskType -> (string)

The type of security risk the task is testing for.

executionStatus -> (string)

The current execution status of the task.

logsLocation -> (structure)

The location of the task execution logs.

logType -> (string)

The type of log storage. Currently, only CLOUDWATCH is supported.

cloudWatchLog -> (structure)

The CloudWatch Logs location for the task logs.

logGroup -> (string)

The name of the CloudWatch log group.

logStream -> (string)

The name of the CloudWatch log stream.

createdAt -> (timestamp)

The date and time the task was created, in UTC format.

updatedAt -> (timestamp)

The date and time the task was last updated, in UTC format.

notFound -> (list)

The list of task identifiers that were not found.

(string)