aws_sdk_ec2/client/
describe_transit_gateway_multicast_domains.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeTransitGatewayMulticastDomains`](crate::operation::describe_transit_gateway_multicast_domains::builders::DescribeTransitGatewayMulticastDomainsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_transit_gateway_multicast_domains::builders::DescribeTransitGatewayMulticastDomainsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`transit_gateway_multicast_domain_ids(impl Into<String>)`](crate::operation::describe_transit_gateway_multicast_domains::builders::DescribeTransitGatewayMulticastDomainsFluentBuilder::transit_gateway_multicast_domain_ids) / [`set_transit_gateway_multicast_domain_ids(Option<Vec::<String>>)`](crate::operation::describe_transit_gateway_multicast_domains::builders::DescribeTransitGatewayMulticastDomainsFluentBuilder::set_transit_gateway_multicast_domain_ids):<br>required: **false**<br><p>The ID of the transit gateway multicast domain.</p><br>
8    ///   - [`filters(Filter)`](crate::operation::describe_transit_gateway_multicast_domains::builders::DescribeTransitGatewayMulticastDomainsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_transit_gateway_multicast_domains::builders::DescribeTransitGatewayMulticastDomainsFluentBuilder::set_filters):<br>required: **false**<br><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><br>
9    ///   - [`max_results(i32)`](crate::operation::describe_transit_gateway_multicast_domains::builders::DescribeTransitGatewayMulticastDomainsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_transit_gateway_multicast_domains::builders::DescribeTransitGatewayMulticastDomainsFluentBuilder::set_max_results):<br>required: **false**<br><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><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_transit_gateway_multicast_domains::builders::DescribeTransitGatewayMulticastDomainsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_transit_gateway_multicast_domains::builders::DescribeTransitGatewayMulticastDomainsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
11    ///   - [`dry_run(bool)`](crate::operation::describe_transit_gateway_multicast_domains::builders::DescribeTransitGatewayMulticastDomainsFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_transit_gateway_multicast_domains::builders::DescribeTransitGatewayMulticastDomainsFluentBuilder::set_dry_run):<br>required: **false**<br><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><br>
12    /// - On success, responds with [`DescribeTransitGatewayMulticastDomainsOutput`](crate::operation::describe_transit_gateway_multicast_domains::DescribeTransitGatewayMulticastDomainsOutput) with field(s):
13    ///   - [`transit_gateway_multicast_domains(Option<Vec::<TransitGatewayMulticastDomain>>)`](crate::operation::describe_transit_gateway_multicast_domains::DescribeTransitGatewayMulticastDomainsOutput::transit_gateway_multicast_domains): <p>Information about the transit gateway multicast domains.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::describe_transit_gateway_multicast_domains::DescribeTransitGatewayMulticastDomainsOutput::next_token): <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
15    /// - On failure, responds with [`SdkError<DescribeTransitGatewayMulticastDomainsError>`](crate::operation::describe_transit_gateway_multicast_domains::DescribeTransitGatewayMulticastDomainsError)
16    pub fn describe_transit_gateway_multicast_domains(
17        &self,
18    ) -> crate::operation::describe_transit_gateway_multicast_domains::builders::DescribeTransitGatewayMulticastDomainsFluentBuilder {
19        crate::operation::describe_transit_gateway_multicast_domains::builders::DescribeTransitGatewayMulticastDomainsFluentBuilder::new(
20            self.handle.clone(),
21        )
22    }
23}
aws_sdk_ec2/client/describe_transit_gateway_multicast_domains.rs

aws_sdk_ec2/client/
describe_transit_gateway_multicast_domains.rs
