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

Description

Retrieves multiple tasks for a pentest job in a single request

See also: AWS API Documentation

Synopsis

  batch-get-pentest-job-tasks
--agent-space-id <value>
--task-ids <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

--agent-space-id (string)

ID of the agent space where the pentest exists

--task-ids (list)

List of task IDs to retrieve

(string)

Syntax:

"string" "string" ...

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

tasks -> (list)

List of successfully retrieved tasks

(structure)

Represents a task within a pentest job

taskId -> (string)

Unique identifier for the task

pentestId -> (string)

Identifier of the parent pentest

pentestJobId -> (string)

Identifier of the pentest job this task belongs to

agentSpaceId -> (string)

Identifier of the agent space this task belongs to

title -> (string)

Title or name of the task

description -> (string)

Detailed description of the task’s purpose and scope

categories -> (list)

List of categories associated with this task

(structure)

Represents a category classification for tasks

name -> (string)

Name of the category

isPrimary -> (boolean)

Whether this is the primary category for the task

riskType -> (string)

Type of security risk this task is designed to test

targetEndpoint -> (structure)

Target endpoint for this security test

uri -> (string)

URI of the endpoint to test

executionStatus -> (string)

Current status of the task execution

logsLocation -> (structure)

Location of execution logs for auditing and review

logType -> (string)

Type of log storage

cloudWatchLog -> (structure)

CloudWatch log information if logs are stored in CloudWatch

logGroup -> (string)

Name of the CloudWatch log group

logStream -> (string)

Name of the CloudWatch log stream

createdAt -> (timestamp)

Timestamp when the task was created

updatedAt -> (timestamp)

Timestamp when the task was last updated

notFound -> (list)

List of task IDs that could not be found

(string)