Sign in

v1

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

Retrieves information about a specific Gateway.

get/gateways/{gatewayIdentifier}/

Path parameters

gatewayIdentifierstring required

The identifier of the gateway to retrieve.

Response

Success

gatewayArnstring required

The Amazon Resource Name (ARN) of the gateway.

gatewayIdstring required

The unique identifier of the gateway.

gatewayUrlstring

An endpoint for invoking 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 gateway.

statusReasonsStatusReason[]

The reasons for the current status of the gateway.

namestring required

The name of the gateway.

descriptionstring password

The description of the gateway.

roleArnstring

The IAM role ARN that provides permissions for the gateway.

protocolType'MCP'

Protocol applied to a gateway.

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

Authorizer type for the gateway.

kmsKeyArnstring

The Amazon Resource Name (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.