AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . bedrock-agentcore-control ]

update-agent-runtime

Description

Updates an existing Amazon Secure Agent.

See also: AWS API Documentation

Synopsis

  update-agent-runtime
--agent-runtime-id <value>
[--description <value>]
--agent-runtime-artifact <value>
--role-arn <value>
--network-configuration <value>
[--protocol-configuration <value>]
[--client-token <value>]
[--environment-variables <value>]
[--authorizer-configuration <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>]

Options

--agent-runtime-id (string)

The unique identifier of the agent runtime to update.

--description (string)

The updated description of the agent runtime.

--agent-runtime-artifact (tagged union structure)

The updated artifact of the agent runtime.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: containerConfiguration.

containerConfiguration -> (structure)

The container configuration for the agent artifact.

containerUri -> (string)

The ECR URI of the container.

Shorthand Syntax:

containerConfiguration={containerUri=string}

JSON Syntax:

{
  "containerConfiguration": {
    "containerUri": "string"
  }
}

--role-arn (string)

The updated IAM role ARN that provides permissions for the agent runtime.

--network-configuration (structure)

The updated network configuration for the agent runtime.

networkMode -> (string)

The network mode for the agent runtime.

Shorthand Syntax:

networkMode=string

JSON Syntax:

{
  "networkMode": "PUBLIC"
}

--protocol-configuration (structure)

The protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.

serverProtocol -> (string)

The server protocol for the agent runtime. This field specifies which protocol the agent runtime uses to communicate with clients.

Shorthand Syntax:

serverProtocol=string

JSON Syntax:

{
  "serverProtocol": "MCP"|"HTTP"
}

--client-token (string)

A unique, case-sensitive identifier to ensure idempotency of the request.

--environment-variables (map)

Updated environment variables to set in the agent runtime environment.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--authorizer-configuration (tagged union structure)

The updated authorizer configuration for the agent runtime.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: customJWTAuthorizer.

customJWTAuthorizer -> (structure)

The inbound JWT-based authorization, specifying how incoming requests should be authenticated.

discoveryUrl -> (string)

This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.

allowedAudience -> (list)

Represents individual audience values that are validated in the incoming JWT token validation process.

(string)

allowedClients -> (list)

Represents individual client IDs that are validated in the incoming JWT token validation process.

(string)

Shorthand Syntax:

customJWTAuthorizer={discoveryUrl=string,allowedAudience=[string,string],allowedClients=[string,string]}

JSON Syntax:

{
  "customJWTAuthorizer": {
    "discoveryUrl": "string",
    "allowedAudience": ["string", ...],
    "allowedClients": ["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.

Output

agentRuntimeArn -> (string)

The Amazon Resource Name (ARN) of the updated agent runtime.

agentRuntimeId -> (string)

The unique identifier of the updated agent runtime.

workloadIdentityDetails -> (structure)

The workload identity details for the updated agent runtime.

workloadIdentityArn -> (string)

The ARN associated with the workload identity.

agentRuntimeVersion -> (string)

The version of the updated agent runtime.

createdAt -> (timestamp)

The timestamp when the agent runtime was created.

lastUpdatedAt -> (timestamp)

The timestamp when the agent runtime was last updated.

status -> (string)

The current status of the updated agent runtime.