search_transit_gateway_multicast_groups¶
Operation¶
search_transit_gateway_multicast_groups
¶
search_transit_gateway_multicast_groups(request: SearchTransitGatewayMulticastGroupsInput | SearchTransitGatewayMulticastGroupsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SearchTransitGatewayMulticastGroupsInputDict]) -> SearchTransitGatewayMulticastGroupsOutput
Searches one or more transit gateway multicast groups and returns the group membership information.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
SearchTransitGatewayMulticastGroupsInput | SearchTransitGatewayMulticastGroupsInputDict | 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[SearchTransitGatewayMulticastGroupsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
SearchTransitGatewayMulticastGroupsOutput
|
An instance of |
search_transit_gateway_multicast_groups
async
¶
search_transit_gateway_multicast_groups(request: SearchTransitGatewayMulticastGroupsInput | SearchTransitGatewayMulticastGroupsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SearchTransitGatewayMulticastGroupsInputDict]) -> SearchTransitGatewayMulticastGroupsOutput
Searches one or more transit gateway multicast groups and returns the group membership information.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
SearchTransitGatewayMulticastGroupsInput | SearchTransitGatewayMulticastGroupsInputDict | 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[SearchTransitGatewayMulticastGroupsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
SearchTransitGatewayMulticastGroupsOutput
|
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.
SearchTransitGatewayMulticastGroupsInputDict
¶
Bases: TypedDict
Dictionary form of SearchTransitGatewayMulticastGroupsInput.
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:
-
group-ip-address- The IP address of the transit gateway multicast group. -
is-group-member- The resource is a group member. Valid values aretrue|false. -
is-group-source- The resource is a group source. Valid values aretrue|false. -
member-type- The member type. Valid values areigmp|static. -
resource-id- The ID of the resource. -
resource-type- The type of resource. Valid values arevpc|vpn|direct-connect-gateway|tgw-peering. -
source-type- The source type. Valid values areigmp|static. -
subnet-id- The ID of the subnet. -
transit-gateway-attachment-id- The id of the transit gateway attachment.
SearchTransitGatewayMulticastGroupsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for SearchTransitGatewayMulticastGroupsInput 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
¶
One or more filters. The possible values are:
-
group-ip-address- The IP address of the transit gateway multicast group. -
is-group-member- The resource is a group member. Valid values aretrue|false. -
is-group-source- The resource is a group source. Valid values aretrue|false. -
member-type- The member type. Valid values areigmp|static. -
resource-id- The ID of the resource. -
resource-type- The type of resource. Valid values arevpc|vpn|direct-connect-gateway|tgw-peering. -
source-type- The source type. Valid values areigmp|static. -
subnet-id- The ID of the subnet. -
transit-gateway-attachment-id- The id of the transit gateway attachment.
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.
Output¶
SearchTransitGatewayMulticastGroupsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for SearchTransitGatewayMulticastGroupsOutput structure.
Attributes¶
multicast_groups
class-attribute
instance-attribute
¶
multicast_groups: list[TransitGatewayMulticastGroup] | None = ...
Information about the transit gateway multicast group.
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
¶
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.