AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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:

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

  • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

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

C#
public class DescribeCasesRequest : AmazonAWSSupportRequest
         IAmazonWebServiceRequest

The DescribeCasesRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeCasesRequest()

Properties

NameTypeDescription
Public Property 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 12 months after creation.

Public Property 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 12 months after creation.

Public Property 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.

Public Property DisplayId System.String

Gets and sets the property DisplayId.

The ID displayed for a case in the Amazon Web Services Support Center user interface.

Public Property IncludeCommunications System.Boolean

Gets and sets the property IncludeCommunications.

Specifies whether to include communications in the DescribeCases response. By default, communications are included.

Public Property IncludeResolvedCases 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.

Public Property 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") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

The maximum number of results to return before paginating.

Public Property NextToken System.String

Gets and sets the property NextToken.

A resumption point for pagination.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5