DescribeAttachmentRequest Class | AWS SDK for .NET Version 4

Container for the parameters to the DescribeAttachment operation. 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 an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
If you call the Amazon Web Services Support API from an account that doesn't have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

DescribeAttachment can't return attachments larger than 5 MB. If the specified attachmentId refers to an attachment larger than 5 MB, the request fails with InvalidParameterValueException.

To download an attachment of any size, including attachments larger than 5 MB, use GetAttachmentDownloadLink. GetAttachmentDownloadLink returns an Amazon S3 presigned URL that you can use to download the attachment directly.

In this article ▶

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.AWSSupport.AmazonAWSSupportRequest
      Amazon.AWSSupport.Model.DescribeAttachmentRequest

Namespace: Amazon.AWSSupport.Model
Assembly: AWSSDK.AWSSupport.dll
Version: 3.x.y.z

Syntax

public class DescribeAttachmentRequest : AmazonAWSSupportRequest
         IAmazonWebServiceRequest

The DescribeAttachmentRequest type exposes the following members

Constructors

	Name	Description
	DescribeAttachmentRequest()

Properties

Name Type Description

	Name	Type	Description
	AttachmentId	System.String	Gets and sets the property AttachmentId. The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation. If the specified attachment is larger than 5 MB, this operation returns `InvalidParameterValueException`. To download attachments larger than 5 MB, use GetAttachmentDownloadLink.
	DryRun	System.Nullable<System.Boolean>	Gets and sets the property DryRun. Specifies whether to validate the request without actually retrieving the attachment. When set to `true`, the request is validated but no attachment content is returned, and the operation returns a `DryRunOperationException`. When omitted or set to `false`, the request runs normally.

AttachmentId

System.String

Gets and sets the property AttachmentId.

The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.

If the specified attachment is larger than 5 MB, this operation returns InvalidParameterValueException. To download attachments larger than 5 MB, use GetAttachmentDownloadLink.

DryRun

System.Nullable<System.Boolean>

Gets and sets the property DryRun.

Specifies whether to validate the request without actually retrieving the attachment. When set to true, the request is validated but no attachment content is returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer