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

Description

Retrieves information about one or more code review jobs in an agent space.

See also: AWS API Documentation

Synopsis

  batch-get-code-review-jobs
--code-review-job-ids <value>
--agent-space-id <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

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

The list of code review job identifiers to retrieve.

(string)

Syntax:

"string" "string" ...

--agent-space-id (string)

The unique identifier of the agent space that contains the code review jobs.

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

codeReviewJobs -> (list)

The list of code review jobs that were found.

(structure)

Represents a code review job, which is an execution instance of a code review. A code review job progresses through preflight, static analysis, and finalizing steps.

codeReviewJobId -> (string)

The unique identifier of the code review job.

codeReviewId -> (string)

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

title -> (string)

The title of the code review job.

overview -> (string)

An overview of the code review job results.

status -> (string)

The current status of the code review job.

documents -> (list)

The list of documents providing context for the code review job.

(structure)

Represents a document that provides context for security testing.

s3Location -> (string)

The Amazon S3 location of the document.

artifactId -> (string)

The unique identifier of the artifact associated with the document.

sourceCode -> (list)

The list of source code repositories analyzed during the code review job.

(structure)

Represents a source code repository used for security analysis during a pentest.

s3Location -> (string)

The Amazon S3 location of the source code repository archive.

steps -> (list)

The list of steps in the code review job execution.

(structure)

Represents a step in the pentest job execution pipeline. Steps include preflight, static analysis, pentest, and finalizing.

name -> (string)

The name of the step. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, and FINALIZING.

status -> (string)

The current status of the step.

createdAt -> (timestamp)

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

updatedAt -> (timestamp)

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

executionContext -> (list)

The execution context messages for the code review job.

(structure)

Contains contextual information about the execution of a pentest job, such as errors, warnings, or informational messages.

contextType -> (string)

The type of context. Valid values include ERROR, CLIENT_ERROR, WARNING, and INFO.

context -> (string)

The context message.

timestamp -> (timestamp)

The date and time the context was recorded, in UTC format.

serviceRole -> (string)

The IAM service role used for the code review job.

logConfig -> (structure)

The CloudWatch Logs configuration for the code review job.

logGroup -> (string)

The name of the CloudWatch log group.

logStream -> (string)

The name of the CloudWatch log stream.

errorInformation -> (structure)

Error information if the code review job encountered an error.

code -> (string)

The error code. Valid values include CLIENT_ERROR, INTERNAL_ERROR, and STOPPED_BY_USER.

message -> (string)

A message describing the error.

integratedRepositories -> (list)

The list of integrated repositories associated with the code review job.

(structure)

Represents a code repository that is integrated with the service through a third-party provider.

integrationId -> (string)

The unique identifier of the integration that provides access to the repository.

providerResourceId -> (string)

The provider-specific resource identifier for the repository.

codeRemediationStrategy -> (string)

The code remediation strategy for the code review job.

createdAt -> (timestamp)

The date and time the code review job was created, in UTC format.

updatedAt -> (timestamp)

The date and time the code review job was last updated, in UTC format.

notFound -> (list)

The list of code review job identifiers that were not found.

(string)