AWS CLI Command Reference

[ aws . securityagent ]

update-agent-space

Description

Updates the configuration of an existing agent space, including its name, description, AWS resources, target domains, and code review settings.

See also: AWS API Documentation

Synopsis

  update-agent-space
--agent-space-id <value>
[--name <value>]
[--description <value>]
[--aws-resources <value>]
[--target-domain-ids <value>]
[--code-review-settings <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-id (string) [required]

The unique identifier of the agent space to update.

--name (string)

The updated name of the agent space.

--description (string)

The updated description of the agent space.

--aws-resources (structure)

The updated AWS resources to associate 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.

JSON Syntax:

{
  "vpcs": [
    {
      "vpcArn": "string",
      "securityGroupArns": ["string", ...],
      "subnetArns": ["string", ...]
    }
    ...
  ],
  "logGroups": ["string", ...],
  "s3Buckets": ["string", ...],
  "secretArns": ["string", ...],
  "lambdaFunctionArns": ["string", ...],
  "iamRoles": ["string", ...]
}

--target-domain-ids (list)

The updated list of target domain identifiers to associate with the agent space.

(string)

Syntax:

"string" "string" ...

--code-review-settings (structure)

The updated code review settings for the agent space.

controlsScanning -> (boolean) [required]

Indicates whether controls scanning is enabled for code reviews.

generalPurposeScanning -> (boolean) [required]

Indicates whether general-purpose scanning is enabled for code reviews.

Shorthand Syntax:

controlsScanning=boolean,generalPurposeScanning=boolean

JSON Syntax:

{
  "controlsScanning": true|false,
  "generalPurposeScanning": true|false
}

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

agentSpaceId -> (string)

The unique identifier of the updated agent space.

name -> (string)

The name of the agent space.

description -> (string)

The 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) [required]

Indicates whether controls scanning is enabled for code reviews.

generalPurposeScanning -> (boolean) [required]

Indicates whether general-purpose scanning is enabled for code reviews.

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.
© Copyright 2026, Amazon Web Services. Created using Sphinx.