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 information about one or more pentest jobs in an agent space.

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)

The list of pentest job identifiers to retrieve.

(string)

Syntax:

"string" "string" ...

--agent-space-id (string)

The unique identifier of the agent space that contains the pentest 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

pentestJobs -> (list)

The list of pentest jobs that were found.

(structure)

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

pentestJobId -> (string)

The unique identifier of the pentest job.

pentestId -> (string)

The unique identifier of the pentest associated with the job.

title -> (string)

The title of the pentest job.

overview -> (string)

An overview of the pentest job results.

status -> (string)

The current status of the pentest job.

endpoints -> (list)

The list of endpoints being tested in the pentest job.

(structure)

Represents a target endpoint for penetration testing.

uri -> (string)

The URI of the endpoint.

actors -> (list)

The list of actors used during the pentest job.

(structure)

Represents an actor used during penetration testing. An actor defines a user or entity that interacts with the target application, including authentication credentials and target URIs.

identifier -> (string)

The unique identifier for the actor.

uris -> (list)

The list of URIs that the actor targets during testing.

(string)

authentication -> (structure)

The authentication configuration for the actor.

providerType -> (string)

The type of authentication provider. Valid values include SECRETS_MANAGER, AWS_LAMBDA, AWS_IAM_ROLE, and AWS_INTERNAL.

value -> (string)

The authentication value, such as a secret ARN, Lambda function ARN, or IAM role ARN, depending on the provider type.

description -> (string)

A description of the actor.

documents -> (list)

The list of documents providing context for the pentest 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 pentest 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.

excludePaths -> (list)

The list of paths excluded from the pentest job.

(structure)

Represents a target endpoint for penetration testing.

uri -> (string)

The URI of the endpoint.

allowedDomains -> (list)

The list of domains allowed during the pentest job.

(structure)

Represents a target endpoint for penetration testing.

uri -> (string)

The URI of the endpoint.

excludeRiskTypes -> (list)

The list of risk types excluded from the pentest job.

(string)

Type of security risk.

steps -> (list)

The list of steps in the pentest 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 pentest 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 pentest job.

logConfig -> (structure)

The CloudWatch Logs configuration for the pentest job.

logGroup -> (string)

The name of the CloudWatch log group.

logStream -> (string)

The name of the CloudWatch log stream.

vpcConfig -> (structure)

The VPC configuration for the pentest job.

vpcArn -> (string)

The Amazon Resource Name (ARN) of the VPC.

securityGroupArns -> (list)

The Amazon Resource Names (ARNs) of the security groups for the VPC configuration.

(string)

ARN or ID of a security group.

subnetArns -> (list)

The Amazon Resource Names (ARNs) of the subnets for the VPC configuration.

(string)

ARN or ID of a subnet.

networkTrafficConfig -> (structure)

The network traffic configuration for the pentest job.

rules -> (list)

The list of network traffic rules that control which URLs are allowed or denied during testing.

(structure)

A rule that controls network traffic during penetration testing by allowing or denying traffic to specific URL patterns.

effect -> (string)

The effect of the rule. Valid values are ALLOW and DENY.

pattern -> (string)

The URL pattern to match for the rule.

networkTrafficRuleType -> (string)

The type of the network traffic rule. Currently, only URL is supported.

customHeaders -> (list)

The list of custom HTTP headers to include in network traffic during testing.

(structure)

A custom HTTP header to include in network traffic during penetration testing.

name -> (string)

The name of the custom header.

value -> (string)

The value of the custom header.

errorInformation -> (structure)

Error information if the pentest 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 pentest 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 pentest job.

createdAt -> (timestamp)

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

updatedAt -> (timestamp)

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

notFound -> (list)

The list of pentest job identifiers that were not found.

(string)