Bedrock Agentcore Control  >  Operations  >  update_gateway

update_gateway

Operation

update_gateway async

update_gateway(input: UpdateGatewayInput, plugins: list[Plugin] | None = None) -> UpdateGatewayOutput

Updates an existing gateway.

Parameters:

Name	Type	Description	Default
input	UpdateGatewayInput	An instance of UpdateGatewayInput.	required
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

Returns:

Type	Description
UpdateGatewayOutput	An instance of UpdateGatewayOutput.

Input

UpdateGatewayInput dataclass

Dataclass for UpdateGatewayInput structure.

Attributes

authorizer_configuration class-attribute instance-attribute

authorizer_configuration: AuthorizerConfiguration | None = None

The updated authorizer configuration for the gateway.

authorizer_type class-attribute instance-attribute

authorizer_type: AuthorizerType | None = None

The updated authorizer type for the gateway.

custom_transform_configuration class-attribute instance-attribute

custom_transform_configuration: CustomTransformConfiguration | None = None

The updated custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses.

description class-attribute instance-attribute

description: str | None = field(repr=False, default=None)

The updated description for the gateway.

exception_level class-attribute instance-attribute

exception_level: ExceptionLevel | None = 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_identifier class-attribute instance-attribute

gateway_identifier: str | None = None

The identifier of the gateway to update.

interceptor_configurations class-attribute instance-attribute

interceptor_configurations: list[GatewayInterceptorConfiguration] | None = None

The updated interceptor configurations for the gateway.

kms_key_arn class-attribute instance-attribute

kms_key_arn: str | None = None

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

name class-attribute instance-attribute

name: str | None = None

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

policy_engine_configuration class-attribute instance-attribute

policy_engine_configuration: GatewayPolicyEngineConfiguration | None = None

The updated 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 = None

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

protocol_type class-attribute instance-attribute

protocol_type: GatewayProtocolType = GatewayProtocolType('MCP')

The updated protocol type for the gateway.

role_arn class-attribute instance-attribute

role_arn: str | None = None

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

waf_configuration class-attribute instance-attribute

waf_configuration: WafConfiguration | None = None

The updated Amazon Web Services WAF configuration for the gateway.

Output

UpdateGatewayOutput dataclass

Dataclass for UpdateGatewayOutput structure.

Attributes

authorizer_configuration class-attribute instance-attribute

authorizer_configuration: AuthorizerConfiguration | None = None

The updated authorizer configuration for the gateway.

authorizer_type instance-attribute

authorizer_type: AuthorizerType

The updated authorizer type for the gateway.

created_at instance-attribute

created_at: datetime

The timestamp when the gateway was created.

custom_transform_configuration class-attribute instance-attribute

custom_transform_configuration: CustomTransformConfiguration | None = 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 = field(repr=False, default=None)

The updated description of the gateway.

exception_level class-attribute instance-attribute

exception_level: ExceptionLevel | None = 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 updated gateway.

gateway_id instance-attribute

gateway_id: str

The unique identifier of the updated gateway.

gateway_url class-attribute instance-attribute

gateway_url: str | None = None

An endpoint for invoking the updated gateway.

interceptor_configurations class-attribute instance-attribute

interceptor_configurations: list[GatewayInterceptorConfiguration] | None = None

The updated interceptor configurations for the gateway.

kms_key_arn class-attribute instance-attribute

kms_key_arn: str | None = None

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

name instance-attribute

name: str

The name of the gateway.

policy_engine_configuration class-attribute instance-attribute

policy_engine_configuration: GatewayPolicyEngineConfiguration | None = None

The updated policy engine configuration for the gateway.

protocol_configuration class-attribute instance-attribute

protocol_configuration: GatewayProtocolConfiguration | None = None

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

protocol_type class-attribute instance-attribute

protocol_type: GatewayProtocolType = GatewayProtocolType('MCP')

The updated protocol type for the gateway.

role_arn class-attribute instance-attribute

role_arn: str | None = None

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

status instance-attribute

status: GatewayStatus

The current status of the updated gateway.

status_reasons class-attribute instance-attribute

status_reasons: list[str] | None = None

The reasons for the current status of the updated 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 = None

The Amazon Web Services WAF configuration for the gateway.

web_acl_arn class-attribute instance-attribute

web_acl_arn: str | None = 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 = None

The workload identity details for the updated gateway.