Skip to content

describe_transit_gateway_multicast_domains

Operation

describe_transit_gateway_multicast_domains

Describes one or more transit gateway multicast domains.

Parameters:

Name Type Description Default
request DescribeTransitGatewayMulticastDomainsInput | DescribeTransitGatewayMulticastDomainsInputDict | 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[DescribeTransitGatewayMulticastDomainsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeTransitGatewayMulticastDomainsOutput

An instance of DescribeTransitGatewayMulticastDomainsOutput.

describe_transit_gateway_multicast_domains async

Describes one or more transit gateway multicast domains.

Parameters:

Name Type Description Default
request DescribeTransitGatewayMulticastDomainsInput | DescribeTransitGatewayMulticastDomainsInputDict | 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[DescribeTransitGatewayMulticastDomainsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeTransitGatewayMulticastDomainsOutput

An instance of DescribeTransitGatewayMulticastDomainsOutput.

Input

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

DescribeTransitGatewayMulticastDomainsInputDict

Bases: TypedDict

Dictionary form of DescribeTransitGatewayMulticastDomainsInput.

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:

  • state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted.

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

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

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_multicast_domain_ids instance-attribute
transit_gateway_multicast_domain_ids: Sequence[str] | None

The ID of the transit gateway multicast domain.

DescribeTransitGatewayMulticastDomainsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeTransitGatewayMulticastDomainsInput 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:

  • state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted.

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

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

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_multicast_domain_ids class-attribute instance-attribute
transit_gateway_multicast_domain_ids: list[str] | None = ...

The ID of the transit gateway multicast domain.

Output

DescribeTransitGatewayMulticastDomainsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeTransitGatewayMulticastDomainsOutput 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_multicast_domains class-attribute instance-attribute
transit_gateway_multicast_domains: list[TransitGatewayMulticastDomain] | None = ...

Information about the transit gateway multicast domains.