create_gateway¶
Operation¶
create_gateway
¶
create_gateway(request: CreateGatewayInput | CreateGatewayInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateGatewayInputDict]) -> CreateGatewayOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateGatewayInput | CreateGatewayInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CreateGatewayInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateGatewayOutput
|
An instance of |
create_gateway
async
¶
create_gateway(request: CreateGatewayInput | CreateGatewayInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateGatewayInputDict]) -> CreateGatewayOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateGatewayInput | CreateGatewayInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CreateGatewayInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateGatewayOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
CreateGatewayInputDict
¶
Bases: TypedDict
Dictionary form of CreateGatewayInput.
Attributes¶
authorizer_configuration
instance-attribute
¶
authorizer_configuration: AuthorizerConfiguration | AuthorizerConfigurationDict | None
The authorizer configuration for the gateway. Required if
authorizerType is CUSTOM_JWT.
authorizer_type
instance-attribute
¶
The type of authorizer to use for the gateway.
-
CUSTOM_JWT- Authorize with a bearer token. -
AWS_IAM- Authorize with your Amazon Web Services IAM credentials. -
NONE- No authorization
client_token
instance-attribute
¶
client_token: str | None
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 Ensuring idempotency.
This field is autopopulated if not provided.
domain_override
instance-attribute
¶
domain_override: DomainOverride | DomainOverrideDict | None
The public domain names that the gateway advertises in its OAuth discovery URLs instead of the inbound Host header. Specify this when clients reach the gateway through your own proxy or custom domain.
exception_level
instance-attribute
¶
exception_level: str | None
The level of detail in error messages returned when invoking the gateway.
-
If the value is
DEBUG, granular exception messages are returned to help a user debug the gateway. -
If the value is omitted, a generic error message is returned to the end user.
interceptor_configurations
instance-attribute
¶
interceptor_configurations: Sequence[GatewayInterceptorConfiguration | GatewayInterceptorConfigurationDict] | None
A list of configuration settings for a gateway interceptor. Gateway interceptors allow custom code to be invoked during gateway invocations.
kms_key_arn
instance-attribute
¶
kms_key_arn: str | None
The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.
name
instance-attribute
¶
The name of the gateway. The name must be unique within your account.
policy_engine_configuration
instance-attribute
¶
policy_engine_configuration: GatewayPolicyEngineConfiguration | GatewayPolicyEngineConfigurationDict | None
The policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.
protocol_configuration
instance-attribute
¶
protocol_configuration: GatewayProtocolConfiguration | GatewayProtocolConfigurationDict | None
The configuration settings for the protocol specified in the
protocolType parameter.
role_arn
instance-attribute
¶
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the gateway to access Amazon Web Services services.
CreateGatewayInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateGatewayInput structure.
Attributes¶
authorizer_configuration
class-attribute
instance-attribute
¶
authorizer_configuration: AuthorizerConfiguration | None = ...
The authorizer configuration for the gateway. Required if
authorizerType is CUSTOM_JWT.
authorizer_type
class-attribute
instance-attribute
¶
authorizer_type: str | None = ...
The type of authorizer to use for the gateway.
-
CUSTOM_JWT- Authorize with a bearer token. -
AWS_IAM- Authorize with your Amazon Web Services IAM credentials. -
NONE- No authorization
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
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 Ensuring idempotency.
This field is autopopulated if not provided.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description of the gateway.
domain_override
class-attribute
instance-attribute
¶
domain_override: DomainOverride | None = ...
The public domain names that the gateway advertises in its OAuth discovery URLs instead of the inbound Host header. Specify this when clients reach the gateway through your own proxy or custom domain.
exception_level
class-attribute
instance-attribute
¶
exception_level: str | None = ...
The level of detail in error messages returned when invoking the gateway.
-
If the value is
DEBUG, granular exception messages are returned to help a user debug the gateway. -
If the value is omitted, a generic error message is returned to the end user.
interceptor_configurations
class-attribute
instance-attribute
¶
interceptor_configurations: list[GatewayInterceptorConfiguration] | None = ...
A list of configuration settings for a gateway interceptor. Gateway interceptors allow custom code to be invoked during gateway invocations.
kms_key_arn
class-attribute
instance-attribute
¶
kms_key_arn: str | None = ...
The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.
name
class-attribute
instance-attribute
¶
name: str | None = ...
The name of the gateway. The name must be unique within your account.
policy_engine_configuration
class-attribute
instance-attribute
¶
policy_engine_configuration: GatewayPolicyEngineConfiguration | None = ...
The policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.
protocol_configuration
class-attribute
instance-attribute
¶
protocol_configuration: GatewayProtocolConfiguration | None = ...
The configuration settings for the protocol specified in the
protocolType parameter.
protocol_type
class-attribute
instance-attribute
¶
protocol_type: str = ...
The protocol type for the gateway.
Output¶
CreateGatewayOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateGatewayOutput structure.
Attributes¶
authorizer_configuration
class-attribute
instance-attribute
¶
authorizer_configuration: AuthorizerConfiguration | None = ...
The authorizer configuration for the created gateway.
authorizer_type
instance-attribute
¶
authorizer_type: str
The type of authorizer used by the gateway.
custom_transform_configuration
class-attribute
instance-attribute
¶
custom_transform_configuration: CustomTransformConfiguration | None = ...
The custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description of the gateway.
domain_override
class-attribute
instance-attribute
¶
domain_override: DomainOverride | None = ...
The public domain names that the gateway advertises in its OAuth discovery URLs instead of the inbound Host header.
exception_level
class-attribute
instance-attribute
¶
exception_level: str | None = ...
The level of detail in error messages returned when invoking the gateway.
-
If the value is
DEBUG, granular exception messages are returned to help a user debug the gateway. -
If the value is omitted, a generic error message is returned to the end user.
gateway_arn
instance-attribute
¶
gateway_arn: str
The Amazon Resource Name (ARN) of the created gateway.
gateway_url
class-attribute
instance-attribute
¶
gateway_url: str | None = ...
The URL endpoint for the created gateway.
interceptor_configurations
class-attribute
instance-attribute
¶
interceptor_configurations: list[GatewayInterceptorConfiguration] | None = ...
The list of interceptor configurations for the created gateway.
kms_key_arn
class-attribute
instance-attribute
¶
kms_key_arn: str | None = ...
The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.
policy_engine_configuration
class-attribute
instance-attribute
¶
policy_engine_configuration: GatewayPolicyEngineConfiguration | None = ...
The policy engine configuration for the created gateway.
protocol_configuration
class-attribute
instance-attribute
¶
protocol_configuration: GatewayProtocolConfiguration | None = ...
The configuration settings for the protocol used by the gateway.
protocol_type
class-attribute
instance-attribute
¶
protocol_type: str = ...
The protocol type of the gateway.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
role_arn
class-attribute
instance-attribute
¶
role_arn: str | None = ...
The Amazon Resource Name (ARN) of the IAM role associated with the gateway.
status_reasons
class-attribute
instance-attribute
¶
The reasons for the current status of the gateway.
updated_at
instance-attribute
¶
updated_at: datetime
The timestamp when the gateway was last updated.
waf_configuration
class-attribute
instance-attribute
¶
waf_configuration: WafConfiguration | None = ...
The Amazon Web Services WAF configuration for the gateway.
web_acl_arn
class-attribute
instance-attribute
¶
web_acl_arn: str | None = ...
The Amazon Resource Name (ARN) of the Amazon Web Services WAF web ACL associated with the gateway.
workload_identity_details
class-attribute
instance-attribute
¶
workload_identity_details: WorkloadIdentityDetails | None = ...
The workload identity details for the created gateway.