describe_gateway¶
Operation¶
describe_gateway
async
¶
describe_gateway(request: DescribeGatewayInput | DescribeGatewayInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeGatewayOutput
describe_gateway(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeGatewayInputDict]) -> DescribeGatewayOutput
Describes a gateway, including its configuration, status, and the type-specific infrastructure settings that it uses.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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 |
|---|---|
DescribeGatewayOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeGatewayInput
dataclass
¶
Dictionaries¶
DescribeGatewayInputDict
¶
Output¶
DescribeGatewayOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeGatewayOutput structure.
Attributes¶
gateway
class-attribute
instance-attribute
¶
gateway: Gateway | None = ...
The details 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.