Sign in

v1

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

Creates a gateway for Amazon Bedrock Agent. A gateway serves as an integration point between your agent and external services.

If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.

post/gateways/

Request body

namestring required

The name of the gateway. The name must be unique within your account.

descriptionstring password

The description of the gateway.

clientTokenstring

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.

roleArnstring required

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the gateway to access Amazon Web Services services.

protocolType'MCP'

The protocol type for the gateway.

authorizerType'CUSTOM_JWT' | 'AWS_IAM' | 'NONE' | 'AUTHENTICATE_ONLY' required
<p>The type of authorizer to use for the gateway.</p> <ul> <li> <p> <code>CUSTOM_JWT</code> - Authorize with a bearer token.</p> </li> <li> <p> <code>AWS_IAM</code> - Authorize with your Amazon Web Services IAM credentials.</p> </li> <li> <p> <code>NONE</code> - No authorization</p> </li> </ul>
kmsKeyArnstring

The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with 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>
tagsobject

A map of key-value pairs to associate with the gateway as metadata tags.

Response

Success

gatewayArnstring required

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

gatewayIdstring required

The unique identifier of the created gateway.

gatewayUrlstring

The URL endpoint for the created 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 Amazon Resource Name (ARN) of the IAM role associated with the gateway.

protocolType'MCP'

The protocol type of the gateway.

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

The type of authorizer used by the gateway.

kmsKeyArnstring

The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with 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.