describe_transit_gateway_multicast_domains ¶

def describe_transit_gateway_multicast_domains(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_multicast_domain_ids: Optional[
        "capo_ec2.types.transit_gateway_multicast_domain_id_string_list.TransitGatewayMulticastDomainIdStringList"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional[
        "capo_ec2.types.transit_gateway_max_results.TransitGatewayMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.describe_transit_gateway_multicast_domains_result.DescribeTransitGatewayMulticastDomainsResult":
    """<p>Describes one or more transit gateway multicast domains.</p>

    Args:
        transit_gateway_multicast_domain_ids: <p>The ID of the transit gateway multicast domain.</p>
        filters: <p>One or more filters. The possible values are:</p> <ul> <li> <p> <code>state</code> - The state of the transit gateway multicast domain. Valid values are <code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>.</p> </li> <li> <p> <code>transit-gateway-id</code> - The ID of the transit gateway.</p> </li> <li> <p> <code>transit-gateway-multicast-domain-id</code> - The ID of the transit gateway multicast domain.</p> </li> </ul>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
        next_token: <p>The token for the next page of results.</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.describe_transit_gateway_multicast_domains_request.DescribeTransitGatewayMulticastDomainsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_transit_gateway_multicast_domains_result.DescribeTransitGatewayMulticastDomainsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_transit_gateway_multicast_domains

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTransitGatewayMulticastDomains")
    )
    input_: capo_ec2.types.describe_transit_gateway_multicast_domains_request.DescribeTransitGatewayMulticastDomainsRequest = {}
    if transit_gateway_multicast_domain_ids is not None:
        input_["transit_gateway_multicast_domain_ids"] = (
            transit_gateway_multicast_domain_ids
        )
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    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