aws_sdk_partnercentralchannel/client/
list_relationships.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 [`ListRelationships`](crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`catalog(impl Into<String>)`](crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder::catalog) / [`set_catalog(Option<String>)`](crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder::set_catalog):<br>required: **true**<br><p>The catalog identifier to filter relationships.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in a single call.</p><br>
9    ///   - [`associated_account_ids(impl Into<String>)`](crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder::associated_account_ids) / [`set_associated_account_ids(Option<Vec::<String>>)`](crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder::set_associated_account_ids):<br>required: **false**<br><p>Filter by associated AWS account IDs.</p><br>
10    ///   - [`association_types(AssociationType)`](crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder::association_types) / [`set_association_types(Option<Vec::<AssociationType>>)`](crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder::set_association_types):<br>required: **false**<br><p>Filter by association types.</p><br>
11    ///   - [`display_names(impl Into<String>)`](crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder::display_names) / [`set_display_names(Option<Vec::<String>>)`](crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder::set_display_names):<br>required: **false**<br><p>Filter by display names.</p><br>
12    ///   - [`program_management_account_identifiers(impl Into<String>)`](crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder::program_management_account_identifiers) / [`set_program_management_account_identifiers(Option<Vec::<String>>)`](crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder::set_program_management_account_identifiers):<br>required: **false**<br><p>Filter by program management account identifiers.</p><br>
13    ///   - [`sort(ListRelationshipsSortBase)`](crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder::sort) / [`set_sort(Option<ListRelationshipsSortBase>)`](crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder::set_sort):<br>required: **false**<br><p>Sorting options for the results.</p><br>
14    ///   - [`next_token(impl Into<String>)`](crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder::set_next_token):<br>required: **false**<br><p>Token for retrieving the next page of results.</p><br>
15    /// - On success, responds with [`ListRelationshipsOutput`](crate::operation::list_relationships::ListRelationshipsOutput) with field(s):
16    ///   - [`items(Option<Vec::<RelationshipSummary>>)`](crate::operation::list_relationships::ListRelationshipsOutput::items): <p>List of relationships matching the criteria.</p>
17    ///   - [`next_token(Option<String>)`](crate::operation::list_relationships::ListRelationshipsOutput::next_token): <p>Token for retrieving the next page of results, if available.</p>
18    /// - On failure, responds with [`SdkError<ListRelationshipsError>`](crate::operation::list_relationships::ListRelationshipsError)
19    pub fn list_relationships(&self) -> crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder {
20        crate::operation::list_relationships::builders::ListRelationshipsFluentBuilder::new(self.handle.clone())
21    }
22}