batch-get-pentest-jobs¶

Description¶

Retrieves multiple pentest jobs in a single request

Synopsis¶

  batch-get-pentest-jobs
--pentest-job-ids <value>
--agent-space-id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--pentest-job-ids (list) [required]

List of pentest job IDs to retrieve

(string)

Syntax:

"string" "string" ...

--agent-space-id (string) [required]

ID of the agent space where the pentest exists

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

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

Possible values:

IN_PROGRESS

STOPPING

STOPPED

FAILED

COMPLETED

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

Possible values:

SECRETS_MANAGER

AWS_LAMBDA

AWS_IAM_ROLE

AWS_INTERNAL

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

Possible values:

CROSS_SITE_SCRIPTING

DEFAULT_CREDENTIALS

INSECURE_DIRECT_OBJECT_REFERENCE

PRIVILEGE_ESCALATION

SERVER_SIDE_TEMPLATE_INJECTION

COMMAND_INJECTION

CODE_INJECTION

SQL_INJECTION

ARBITRARY_FILE_UPLOAD

INSECURE_DESERIALIZATION

LOCAL_FILE_INCLUSION

INFORMATION_DISCLOSURE

PATH_TRAVERSAL

SERVER_SIDE_REQUEST_FORGERY

JSON_WEB_TOKEN_VULNERABILITIES

XML_EXTERNAL_ENTITY

FILE_DELETION

OTHER

GRAPHQL_VULNERABILITIES

BUSINESS_LOGIC_VULNERABILITIES

CRYPTOGRAPHIC_VULNERABILITIES

DENIAL_OF_SERVICE

FILE_ACCESS

FILE_CREATION

DATABASE_MODIFICATION

DATABASE_ACCESS

OUTBOUND_SERVICE_REQUEST

UNKNOWN

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

Possible values:

PREFLIGHT

STATIC_ANALYSIS

PENTEST

FINALIZING

status -> (string)

Current status of the step

Possible values:

NOT_STARTED

IN_PROGRESS

COMPLETED

FAILED

STOPPED

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

Possible values:

ERROR

CLIENT_ERROR

WARNING

INFO

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

Possible values:

ALLOW

DENY

pattern -> (string)

Pattern to match against

networkTrafficRuleType -> (string)

Type of network traffic rule

Possible values:

URL

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

Possible values:

CLIENT_ERROR

INTERNAL_ERROR

STOPPED_BY_USER

message -> (string)

Pentest job failure error message

integratedRepositories -> (list)

List of integrated code repositories

(structure)

Information about an integrated repository

integrationId -> (string) [required]

Integration identifier

providerResourceId -> (string) [required]

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

codeRemediationStrategy -> (string)

Strategy for code remediation on findings

Possible values:

AUTOMATIC

DISABLED

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)

Table of Contents

Feedback

User Guide