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 ]

update-agent-space

Description

Updates an agent space record

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

--name (string)

Name of the agent space

--description (string)

Description of the agent space

--aws-resources (structure)

AWS resource configurations associated with the agent space

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

JSON Syntax:

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

--target-domain-ids (list)

Target domain IDs to associate with the agent space

(string)

Syntax:

"string" "string" ...

--code-review-settings (structure)

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

controlsScanning -> (boolean)

Whether Controls are utilized for code review analysis

generalPurposeScanning -> (boolean)

Whether general purpose analysis is performed for code review

Shorthand Syntax:

controlsScanning=boolean,generalPurposeScanning=boolean

JSON Syntax:

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

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

agentSpaceId -> (string)

Unique identifier of the agent space

name -> (string)

Name of the agent space

description -> (string)

Description of the agent space

awsResources -> (structure)

AWS resource configurations associated with the agent space

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)

Whether Controls are utilized for code review analysis

generalPurposeScanning -> (boolean)

Whether general purpose analysis is performed for code review

createdAt -> (timestamp)

Timestamp when the agent space was created

updatedAt -> (timestamp)

Timestamp when the agent space was last updated