aws_sdk_ec2/client/get_transit_gateway_multicast_domain_associations.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 [`GetTransitGatewayMulticastDomainAssociations`](crate::operation::get_transit_gateway_multicast_domain_associations::builders::GetTransitGatewayMulticastDomainAssociationsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_transit_gateway_multicast_domain_associations::builders::GetTransitGatewayMulticastDomainAssociationsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`transit_gateway_multicast_domain_id(impl Into<String>)`](crate::operation::get_transit_gateway_multicast_domain_associations::builders::GetTransitGatewayMulticastDomainAssociationsFluentBuilder::transit_gateway_multicast_domain_id) / [`set_transit_gateway_multicast_domain_id(Option<String>)`](crate::operation::get_transit_gateway_multicast_domain_associations::builders::GetTransitGatewayMulticastDomainAssociationsFluentBuilder::set_transit_gateway_multicast_domain_id):<br>required: **true**<br><p>The ID of the transit gateway multicast domain.</p><br>
8 /// - [`filters(Filter)`](crate::operation::get_transit_gateway_multicast_domain_associations::builders::GetTransitGatewayMulticastDomainAssociationsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::get_transit_gateway_multicast_domain_associations::builders::GetTransitGatewayMulticastDomainAssociationsFluentBuilder::set_filters):<br>required: **false**<br><p>One or more filters. The possible values are:</p> <ul> <li> <p><code>resource-id</code> - The ID of the resource.</p></li> <li> <p><code>resource-type</code> - The type of resource. The valid value is: <code>vpc</code>.</p></li> <li> <p><code>state</code> - The state of the subnet association. Valid values are <code>associated</code> | <code>associating</code> | <code>disassociated</code> | <code>disassociating</code>.</p></li> <li> <p><code>subnet-id</code> - The ID of the subnet.</p></li> <li> <p><code>transit-gateway-attachment-id</code> - The id of the transit gateway attachment.</p></li> </ul><br>
9 /// - [`max_results(i32)`](crate::operation::get_transit_gateway_multicast_domain_associations::builders::GetTransitGatewayMulticastDomainAssociationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_transit_gateway_multicast_domain_associations::builders::GetTransitGatewayMulticastDomainAssociationsFluentBuilder::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::get_transit_gateway_multicast_domain_associations::builders::GetTransitGatewayMulticastDomainAssociationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_transit_gateway_multicast_domain_associations::builders::GetTransitGatewayMulticastDomainAssociationsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
11 /// - [`dry_run(bool)`](crate::operation::get_transit_gateway_multicast_domain_associations::builders::GetTransitGatewayMulticastDomainAssociationsFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::get_transit_gateway_multicast_domain_associations::builders::GetTransitGatewayMulticastDomainAssociationsFluentBuilder::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 [`GetTransitGatewayMulticastDomainAssociationsOutput`](crate::operation::get_transit_gateway_multicast_domain_associations::GetTransitGatewayMulticastDomainAssociationsOutput) with field(s):
13 /// - [`multicast_domain_associations(Option<Vec::<TransitGatewayMulticastDomainAssociation>>)`](crate::operation::get_transit_gateway_multicast_domain_associations::GetTransitGatewayMulticastDomainAssociationsOutput::multicast_domain_associations): <p>Information about the multicast domain associations.</p>
14 /// - [`next_token(Option<String>)`](crate::operation::get_transit_gateway_multicast_domain_associations::GetTransitGatewayMulticastDomainAssociationsOutput::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<GetTransitGatewayMulticastDomainAssociationsError>`](crate::operation::get_transit_gateway_multicast_domain_associations::GetTransitGatewayMulticastDomainAssociationsError)
16 pub fn get_transit_gateway_multicast_domain_associations(
17 &self,
18 ) -> crate::operation::get_transit_gateway_multicast_domain_associations::builders::GetTransitGatewayMulticastDomainAssociationsFluentBuilder
19 {
20 crate::operation::get_transit_gateway_multicast_domain_associations::builders::GetTransitGatewayMulticastDomainAssociationsFluentBuilder::new(
21 self.handle.clone(),
22 )
23 }
24}