Skip to content

describe_gateway

Operation

describe_gateway

describe_gateway(request: DescribeGatewayInput | DescribeGatewayInputDict | None = None, /, *, 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
request DescribeGatewayInput | DescribeGatewayInputDict | 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[DescribeGatewayInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeGatewayOutput

An instance of DescribeGatewayOutput.

describe_gateway async

describe_gateway(request: DescribeGatewayInput | DescribeGatewayInputDict | None = None, /, *, 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
request DescribeGatewayInput | DescribeGatewayInputDict | 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[DescribeGatewayInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeGatewayOutput

An instance of DescribeGatewayOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeGatewayInputDict

Bases: TypedDict

Dictionary form of DescribeGatewayInput.

Attributes

gateway instance-attribute
gateway: Required[str]

The name or Amazon Resource Name (ARN) of the gateway to describe.

DescribeGatewayInput dataclass

Bases: _SerdeShape

Dataclass for DescribeGatewayInput structure.

Attributes

gateway class-attribute instance-attribute
gateway: str | None = ...

The name or Amazon Resource Name (ARN) of the gateway to describe.

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
response_metadata: ResponseMetadata = ...

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.