Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateGateway

Updates an existing Gateway.

Request Syntax


PUT /gateways/gatewayIdentifier/ HTTP/1.1
Content-type: application/json

{
   "authorizerConfiguration": { ... },
   "authorizerType": "string",
   "description": "string",
   "exceptionLevel": "string",
   "kmsKeyArn": "string",
   "name": "string",
   "protocolConfiguration": { ... },
   "protocolType": "string",
   "roleArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

gatewayIdentifier

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

Pattern: ([0-9a-z][-]?){1,100}-[0-9a-z]{10}

Required: Yes

Request Body

The request accepts the following data in JSON format.

authorizerConfiguration

The updated authorizer configuration for the Gateway.

Type: AuthorizerConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

authorizerType

The updated authorizer type for the Gateway.

Type: String

Valid Values: CUSTOM_JWT

Required: Yes

description

The updated description for the Gateway.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: No

exceptionLevel

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.

Type: String

Valid Values: DEBUG

Required: No

kmsKeyArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}

Required: No

name

The updated name for the Gateway.

Type: String

Pattern: ([0-9a-zA-Z][-]?){1,100}

Required: Yes

protocolConfiguration

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

Type: GatewayProtocolConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

protocolType

The updated protocol type for the Gateway.

Type: String

Valid Values: MCP

Required: Yes

roleArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+

Required: Yes

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "authorizerConfiguration": { ... },
   "authorizerType": "string",
   "createdAt": "string",
   "description": "string",
   "exceptionLevel": "string",
   "gatewayArn": "string",
   "gatewayId": "string",
   "gatewayUrl": "string",
   "kmsKeyArn": "string",
   "name": "string",
   "protocolConfiguration": { ... },
   "protocolType": "string",
   "roleArn": "string",
   "status": "string",
   "statusReasons": [ "string" ],
   "updatedAt": "string",
   "workloadIdentityDetails": { 
      "workloadIdentityArn": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

authorizerConfiguration

The updated authorizer configuration for the Gateway.

Type: AuthorizerConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

authorizerType

The updated authorizer type for the Gateway.

Type: String

Valid Values: CUSTOM_JWT

createdAt

The timestamp when the Gateway was created.

Type: Timestamp

description

The updated description of the Gateway.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

exceptionLevel

Type: String

Valid Values: DEBUG

gatewayArn

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

Type: String

Pattern: arn:aws(|-cn|-us-gov):bedrock-agentcore:[a-z0-9-]{1,20}:[0-9]{12}:gateway/[0-9a-zA-Z]{10}

gatewayId

The unique identifier of the updated Gateway.

Type: String

Pattern: ([0-9a-z][-]?){1,100}-[0-9a-z]{10}

gatewayUrl

An endpoint for invoking the updated Gateway.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

kmsKeyArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}

name

The updated name of the Gateway.

Type: String

Pattern: ([0-9a-zA-Z][-]?){1,100}

protocolConfiguration

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

Type: GatewayProtocolConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

protocolType

The updated protocol type for the Gateway.

Type: String

Valid Values: MCP

roleArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+

status

The current status of the updated Gateway.

Type: String

statusReasons

The reasons for the current status of the updated Gateway.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 0. Maximum length of 2048.

updatedAt

The timestamp when the Gateway was last updated.

Type: Timestamp

workloadIdentityDetails

The workload identity details for the updated Gateway.

Type: WorkloadIdentityDetails object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

This exception is thrown when a request is denied per access permissions

HTTP Status Code: 403

ConflictException

This exception is thrown when there is a conflict performing an operation

HTTP Status Code: 409

InternalServerException

This exception is thrown if there was an unexpected error during processing of request

HTTP Status Code: 500

ResourceNotFoundException

This exception is thrown when a resource referenced by the operation does not exist

HTTP Status Code: 404

ServiceQuotaExceededException

This exception is thrown when a request is made beyond the service quota

HTTP Status Code: 402

ThrottlingException

This exception is thrown when the number of requests exceeds the limit

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

HTTP Status Code: 400