| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Support.DescribeAttachment
Description
Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.
- You must have a Business or Enterprise Support plan to use the AWS Support API.
- If you call the AWS Support API from an account that does not have a
Business or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see AWS Support.
Synopsis
- data DescribeAttachment = DescribeAttachment' {
- attachmentId :: Text
- newDescribeAttachment :: Text -> DescribeAttachment
- describeAttachment_attachmentId :: Lens' DescribeAttachment Text
- data DescribeAttachmentResponse = DescribeAttachmentResponse' {}
- newDescribeAttachmentResponse :: Int -> DescribeAttachmentResponse
- describeAttachmentResponse_attachment :: Lens' DescribeAttachmentResponse (Maybe Attachment)
- describeAttachmentResponse_httpStatus :: Lens' DescribeAttachmentResponse Int
Creating a Request
data DescribeAttachment Source #
See: newDescribeAttachment smart constructor.
Constructors
| DescribeAttachment' | |
Fields
| |
Instances
newDescribeAttachment Source #
Arguments
| :: Text | |
| -> DescribeAttachment |
Create a value of DescribeAttachment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attachmentId:DescribeAttachment', describeAttachment_attachmentId - The ID of the attachment to return. Attachment IDs are returned by the
DescribeCommunications operation.
Request Lenses
describeAttachment_attachmentId :: Lens' DescribeAttachment Text Source #
The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.
Destructuring the Response
data DescribeAttachmentResponse Source #
The content and file name of the attachment returned by the DescribeAttachment operation.
See: newDescribeAttachmentResponse smart constructor.
Constructors
| DescribeAttachmentResponse' | |
Fields
| |
Instances
newDescribeAttachmentResponse Source #
Create a value of DescribeAttachmentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attachment:DescribeAttachmentResponse', describeAttachmentResponse_attachment - This object includes the attachment content and file name.
In the previous response syntax, the value for the data parameter
appears as blob, which is represented as a base64-encoded string. The
value for fileName is the name of the attachment, such as
troubleshoot-screenshot.png.
$sel:httpStatus:DescribeAttachmentResponse', describeAttachmentResponse_httpStatus - The response's http status code.
Response Lenses
describeAttachmentResponse_attachment :: Lens' DescribeAttachmentResponse (Maybe Attachment) Source #
This object includes the attachment content and file name.
In the previous response syntax, the value for the data parameter
appears as blob, which is represented as a base64-encoded string. The
value for fileName is the name of the attachment, such as
troubleshoot-screenshot.png.
describeAttachmentResponse_httpStatus :: Lens' DescribeAttachmentResponse Int Source #
The response's http status code.