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-agent-spaces¶
Synopsis¶
batch-get-agent-spaces
--agent-space-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-ids (list)
The list of agent space identifiers to retrieve.
(string)
Unique identifier of the agent space.
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¶
agentSpaces -> (list)
The list of agent spaces that were found.
(structure)
Represents an agent space, which is a dedicated workspace for securing a specific application. An agent space contains the configuration, resources, and settings needed for security testing.
agentSpaceId -> (string)
The unique identifier of the agent space.name -> (string)
The name of the agent space.description -> (string)
A description of the agent space.awsResources -> (structure)
The AWS resources associated with the agent space.
vpcs -> (list)
The VPC configurations associated with the agent space.
(structure)
The VPC configuration for a pentest, specifying the VPC, security groups, and subnets to use during testing.
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.logGroups -> (list)
The Amazon Resource Names (ARNs) of the CloudWatch log groups associated with the agent space.
(string)
Log group ARN or name for agent space AWS resources.s3Buckets -> (list)
The Amazon Resource Names (ARNs) of the S3 buckets associated with the agent space.
(string)
S3 bucket ARN or name for agent space AWS resources.secretArns -> (list)
The Amazon Resource Names (ARNs) of the Secrets Manager secrets associated with the agent space.
(string)
Secret ARN or name for agent space AWS resources.lambdaFunctionArns -> (list)
The Amazon Resource Names (ARNs) of the Lambda functions associated with the agent space.
(string)
Lambda function ARN or name for agent space AWS resources.iamRoles -> (list)
The IAM roles associated with the agent space.
(string)
ARN of an IAM role that the service can assume to access customer resources.targetDomainIds -> (list)
The list of target domain identifiers associated with the agent space.
(string)
codeReviewSettings -> (structure)
The code review settings for the agent space.
controlsScanning -> (boolean)
Indicates whether controls scanning is enabled for code reviews.generalPurposeScanning -> (boolean)
Indicates whether general-purpose scanning is enabled for code reviews.kmsKeyId -> (string)
The identifier of the AWS KMS key used to encrypt data in the agent space.createdAt -> (timestamp)
The date and time the agent space was created, in UTC format.updatedAt -> (timestamp)
The date and time the agent space was last updated, in UTC format.
notFound -> (list)
The list of agent space identifiers that were not found.
(string)
Unique identifier of the agent space.