Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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:
- One or more CaseDetails data types.
- One or more
NextToken
values, which specify where to paginate the returned records represented by theCaseDetails
objects.
See: AWS API Reference for DescribeCases.
This operation returns paginated results.
- describeCases :: DescribeCases
- data DescribeCases
- dcIncludeResolvedCases :: Lens' DescribeCases (Maybe Bool)
- dcCaseIdList :: Lens' DescribeCases [Text]
- dcAfterTime :: Lens' DescribeCases (Maybe Text)
- dcBeforeTime :: Lens' DescribeCases (Maybe Text)
- dcNextToken :: Lens' DescribeCases (Maybe Text)
- dcIncludeCommunications :: Lens' DescribeCases (Maybe Bool)
- dcDisplayId :: Lens' DescribeCases (Maybe Text)
- dcLanguage :: Lens' DescribeCases (Maybe Text)
- dcMaxResults :: Lens' DescribeCases (Maybe Natural)
- describeCasesResponse :: Int -> DescribeCasesResponse
- data DescribeCasesResponse
- drsCases :: Lens' DescribeCasesResponse [CaseDetails]
- drsNextToken :: Lens' DescribeCasesResponse (Maybe Text)
- drsResponseStatus :: Lens' DescribeCasesResponse Int
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:
data DescribeCases Source
See: describeCases
smart constructor.
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
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.
drsResponseStatus :: Lens' DescribeCasesResponse Int Source
The response status code.