aws-sdk-support 1.113.0

AWS SDK for AWS Support
Documentation
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 [`DescribeAttachment`](crate::operation::describe_attachment::builders::DescribeAttachmentFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`attachment_id(impl Into<String>)`](crate::operation::describe_attachment::builders::DescribeAttachmentFluentBuilder::attachment_id) / [`set_attachment_id(Option<String>)`](crate::operation::describe_attachment::builders::DescribeAttachmentFluentBuilder::set_attachment_id):<br>required: **true**<br><p>The ID of the attachment to return. Attachment IDs are returned by the <code>DescribeCommunications</code> operation.</p> <p>If the specified attachment is larger than 5 MB, this operation returns <code>InvalidParameterValueException</code>. To download attachments larger than 5 MB, use <code>GetAttachmentDownloadLink</code>.</p><br>
    ///   - [`dry_run(bool)`](crate::operation::describe_attachment::builders::DescribeAttachmentFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_attachment::builders::DescribeAttachmentFluentBuilder::set_dry_run):<br>required: **false**<br><p>Specifies whether to validate the request without actually retrieving the attachment. When set to <code>true</code>, the request is validated but no attachment content is returned, and the operation returns a <code>DryRunOperationException</code>. When omitted or set to <code>false</code>, the request runs normally.</p><br>
    /// - On success, responds with [`DescribeAttachmentOutput`](crate::operation::describe_attachment::DescribeAttachmentOutput) with field(s):
    ///   - [`attachment(Option<Attachment>)`](crate::operation::describe_attachment::DescribeAttachmentOutput::attachment): <p>This object includes the attachment content and file name.</p> <p>In the previous response syntax, the value for the <code>data</code> parameter appears as <code>blob</code>, which is represented as a base64-encoded string. The value for <code>fileName</code> is the name of the attachment, such as <code>troubleshoot-screenshot.png</code>.</p>
    /// - On failure, responds with [`SdkError<DescribeAttachmentError>`](crate::operation::describe_attachment::DescribeAttachmentError)
    pub fn describe_attachment(&self) -> crate::operation::describe_attachment::builders::DescribeAttachmentFluentBuilder {
        crate::operation::describe_attachment::builders::DescribeAttachmentFluentBuilder::new(self.handle.clone())
    }
}