Skip to content

describe_transit_gateway_connects

Operation

describe_transit_gateway_connects

describe_transit_gateway_connects(request: DescribeTransitGatewayConnectsInput | DescribeTransitGatewayConnectsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTransitGatewayConnectsInputDict]) -> DescribeTransitGatewayConnectsOutput

Describes one or more Connect attachments.

Parameters:

Name Type Description Default
request DescribeTransitGatewayConnectsInput | DescribeTransitGatewayConnectsInputDict | 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[DescribeTransitGatewayConnectsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeTransitGatewayConnectsOutput

An instance of DescribeTransitGatewayConnectsOutput.

describe_transit_gateway_connects async

describe_transit_gateway_connects(request: DescribeTransitGatewayConnectsInput | DescribeTransitGatewayConnectsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTransitGatewayConnectsInputDict]) -> DescribeTransitGatewayConnectsOutput

Describes one or more Connect attachments.

Parameters:

Name Type Description Default
request DescribeTransitGatewayConnectsInput | DescribeTransitGatewayConnectsInputDict | 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[DescribeTransitGatewayConnectsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeTransitGatewayConnectsOutput

An instance of DescribeTransitGatewayConnectsOutput.

Input

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

DescribeTransitGatewayConnectsInputDict

Bases: TypedDict

Dictionary form of DescribeTransitGatewayConnectsInput.

Attributes

dry_run instance-attribute
dry_run: bool | None

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

One or more filters. The possible values are:

  • options.protocol - The tunnel protocol (gre).

  • state - The state of the attachment (initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing).

  • transit-gateway-attachment-id - The ID of the Connect attachment.

  • transit-gateway-id - The ID of the transit gateway.

  • transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.

max_results instance-attribute
max_results: int | None

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

next_token instance-attribute
next_token: str | None

The token for the next page of results.

transit_gateway_attachment_ids instance-attribute
transit_gateway_attachment_ids: Sequence[str] | None

The IDs of the attachments.

DescribeTransitGatewayConnectsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeTransitGatewayConnectsInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

One or more filters. The possible values are:

  • options.protocol - The tunnel protocol (gre).

  • state - The state of the attachment (initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing).

  • transit-gateway-attachment-id - The ID of the Connect attachment.

  • transit-gateway-id - The ID of the transit gateway.

  • transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

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

The token for the next page of results.

transit_gateway_attachment_ids class-attribute instance-attribute
transit_gateway_attachment_ids: list[str] | None = ...

The IDs of the attachments.

Output

DescribeTransitGatewayConnectsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeTransitGatewayConnectsOutput structure.

Attributes

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

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

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.

transit_gateway_connects class-attribute instance-attribute
transit_gateway_connects: list[TransitGatewayConnect] | None = ...

Information about the Connect attachments.