Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141531,219979.8 KB

Updates an existing gateway.

put/gateways/{gatewayIdentifier}/

Path parameters

gatewayIdentifierstring required

The identifier of the gateway to update.

Request body

namestring required

The name of the gateway. This name must be the same as the one when the gateway was created.

descriptionstring password

The updated description for the gateway.

roleArnstring required

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

protocolType'MCP'

The updated protocol type for the gateway.

authorizerType'CUSTOM_JWT' | 'AWS_IAM' | 'NONE' | 'AUTHENTICATE_ONLY' required

The updated authorizer type for the gateway.

kmsKeyArnstring

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

exceptionLevel'DEBUG'
<p>The level of detail in error messages returned when invoking the gateway.</p> <ul> <li> <p>If the value is <code>DEBUG</code>, granular exception messages are returned to help a user debug the gateway.</p> </li> <li> <p>If the value is omitted, a generic error message is returned to the end user.</p> </li> </ul>

Response

Success

gatewayArnstring required

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

gatewayIdstring required

The unique identifier of the updated gateway.

gatewayUrlstring

An endpoint for invoking the updated gateway.

createdAtstring date-time required

The timestamp when the gateway was created.

updatedAtstring date-time required

The timestamp when the gateway was last updated.

status'CREATING' | 'UPDATING' | 'UPDATE_UNSUCCESSFUL' | 'DELETING' | 'READY' | 'FAILED' required

The current status of the updated gateway.

statusReasonsStatusReason[]

The reasons for the current status of the updated gateway.

namestring required

The name of the gateway.

descriptionstring password

The updated description of the gateway.

roleArnstring

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

protocolType'MCP'

The updated protocol type for the gateway.

authorizerType'CUSTOM_JWT' | 'AWS_IAM' | 'NONE' | 'AUTHENTICATE_ONLY' required

The updated authorizer type for the gateway.

kmsKeyArnstring

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

exceptionLevel'DEBUG'
<p>The level of detail in error messages returned when invoking the gateway.</p> <ul> <li> <p>If the value is <code>DEBUG</code>, granular exception messages are returned to help a user debug the gateway.</p> </li> <li> <p>If the value is omitted, a generic error message is returned to the end user.</p> </li> </ul>
webAclArnstring

The Amazon Resource Name (ARN) of the Amazon Web Services WAF web ACL associated with the gateway.