describe_gateway_route¶
Operation¶
describe_gateway_route
¶
describe_gateway_route(request: DescribeGatewayRouteInput | DescribeGatewayRouteInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeGatewayRouteInputDict]) -> DescribeGatewayRouteOutput
Describes a gateway route, including its status, the service it routes traffic to, and the service-specific infrastructure, such as target groups and listener rules, that the gateway manages for it.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeGatewayRouteInput | DescribeGatewayRouteInputDict | 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[DescribeGatewayRouteInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeGatewayRouteOutput
|
An instance of |
describe_gateway_route
async
¶
describe_gateway_route(request: DescribeGatewayRouteInput | DescribeGatewayRouteInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeGatewayRouteInputDict]) -> DescribeGatewayRouteOutput
Describes a gateway route, including its status, the service it routes traffic to, and the service-specific infrastructure, such as target groups and listener rules, that the gateway manages for it.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeGatewayRouteInput | DescribeGatewayRouteInputDict | 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[DescribeGatewayRouteInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeGatewayRouteOutput
|
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¶
DescribeGatewayRouteOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeGatewayRouteOutput structure.
Attributes¶
gateway_route
class-attribute
instance-attribute
¶
gateway_route: GatewayRoute | None = ...
The details of the gateway route.
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.