register_transit_gateway_multicast_group_members ¶

def register_transit_gateway_multicast_group_members(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_multicast_domain_id: Optional[
        "capo_ec2.types.transit_gateway_multicast_domain_id.TransitGatewayMulticastDomainId"
    ] = None,
    group_ip_address: Optional["capo_ec2.types.string.String"] = None,
    network_interface_ids: Optional[
        "capo_ec2.types.transit_gateway_network_interface_id_list.TransitGatewayNetworkInterfaceIdList"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.register_transit_gateway_multicast_group_members_result.RegisterTransitGatewayMulticastGroupMembersResult":
    """<p>Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/tgw/tgw-multicast-overview.html">Multicast on transit gateways</a> in the <i>Amazon Web Services Transit Gateways Guide</i>.</p> <p>After you add the members, use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SearchTransitGatewayMulticastGroups.html">SearchTransitGatewayMulticastGroups</a> to verify that the members were added to the transit gateway multicast group.</p>

    Args:
        transit_gateway_multicast_domain_id: <p>The ID of the transit gateway multicast domain.</p>
        group_ip_address: <p>The IP address assigned to the transit gateway multicast group.</p>
        network_interface_ids: <p>The group members' network interface IDs to register with the transit gateway multicast group.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.register_transit_gateway_multicast_group_members_request.RegisterTransitGatewayMulticastGroupMembersRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.register_transit_gateway_multicast_group_members_result.RegisterTransitGatewayMulticastGroupMembersResult"
    ]:
        import capo_ec2._operations.amazon_ec2.register_transit_gateway_multicast_group_members

        output, http_response = (
            capo_ec2._operations.amazon_ec2.register_transit_gateway_multicast_group_members.register_transit_gateway_multicast_group_members(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("RegisterTransitGatewayMulticastGroupMembers"),
    )
    input_: capo_ec2.types.register_transit_gateway_multicast_group_members_request.RegisterTransitGatewayMulticastGroupMembersRequest = {}
    if transit_gateway_multicast_domain_id is not None:
        input_["transit_gateway_multicast_domain_id"] = (
            transit_gateway_multicast_domain_id
        )
    if group_ip_address is not None:
        input_["group_ip_address"] = group_ip_address
    if network_interface_ids is not None:
        input_["network_interface_ids"] = network_interface_ids
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output