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

Description

Deletes one or more pentests from an agent space.

See also: AWS API Documentation

Synopsis

  batch-delete-pentests
--pentest-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-ids (list)

The list of pentest identifiers to delete.

(string)

Syntax:

"string" "string" ...

--agent-space-id (string)

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

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

deleted -> (list)

The list of pentests that were successfully deleted.

(structure)

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

pentestId -> (string)

The unique identifier of the pentest.

agentSpaceId -> (string)

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

title -> (string)

The title of the pentest.

assets -> (structure)

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.

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)

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

providerResourceId -> (string)

The provider-specific resource identifier for the repository.

excludeRiskTypes -> (list)

The list of risk types excluded from the pentest.

(string)

Type of security risk.

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.

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.

codeRemediationStrategy -> (string)

The code remediation strategy for the pentest.

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.

failed -> (list)

The list of pentests that failed to delete, including the reason for each failure.

(structure)

Contains information about a pentest that failed to delete.

pentestId -> (string)

The unique identifier of the pentest that failed to delete.

reason -> (string)

The reason the pentest failed to delete.