aws_sdk_ec2/client/

search_transit_gateway_multicast_groups.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`SearchTransitGatewayMulticastGroups`](crate::operation::search_transit_gateway_multicast_groups::builders::SearchTransitGatewayMulticastGroupsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::search_transit_gateway_multicast_groups::builders::SearchTransitGatewayMulticastGroupsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`transit_gateway_multicast_domain_id(impl Into<String>)`](crate::operation::search_transit_gateway_multicast_groups::builders::SearchTransitGatewayMulticastGroupsFluentBuilder::transit_gateway_multicast_domain_id) / [`set_transit_gateway_multicast_domain_id(Option<String>)`](crate::operation::search_transit_gateway_multicast_groups::builders::SearchTransitGatewayMulticastGroupsFluentBuilder::set_transit_gateway_multicast_domain_id):<br>required: **true**<br><p>The ID of the transit gateway multicast domain.</p><br>
    ///   - [`filters(Filter)`](crate::operation::search_transit_gateway_multicast_groups::builders::SearchTransitGatewayMulticastGroupsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::search_transit_gateway_multicast_groups::builders::SearchTransitGatewayMulticastGroupsFluentBuilder::set_filters):<br>required: **false**<br><p>One or more filters. The possible values are:</p> <ul>  <li>   <p><code>group-ip-address</code> - The IP address of the transit gateway multicast group.</p></li>  <li>   <p><code>is-group-member</code> - The resource is a group member. Valid values are <code>true</code> | <code>false</code>.</p></li>  <li>   <p><code>is-group-source</code> - The resource is a group source. Valid values are <code>true</code> | <code>false</code>.</p></li>  <li>   <p><code>member-type</code> - The member type. Valid values are <code>igmp</code> | <code>static</code>.</p></li>  <li>   <p><code>resource-id</code> - The ID of the resource.</p></li>  <li>   <p><code>resource-type</code> - The type of resource. Valid values are <code>vpc</code> | <code>vpn</code> | <code>direct-connect-gateway</code> | <code>tgw-peering</code>.</p></li>  <li>   <p><code>source-type</code> - The source type. Valid values are <code>igmp</code> | <code>static</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>
    ///   - [`max_results(i32)`](crate::operation::search_transit_gateway_multicast_groups::builders::SearchTransitGatewayMulticastGroupsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_transit_gateway_multicast_groups::builders::SearchTransitGatewayMulticastGroupsFluentBuilder::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>
    ///   - [`next_token(impl Into<String>)`](crate::operation::search_transit_gateway_multicast_groups::builders::SearchTransitGatewayMulticastGroupsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_transit_gateway_multicast_groups::builders::SearchTransitGatewayMulticastGroupsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
    ///   - [`dry_run(bool)`](crate::operation::search_transit_gateway_multicast_groups::builders::SearchTransitGatewayMulticastGroupsFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::search_transit_gateway_multicast_groups::builders::SearchTransitGatewayMulticastGroupsFluentBuilder::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>
    /// - On success, responds with [`SearchTransitGatewayMulticastGroupsOutput`](crate::operation::search_transit_gateway_multicast_groups::SearchTransitGatewayMulticastGroupsOutput) with field(s):
    ///   - [`multicast_groups(Option<Vec::<TransitGatewayMulticastGroup>>)`](crate::operation::search_transit_gateway_multicast_groups::SearchTransitGatewayMulticastGroupsOutput::multicast_groups): <p>Information about the transit gateway multicast group.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::search_transit_gateway_multicast_groups::SearchTransitGatewayMulticastGroupsOutput::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>
    /// - On failure, responds with [`SdkError<SearchTransitGatewayMulticastGroupsError>`](crate::operation::search_transit_gateway_multicast_groups::SearchTransitGatewayMulticastGroupsError)
    pub fn search_transit_gateway_multicast_groups(
        &self,
    ) -> crate::operation::search_transit_gateway_multicast_groups::builders::SearchTransitGatewayMulticastGroupsFluentBuilder {
        crate::operation::search_transit_gateway_multicast_groups::builders::SearchTransitGatewayMulticastGroupsFluentBuilder::new(
            self.handle.clone(),
        )
    }
}