Container for the parameters to the DescribeCommunications operation.
Returns communications and attachments for one or more support cases. Use the afterTime
and beforeTime parameters to filter by date. You can use the caseId
parameter to restrict the results to a specific case.
Case data is available for 24 months after creation. If a case was created more than 24 months ago, a request for data might cause an error.
You can use the maxResults and nextToken parameters to control the pagination
of the results. Set maxResults to the number of cases that you want to display
on each page, and use nextToken to specify the resumption of pagination.
-
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
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
Each Communication returned by this operation includes attachment information in two fields:
-
attachmentSet: returns only attachments that are 5 MB or smaller. Attachments larger than 5 MB are not included in this field. -
attachments: returns all attachments regardless of size.
Amazon Web Services recommends that you use the attachments field and download
each attachment with GetAttachmentDownloadLink, which supports attachments
of any size. The attachmentSet field and DescribeAttachment return only
attachments that are 5 MB or smaller.
In this article ▶
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.AWSSupport.AmazonAWSSupportRequest
Amazon.AWSSupport.Model.DescribeCommunicationsRequest
Namespace: Amazon.AWSSupport.Model
Assembly: AWSSDK.AWSSupport.dll
Version: 3.x.y.z
Syntax
public class DescribeCommunicationsRequest : AmazonAWSSupportRequest IAmazonWebServiceRequest
The DescribeCommunicationsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DescribeCommunicationsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AfterTime | System.String |
Gets and sets the property AfterTime. The start date for a filtered date search on support case communications. Case communications are available for 24 months after creation. |
|
|
BeforeTime | System.String |
Gets and sets the property BeforeTime. The end date for a filtered date search on support case communications. Case communications are available for 24 months after creation. |
|
|
CaseId | System.String |
Gets and sets the property CaseId. The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-exen-2025-c4c1d2bf33c5cf47 |
|
|
DryRun | System.Nullable<System.Boolean> |
Gets and sets the property DryRun.
Specifies whether to validate the request without actually returning communications.
When set to |
|
|
MaxResults | System.Nullable<System.Int32> |
Gets and sets the property MaxResults. The maximum number of results to return before paginating. |
|
|
NextToken | System.String |
Gets and sets the property NextToken. A resumption point for pagination. |
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