aws_sdk_transfer/client/
describe_agreement.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeAgreement`](crate::operation::describe_agreement::builders::DescribeAgreementFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`agreement_id(impl Into<String>)`](crate::operation::describe_agreement::builders::DescribeAgreementFluentBuilder::agreement_id) / [`set_agreement_id(Option<String>)`](crate::operation::describe_agreement::builders::DescribeAgreementFluentBuilder::set_agreement_id):<br>required: **true**<br><p>A unique identifier for the agreement. This identifier is returned when you create an agreement.</p><br>
    ///   - [`server_id(impl Into<String>)`](crate::operation::describe_agreement::builders::DescribeAgreementFluentBuilder::server_id) / [`set_server_id(Option<String>)`](crate::operation::describe_agreement::builders::DescribeAgreementFluentBuilder::set_server_id):<br>required: **true**<br><p>The server identifier that's associated with the agreement.</p><br>
    /// - On success, responds with [`DescribeAgreementOutput`](crate::operation::describe_agreement::DescribeAgreementOutput) with field(s):
    ///   - [`agreement(Option<DescribedAgreement>)`](crate::operation::describe_agreement::DescribeAgreementOutput::agreement): <p>The details for the specified agreement, returned as a <code>DescribedAgreement</code> object.</p>
    /// - On failure, responds with [`SdkError<DescribeAgreementError>`](crate::operation::describe_agreement::DescribeAgreementError)
    pub fn describe_agreement(&self) -> crate::operation::describe_agreement::builders::DescribeAgreementFluentBuilder {
        crate::operation::describe_agreement::builders::DescribeAgreementFluentBuilder::new(self.handle.clone())
    }
}