update_gateway¶
Operation¶
update_gateway
¶
update_gateway(request: UpdateGatewayInput | UpdateGatewayInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateGatewayInputDict]) -> UpdateGatewayOutput
Updates an existing gateway.
Replaces the entire gateway configuration. Any optional field that you
omit, including fields in protocolConfiguration, is reset. For
information about retrieving the current configuration, see
GetGateway.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateGatewayInput | UpdateGatewayInputDict | 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[UpdateGatewayInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateGatewayOutput
|
An instance of |
update_gateway
async
¶
update_gateway(request: UpdateGatewayInput | UpdateGatewayInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateGatewayInputDict]) -> UpdateGatewayOutput
Updates an existing gateway.
Replaces the entire gateway configuration. Any optional field that you
omit, including fields in protocolConfiguration, is reset. For
information about retrieving the current configuration, see
GetGateway.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateGatewayInput | UpdateGatewayInputDict | 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[UpdateGatewayInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateGatewayOutput
|
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.
UpdateGatewayInputDict
¶
Bases: TypedDict
Dictionary form of UpdateGatewayInput.
Attributes¶
authorizer_configuration
instance-attribute
¶
authorizer_configuration: AuthorizerConfiguration | AuthorizerConfigurationDict | None
The updated authorizer configuration for the gateway.
authorizer_type
instance-attribute
¶
The updated authorizer type for the gateway.
custom_transform_configuration
instance-attribute
¶
custom_transform_configuration: CustomTransformConfiguration | CustomTransformConfigurationDict | None
The updated custom transformation configuration for the gateway. This configuration defines how the gateway transforms requests and responses.
domain_override
instance-attribute
¶
domain_override: DomainOverride | DomainOverrideDict | None
The updated 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.
gateway_identifier
instance-attribute
¶
The identifier of the gateway to update.
interceptor_configurations
instance-attribute
¶
interceptor_configurations: Sequence[GatewayInterceptorConfiguration | GatewayInterceptorConfigurationDict] | None
The updated interceptor configurations for the gateway.
kms_key_arn
instance-attribute
¶
kms_key_arn: str | None
The updated ARN of the KMS key used to encrypt the gateway.
name
instance-attribute
¶
The name of the gateway. This name must be the same as the one when the gateway was created.
policy_engine_configuration
instance-attribute
¶
policy_engine_configuration: GatewayPolicyEngineConfiguration | GatewayPolicyEngineConfigurationDict | 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
instance-attribute
¶
protocol_configuration: GatewayProtocolConfiguration | GatewayProtocolConfigurationDict | None
The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.
protocol_type
instance-attribute
¶
protocol_type: str | None
The updated protocol type for the gateway.
role_arn
instance-attribute
¶
The updated IAM role ARN that provides permissions for the gateway.
waf_configuration
instance-attribute
¶
waf_configuration: WafConfiguration | WafConfigurationDict | None
The updated Amazon Web Services WAF configuration for the gateway.
UpdateGatewayInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateGatewayInput structure.
Attributes¶
authorizer_configuration
class-attribute
instance-attribute
¶
authorizer_configuration: AuthorizerConfiguration | None = ...
The updated authorizer configuration for the gateway.
authorizer_type
class-attribute
instance-attribute
¶
authorizer_type: str | None = ...
The updated authorizer type for the gateway.
custom_transform_configuration
class-attribute
instance-attribute
¶
custom_transform_configuration: CustomTransformConfiguration | 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 = ...
The updated description for the gateway.
domain_override
class-attribute
instance-attribute
¶
domain_override: DomainOverride | None = ...
The updated 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.
gateway_identifier
class-attribute
instance-attribute
¶
gateway_identifier: str | None = ...
The identifier of the gateway to update.
interceptor_configurations
class-attribute
instance-attribute
¶
interceptor_configurations: list[GatewayInterceptorConfiguration] | None = ...
The updated interceptor configurations for the gateway.
kms_key_arn
class-attribute
instance-attribute
¶
kms_key_arn: str | None = ...
The updated ARN of the KMS key used to encrypt the gateway.
name
class-attribute
instance-attribute
¶
name: str | 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 = ...
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 = ...
The configuration for a gateway protocol. This structure defines how the gateway communicates with external services.
protocol_type
class-attribute
instance-attribute
¶
protocol_type: str = ...
The updated protocol type for the gateway.
role_arn
class-attribute
instance-attribute
¶
role_arn: str | None = ...
The updated IAM role ARN that provides permissions for the gateway.
waf_configuration
class-attribute
instance-attribute
¶
waf_configuration: WafConfiguration | None = ...
The updated Amazon Web Services WAF configuration for the gateway.
Output¶
UpdateGatewayOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateGatewayOutput structure.
Attributes¶
authorizer_configuration
class-attribute
instance-attribute
¶
authorizer_configuration: AuthorizerConfiguration | None = ...
The updated authorizer configuration for the gateway.
authorizer_type
instance-attribute
¶
authorizer_type: str
The updated authorizer type for 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 updated 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 updated gateway.
gateway_url
class-attribute
instance-attribute
¶
gateway_url: str | None = ...
An endpoint for invoking the updated gateway.
interceptor_configurations
class-attribute
instance-attribute
¶
interceptor_configurations: list[GatewayInterceptorConfiguration] | None = ...
The updated interceptor configurations for the gateway.
kms_key_arn
class-attribute
instance-attribute
¶
kms_key_arn: str | None = ...
The updated ARN of the KMS key used to encrypt the gateway.
policy_engine_configuration
class-attribute
instance-attribute
¶
policy_engine_configuration: GatewayPolicyEngineConfiguration | None = ...
The updated policy engine configuration for the gateway.
protocol_configuration
class-attribute
instance-attribute
¶
protocol_configuration: GatewayProtocolConfiguration | 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: str = ...
The updated protocol type for 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 updated IAM role ARN that provides permissions for the gateway.
status_reasons
class-attribute
instance-attribute
¶
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 = ...
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 updated gateway.