register_transit_gateway_multicast_group_sources¶
Operation¶
register_transit_gateway_multicast_group_sources
¶
register_transit_gateway_multicast_group_sources(request: RegisterTransitGatewayMulticastGroupSourcesInput | RegisterTransitGatewayMulticastGroupSourcesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RegisterTransitGatewayMulticastGroupSourcesInputDict]) -> RegisterTransitGatewayMulticastGroupSourcesOutput
Registers sources (network interfaces) with the specified transit gateway multicast group.
A multicast source is a network interface attached to a supported instance that sends multicast traffic. For more information about supported instances, see Multicast on transit gateways in the Amazon Web Services Transit Gateways Guide.
After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
RegisterTransitGatewayMulticastGroupSourcesInput | RegisterTransitGatewayMulticastGroupSourcesInputDict | 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[RegisterTransitGatewayMulticastGroupSourcesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
RegisterTransitGatewayMulticastGroupSourcesOutput
|
An instance of |
register_transit_gateway_multicast_group_sources
async
¶
register_transit_gateway_multicast_group_sources(request: RegisterTransitGatewayMulticastGroupSourcesInput | RegisterTransitGatewayMulticastGroupSourcesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RegisterTransitGatewayMulticastGroupSourcesInputDict]) -> RegisterTransitGatewayMulticastGroupSourcesOutput
Registers sources (network interfaces) with the specified transit gateway multicast group.
A multicast source is a network interface attached to a supported instance that sends multicast traffic. For more information about supported instances, see Multicast on transit gateways in the Amazon Web Services Transit Gateways Guide.
After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
RegisterTransitGatewayMulticastGroupSourcesInput | RegisterTransitGatewayMulticastGroupSourcesInputDict | 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[RegisterTransitGatewayMulticastGroupSourcesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
RegisterTransitGatewayMulticastGroupSourcesOutput
|
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.
RegisterTransitGatewayMulticastGroupSourcesInputDict
¶
Bases: TypedDict
Dictionary form of RegisterTransitGatewayMulticastGroupSourcesInput.
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.
group_ip_address
instance-attribute
¶
group_ip_address: str | None
The IP address assigned to the transit gateway multicast group.
network_interface_ids
instance-attribute
¶
The group sources' network interface IDs to register with the transit gateway multicast group.
RegisterTransitGatewayMulticastGroupSourcesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for RegisterTransitGatewayMulticastGroupSourcesInput 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.
group_ip_address
class-attribute
instance-attribute
¶
group_ip_address: str | None = ...
The IP address assigned to the transit gateway multicast group.
network_interface_ids
class-attribute
instance-attribute
¶
The group sources' network interface IDs to register with the transit gateway multicast group.
Output¶
RegisterTransitGatewayMulticastGroupSourcesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for RegisterTransitGatewayMulticastGroupSourcesOutput structure.
Attributes¶
registered_multicast_group_sources
class-attribute
instance-attribute
¶
registered_multicast_group_sources: TransitGatewayMulticastRegisteredGroupSources | None = ...
Information about the transit gateway multicast group sources.
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.