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

Description

Retrieves multiple pentest jobs in a single request

See also: AWS API Documentation

Synopsis

  batch-get-pentest-jobs
--pentest-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

--pentest-job-ids (list)

List of pentest job IDs to retrieve

(string)

Syntax:

"string" "string" ...

--agent-space-id (string)

ID of the agent space where the pentest exists

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

pentestJobs -> (list)

List of successfully retrieved pentest jobs

(structure)

Represents a pentest job

pentestJobId -> (string)

Unique identifier of the pentest job

pentestId -> (string)

Identifier of the parent pentest

title -> (string)

Title or name of the pentest

overview -> (string)

Overview or description of the pentest job

status -> (string)

Current status of the pentest job

endpoints -> (list)

List of web application endpoints to test

(structure)

Represents a web application endpoint to be tested

uri -> (string)

URI of the endpoint to test

actors -> (list)

List of actors that interact with the system

(structure)

Represents an entity that interacts with the system during security testing

identifier -> (string)

Unique identifier for the actor (case-insensitive)

uris -> (list)

List of URIs accessible with the actor’s credentials

(string)

authentication -> (structure)

Authentication information used by the actor to access resources

providerType -> (string)

Provider type for the authentication credentials

value -> (string)

Authentication credential value or reference

description -> (string)

Additional description or details about the actor

documents -> (list)

List of documents providing context for testing

(structure)

Information about a document relevant to security testing

s3Location -> (string)

S3 storage location of the document

artifactId -> (string)

Artifact ID of the document

sourceCode -> (list)

List of source code repositories for static analysis

(structure)

Information about a source code repository for static analysis

s3Location -> (string)

S3 storage location of the repository

excludePaths -> (list)

List of URL paths to exclude from testing

(structure)

Represents a web application endpoint to be tested

uri -> (string)

URI of the endpoint to test

allowedDomains -> (list)

List of allowed domains for network access

(structure)

Represents a web application endpoint to be tested

uri -> (string)

URI of the endpoint to test

excludeRiskTypes -> (list)

A list of risk types excluded from the pentest job

(string)

Type of security risk

steps -> (list)

List of execution steps for the pentest job

(structure)

Represents a single step in pentest job execution

name -> (string)

Name of the execution step

status -> (string)

Current status of the step

createdAt -> (timestamp)

Timestamp when the step was created

updatedAt -> (timestamp)

Timestamp when the step was last updated

executionContext -> (list)

A list of execution context messages associated with the pentest job

(structure)

Additional context about a pentest or task execution

contextType -> (string)

The category of context

context -> (string)

Context associated with a pentest or task execution

timestamp -> (timestamp)

Timestamp associated with a pentest or task execution

serviceRole -> (string)

Service role ARN for accessing customer resources

logConfig -> (structure)

CloudWatch log group and stream prefix where pentest job logs are stored

logGroup -> (string)

Name of the CloudWatch log group

logStream -> (string)

Name of the CloudWatch log stream

vpcConfig -> (structure)

VPC configuration that the Security Agent accesses

vpcArn -> (string)

ARN or ID of the customer VPC

securityGroupArns -> (list)

List of security group ARNs or IDs in the customer VPC

(string)

ARN or ID of a security group

subnetArns -> (list)

List of subnet ARNs or IDs in the customer VPC

(string)

ARN or ID of a subnet

networkTrafficConfig -> (structure)

Configuration for network traffic filtering

rules -> (list)

Traffic filtering rules

(structure)

Network traffic filtering rule

effect -> (string)

Action to take when the rule matches

pattern -> (string)

Pattern to match against

networkTrafficRuleType -> (string)

Type of network traffic rule

customHeaders -> (list)

Custom headers for requests

(structure)

Custom headers to be set for network requests

name -> (string)

Name of header to set value for

value -> (string)

Value to set for header

errorInformation -> (structure)

Error information regarding the pentest job

code -> (string)

Pentest job failure error code

message -> (string)

Pentest job failure error message

integratedRepositories -> (list)

List of integrated code repositories

(structure)

Information about an integrated repository

integrationId -> (string)

Integration identifier

providerResourceId -> (string)

External provider resource identifier, e.g., Github repository identifier

codeRemediationStrategy -> (string)

Strategy for code remediation on findings

createdAt -> (timestamp)

Timestamp when the pentest job was created

updatedAt -> (timestamp)

Timestamp when the pentest job was last updated

notFound -> (list)

List of pentest job IDs that could not be found

(string)