AWS CLI Command Reference

[ aws . securityagent ]

batch-get-pentests

Description

Retrieves information about one or more pentests in an agent space.

See also: AWS API Documentation

Synopsis

  batch-get-pentests
--pentest-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-ids (list) [required]

The list of pentest identifiers to retrieve.

(string)

Syntax:

"string" "string" ...

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

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

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

pentests -> (list)

The list of pentests that were found.

(structure)

Represents a pentest configuration that defines the parameters for security testing, including target assets, risk type exclusions, and infrastructure settings.

pentestId -> (string) [required]

The unique identifier of the pentest.

agentSpaceId -> (string) [required]

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

title -> (string) [required]

The title of the pentest.

assets -> (structure) [required]

The assets included in the pentest.

endpoints -> (list)

The list of endpoints to test during the pentest.

(structure)

Represents a target endpoint for penetration testing.

uri -> (string)

The URI of the endpoint.

actors -> (list)

The list of actors used during penetration testing.

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

Possible values:

  • SECRETS_MANAGER
  • AWS_LAMBDA
  • AWS_IAM_ROLE
  • 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 that provide context for the pentest.

(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 to analyze during the pentest.

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

integratedRepositories -> (list)

The list of integrated repositories associated with the pentest.

(structure)

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

integrationId -> (string) [required]

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

providerResourceId -> (string) [required]

The provider-specific resource identifier for the repository.

excludeRiskTypes -> (list)

The list of risk types excluded from the pentest.

(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

serviceRole -> (string)

The IAM service role used for the pentest.

logConfig -> (structure)

The CloudWatch Logs configuration for the pentest.

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.

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.

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.

Possible values:

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

Possible values:

  • URL

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.

codeRemediationStrategy -> (string)

The code remediation strategy for the pentest.

Possible values:

  • AUTOMATIC
  • DISABLED

createdAt -> (timestamp)

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

updatedAt -> (timestamp)

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

notFound -> (list)

The list of pentest identifiers that were not found.

(string)

© Copyright 2026, Amazon Web Services. Created using Sphinx.