Skip to content

disassociate_transit_gateway_multicast_domain

disassociate_transit_gateway_multicast_domain(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_multicast_domain_id: Optional[
        TransitGatewayMulticastDomainId
    ] = None,
    transit_gateway_attachment_id: Optional[TransitGatewayAttachmentId] = None,
    subnet_ids: Optional[TransitGatewaySubnetIdList] = None,
    dry_run: Optional[Boolean] = None,
) -> DisassociateTransitGatewayMulticastDomainResult

Disassociates the specified subnets from the transit gateway multicast domain.

Parameters:

  • transit_gateway_multicast_domain_id (Optional[TransitGatewayMulticastDomainId], default: None ) –

    The ID of the transit gateway multicast domain.

  • transit_gateway_attachment_id (Optional[TransitGatewayAttachmentId], default: None ) –

    The ID of the attachment.

  • subnet_ids (Optional[TransitGatewaySubnetIdList], default: None ) –

    The IDs of the subnets;

  • dry_run (Optional[Boolean], default: 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.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def disassociate_transit_gateway_multicast_domain(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_multicast_domain_id: Optional[
        "capo_ec2.types.transit_gateway_multicast_domain_id.TransitGatewayMulticastDomainId"
    ] = None,
    transit_gateway_attachment_id: Optional[
        "capo_ec2.types.transit_gateway_attachment_id.TransitGatewayAttachmentId"
    ] = None,
    subnet_ids: Optional[
        "capo_ec2.types.transit_gateway_subnet_id_list.TransitGatewaySubnetIdList"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.disassociate_transit_gateway_multicast_domain_result.DisassociateTransitGatewayMulticastDomainResult":
    """<p>Disassociates the specified subnets from the transit gateway multicast domain. </p>

    Args:
        transit_gateway_multicast_domain_id: <p>The ID of the transit gateway multicast domain.</p>
        transit_gateway_attachment_id: <p>The ID of the attachment.</p>
        subnet_ids: <p>The IDs of the subnets;</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.disassociate_transit_gateway_multicast_domain_request.DisassociateTransitGatewayMulticastDomainRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.disassociate_transit_gateway_multicast_domain_result.DisassociateTransitGatewayMulticastDomainResult"
    ]:
        import capo_ec2._operations.amazon_ec2.disassociate_transit_gateway_multicast_domain

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

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DisassociateTransitGatewayMulticastDomain"),
    )
    input_: capo_ec2.types.disassociate_transit_gateway_multicast_domain_request.DisassociateTransitGatewayMulticastDomainRequest = {}
    if transit_gateway_multicast_domain_id is not None:
        input_["transit_gateway_multicast_domain_id"] = (
            transit_gateway_multicast_domain_id
        )
    if transit_gateway_attachment_id is not None:
        input_["transit_gateway_attachment_id"] = transit_gateway_attachment_id
    if subnet_ids is not None:
        input_["subnet_ids"] = subnet_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