[ aws . securityagent ]

batch-get-agent-spaces

Description

Retrieves multiple agent spaces in a single request

See also: AWS API Documentation

Synopsis

  batch-get-agent-spaces
--agent-space-ids <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

--agent-space-ids (list) [required]

List of agent space IDs to retrieve

(string)

Unique identifier of the agent space

Syntax:

"string" "string" ...

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

agentSpaces -> (list)

List of agent spaces that were successfully retrieved

(structure)

Agent space structure

agentSpaceId -> (string) [required]

Unique identifier of the agent space

name -> (string) [required]

Name of the agent space

description -> (string)

Description of the agent space

awsResources -> (structure)

AWS resource configurations

vpcs -> (list)

VPC configurations that the Security Agent accesses in the customer environment

(structure)

Customer 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

logGroups -> (list)

CloudWatch log group ARNs or names used to store Security Agent logs

(string)

Log group ARN or name for agent space AWS resources

s3Buckets -> (list)

S3 bucket ARNs or names used to store Security Agent artifacts

(string)

S3 bucket ARN or name for agent space AWS resources

secretArns -> (list)

SecretsManager secret ARNs or names used to store tester credentials for pentests

(string)

Secret ARN or name for agent space AWS resources

lambdaFunctionArns -> (list)

Lambda function ARNs or names used to retrieve tester credentials for pentests

(string)

Lambda function ARN or name for agent space AWS resources

iamRoles -> (list)

IAM role ARNs that the Security Agent can assume to access customer resources

(string)

ARN of an IAM role that the service can assume to access customer resources

targetDomainIds -> (list)

List of target domain IDs registered with the agent space

(string)

codeReviewSettings -> (structure)

Configuration for code review analysis, including controls scanning and general purpose scanning settings

controlsScanning -> (boolean) [required]

Whether Controls are utilized for code review analysis

generalPurposeScanning -> (boolean) [required]

Whether general purpose analysis is performed for code review

kmsKeyId -> (string)

Identifier of the KMS key used to encrypt data. Can be a key ID, key ARN, alias name, or alias ARN. If not specified, an AWS managed key is used.

createdAt -> (timestamp)

Timestamp when the agent space was created

updatedAt -> (timestamp)

Timestamp when the agent space was last updated

notFound -> (list)

List of agent space IDs that could not be found

(string)

Unique identifier of the agent space