amazonka-support-1.3.2: Amazon Support SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Support.DescribeCases

Contents

Description

Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the AfterTime and BeforeTime request parameters. You can set values for the IncludeResolvedCases and IncludeCommunications request parameters to control how much information is returned.

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

The response returns the following in JSON format:

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

See: AWS API Reference for DescribeCases.

This operation returns paginated results.

Synopsis

Creating a Request

describeCases :: DescribeCases Source

Creates a value of DescribeCases with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Request Lenses

dcIncludeResolvedCases :: Lens' DescribeCases (Maybe Bool) Source

Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.

dcCaseIdList :: Lens' DescribeCases [Text] Source

A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

dcAfterTime :: Lens' DescribeCases (Maybe Text) Source

The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

dcBeforeTime :: Lens' DescribeCases (Maybe Text) Source

The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

dcNextToken :: Lens' DescribeCases (Maybe Text) Source

A resumption point for pagination.

dcIncludeCommunications :: Lens' DescribeCases (Maybe Bool) Source

Specifies whether communications should be included in the DescribeCases results. The default is true.

dcDisplayId :: Lens' DescribeCases (Maybe Text) Source

The ID displayed for a case in the AWS Support Center user interface.

dcLanguage :: Lens' DescribeCases (Maybe Text) Source

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.

dcMaxResults :: Lens' DescribeCases (Maybe Natural) Source

The maximum number of results to return before paginating.

Destructuring the Response

describeCasesResponse Source

Creates a value of DescribeCasesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data DescribeCasesResponse Source

Returns an array of CaseDetails objects and a NextToken that defines a point for pagination in the result set.

See: describeCasesResponse smart constructor.

Response Lenses

drsCases :: Lens' DescribeCasesResponse [CaseDetails] Source

The details for the cases that match the request.

drsNextToken :: Lens' DescribeCasesResponse (Maybe Text) Source

A resumption point for pagination.