aws_sdk_transfer/client/
list_agreements.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 [`ListAgreements`](crate::operation::list_agreements::builders::ListAgreementsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_agreements::builders::ListAgreementsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`max_results(i32)`](crate::operation::list_agreements::builders::ListAgreementsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_agreements::builders::ListAgreementsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to return.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_agreements::builders::ListAgreementsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_agreements::builders::ListAgreementsFluentBuilder::set_next_token):<br>required: **false**<br><p>When you can get additional results from the <code>ListAgreements</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional agreements.</p><br>
9    ///   - [`server_id(impl Into<String>)`](crate::operation::list_agreements::builders::ListAgreementsFluentBuilder::server_id) / [`set_server_id(Option<String>)`](crate::operation::list_agreements::builders::ListAgreementsFluentBuilder::set_server_id):<br>required: **true**<br><p>The identifier of the server for which you want a list of agreements.</p><br>
10    /// - On success, responds with [`ListAgreementsOutput`](crate::operation::list_agreements::ListAgreementsOutput) with field(s):
11    ///   - [`next_token(Option<String>)`](crate::operation::list_agreements::ListAgreementsOutput::next_token): <p>Returns a token that you can use to call <code>ListAgreements</code> again and receive additional results, if there are any.</p>
12    ///   - [`agreements(Vec::<ListedAgreement>)`](crate::operation::list_agreements::ListAgreementsOutput::agreements): <p>Returns an array, where each item contains the details of an agreement.</p>
13    /// - On failure, responds with [`SdkError<ListAgreementsError>`](crate::operation::list_agreements::ListAgreementsError)
14    pub fn list_agreements(&self) -> crate::operation::list_agreements::builders::ListAgreementsFluentBuilder {
15        crate::operation::list_agreements::builders::ListAgreementsFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_transfer/client/list_agreements.rs

aws_sdk_transfer/client/
list_agreements.rs
