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

Description

Updates an existing Gateway.

See also: AWS API Documentation

Synopsis

  update-gateway
--gateway-identifier <value>
--name <value>
[--description <value>]
--role-arn <value>
--protocol-type <value>
[--protocol-configuration <value>]
--authorizer-type <value>
--authorizer-configuration <value>
[--kms-key-arn <value>]
[--exception-level <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

--gateway-identifier (string)

The identifier of the gateway to update. This can be either the gateway ID or the gateway ARN.

--name (string)

The updated name for the Gateway.

--description (string)

The updated description for the Gateway.

--role-arn (string)

The updated IAM role ARN that provides permissions for the Gateway.

--protocol-type (string)

The updated protocol type for the Gateway.

Possible values:

  • MCP

--protocol-configuration (tagged union structure)

The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.

Note

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

mcp -> (structure)

The configuration for the Model Context Protocol (MCP). This protocol enables communication between Amazon Bedrock Agent and external tools.

supportedVersions -> (list)

The supported versions of the Model Context Protocol. This field specifies which versions of the protocol the gateway can use.

(string)

instructions -> (string)

The instructions for using the Model Context Protocol gateway. These instructions provide guidance on how to interact with the gateway.

searchType -> (string)

The search type for the Model Context Protocol gateway. This field specifies how the gateway handles search operations.

Shorthand Syntax:

mcp={supportedVersions=[string,string],instructions=string,searchType=string}

JSON Syntax:

{
  "mcp": {
    "supportedVersions": ["string", ...],
    "instructions": "string",
    "searchType": "SEMANTIC"
  }
}

--authorizer-type (string)

The updated authorizer type for the Gateway.

Possible values:

  • CUSTOM_JWT

--authorizer-configuration (tagged union structure)

The updated authorizer configuration for the Gateway.

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", ...]
  }
}

--kms-key-arn (string)

The updated ARN of the KMS key used to encrypt the Gateway.

--exception-level (string)

The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.

Possible values:

  • DEBUG

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

gatewayArn -> (string)

The Amazon Resource Name (ARN) of the updated Gateway.

gatewayId -> (string)

The unique identifier of the updated Gateway.

gatewayUrl -> (string)

An endpoint for invoking the updated Gateway.

createdAt -> (timestamp)

The timestamp when the Gateway was created.

updatedAt -> (timestamp)

The timestamp when the Gateway was last updated.

status -> (string)

The current status of the updated Gateway.

statusReasons -> (list)

The reasons for the current status of the updated Gateway.

(string)

name -> (string)

The updated name of the Gateway.

description -> (string)

The updated description of the Gateway.

roleArn -> (string)

The updated IAM role ARN that provides permissions for the Gateway.

protocolType -> (string)

The updated protocol type for the Gateway.

protocolConfiguration -> (tagged union structure)

The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.

Note

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

mcp -> (structure)

The configuration for the Model Context Protocol (MCP). This protocol enables communication between Amazon Bedrock Agent and external tools.

supportedVersions -> (list)

The supported versions of the Model Context Protocol. This field specifies which versions of the protocol the gateway can use.

(string)

instructions -> (string)

The instructions for using the Model Context Protocol gateway. These instructions provide guidance on how to interact with the gateway.

searchType -> (string)

The search type for the Model Context Protocol gateway. This field specifies how the gateway handles search operations.

authorizerType -> (string)

The updated authorizer type for the Gateway.

authorizerConfiguration -> (tagged union structure)

The updated authorizer configuration for the Gateway.

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)

kmsKeyArn -> (string)

The updated ARN of the KMS key used to encrypt the Gateway.

workloadIdentityDetails -> (structure)

The workload identity details for the updated Gateway.

workloadIdentityArn -> (string)

The ARN associated with the workload identity.

exceptionLevel -> (string)

The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.