DescribeCasesRequest Class | AWS SDK for .NET Version 4

Container for the parameters to the DescribeCases operation. Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime and beforeTime parameters to filter the cases by date. You can set values for the includeResolvedCases and includeCommunications parameters to specify how much information to return.

The response returns the following in JSON format:

One or more CaseDetails data types.
One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.

Case data is available for 24 months after creation. If a case was created more than 24 months ago, a request might return an error.

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.

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

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

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

Syntax

public class DescribeCasesRequest : AmazonAWSSupportRequest
         IAmazonWebServiceRequest

The DescribeCasesRequest type exposes the following members

Constructors

	Name	Description
	DescribeCasesRequest()

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.
CaseIdList	System.Collections.Generic.List<System.String>	Gets and sets the property CaseIdList. A list of ID numbers of the support cases you want returned. The maximum number of cases is 100. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
DisplayId	System.String	Gets and sets the property DisplayId. The ID displayed for a case in the Amazon Web Services Support Center user interface.
DryRun	System.Nullable<System.Boolean>	Gets and sets the property DryRun. Specifies whether to validate the request without actually returning case data. When set to `true`, the request is validated but no cases are returned, and the operation returns a `DryRunOperationException`. When omitted or set to `false`, the request runs normally.
IncludeCommunications	System.Nullable<System.Boolean>	Gets and sets the property IncludeCommunications. Specifies whether to include communications in the `DescribeCases` response. By default, communications are included.
IncludeResolvedCases	System.Nullable<System.Boolean>	Gets and sets the property IncludeResolvedCases. Specifies whether to include resolved support cases in the `DescribeCases` response. By default, resolved cases aren't included.
Language	System.String	Gets and sets the property Language. The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") , Chinese ("zh"), Spanish ("es"), Portuguese ("pt"), French ("fr"), Korean (“ko”), and Turkish ("tr"). You must specify the ISO 639-1 code for the `language` parameter if you want support in that language.
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