aws_sdk_partnercentralchannel/client/
list_channel_handshakes.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 [`ListChannelHandshakes`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`handshake_type(HandshakeType)`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::handshake_type) / [`set_handshake_type(Option<HandshakeType>)`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::set_handshake_type):<br>required: **true**<br><p>Filter results by handshake type.</p><br>
8    ///   - [`catalog(impl Into<String>)`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::catalog) / [`set_catalog(Option<String>)`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::set_catalog):<br>required: **true**<br><p>The catalog identifier to filter handshakes.</p><br>
9    ///   - [`participant_type(ParticipantType)`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::participant_type) / [`set_participant_type(Option<ParticipantType>)`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::set_participant_type):<br>required: **true**<br><p>Filter by participant type (sender or receiver).</p><br>
10    ///   - [`max_results(i32)`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in a single call.</p><br>
11    ///   - [`statuses(HandshakeStatus)`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::statuses) / [`set_statuses(Option<Vec::<HandshakeStatus>>)`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::set_statuses):<br>required: **false**<br><p>Filter results by handshake status.</p><br>
12    ///   - [`associated_resource_identifiers(impl Into<String>)`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::associated_resource_identifiers) / [`set_associated_resource_identifiers(Option<Vec::<String>>)`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::set_associated_resource_identifiers):<br>required: **false**<br><p>Filter by associated resource identifiers.</p><br>
13    ///   - [`handshake_type_filters(ListChannelHandshakesTypeFilters)`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::handshake_type_filters) / [`set_handshake_type_filters(Option<ListChannelHandshakesTypeFilters>)`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::set_handshake_type_filters):<br>required: **false**<br><p>Type-specific filters for handshakes.</p><br>
14    ///   - [`handshake_type_sort(ListChannelHandshakesTypeSort)`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::handshake_type_sort) / [`set_handshake_type_sort(Option<ListChannelHandshakesTypeSort>)`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::set_handshake_type_sort):<br>required: **false**<br><p>Type-specific sorting options for handshakes.</p><br>
15    ///   - [`next_token(impl Into<String>)`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::set_next_token):<br>required: **false**<br><p>Token for retrieving the next page of results.</p><br>
16    /// - On success, responds with [`ListChannelHandshakesOutput`](crate::operation::list_channel_handshakes::ListChannelHandshakesOutput) with field(s):
17    ///   - [`items(Option<Vec::<ChannelHandshakeSummary>>)`](crate::operation::list_channel_handshakes::ListChannelHandshakesOutput::items): <p>List of channel handshakes matching the criteria.</p>
18    ///   - [`next_token(Option<String>)`](crate::operation::list_channel_handshakes::ListChannelHandshakesOutput::next_token): <p>Token for retrieving the next page of results, if available.</p>
19    /// - On failure, responds with [`SdkError<ListChannelHandshakesError>`](crate::operation::list_channel_handshakes::ListChannelHandshakesError)
20    pub fn list_channel_handshakes(&self) -> crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder {
21        crate::operation::list_channel_handshakes::builders::ListChannelHandshakesFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_partnercentralchannel/client/list_channel_handshakes.rs

aws_sdk_partnercentralchannel/client/
list_channel_handshakes.rs
