get_gateway¶
Operation¶
get_gateway
¶
get_gateway(request: GetGatewayInput | GetGatewayInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetGatewayInputDict]) -> GetGatewayOutput
Retrieves information about a specific Gateway.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetGatewayInput | GetGatewayInputDict | 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[GetGatewayInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetGatewayOutput
|
An instance of |
get_gateway
async
¶
get_gateway(request: GetGatewayInput | GetGatewayInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetGatewayInputDict]) -> GetGatewayOutput
Retrieves information about a specific Gateway.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetGatewayInput | GetGatewayInputDict | 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[GetGatewayInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetGatewayOutput
|
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.
Output¶
GetGatewayOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetGatewayOutput structure.
Attributes¶
authorizer_configuration
class-attribute
instance-attribute
¶
authorizer_configuration: AuthorizerConfiguration | None = ...
The authorizer configuration 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 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_url
class-attribute
instance-attribute
¶
gateway_url: str | None = ...
An endpoint for invoking gateway.
interceptor_configurations
class-attribute
instance-attribute
¶
interceptor_configurations: list[GatewayInterceptorConfiguration] | None = ...
The interceptors configured on the 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 the gateway.
policy_engine_configuration
class-attribute
instance-attribute
¶
policy_engine_configuration: GatewayPolicyEngineConfiguration | None = ...
The 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 = ...
Protocol applied to a 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 IAM role ARN that provides permissions for 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 gateway.