amazonka-support-1.4.5: Amazon Support SDK.

Copyright(c) 2013-2016 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:

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

This operation returns paginated results.

Synopsis

Creating a Request

describeCases :: DescribeCases #

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:

  • dcIncludeResolvedCases - Specifies whether resolved support cases should be included in the DescribeCases results. The default is false .
  • dcCaseIdList - A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
  • dcAfterTime - The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
  • dcBeforeTime - The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
  • dcNextToken - A resumption point for pagination.
  • dcIncludeCommunications - Specifies whether communications should be included in the DescribeCases results. The default is true .
  • dcDisplayId - The ID displayed for a case in the AWS Support Center user interface.
  • dcLanguage - 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 - The maximum number of results to return before paginating.

data DescribeCases #

See: describeCases smart constructor.

Instances

Eq DescribeCases # 
Data DescribeCases # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeCases -> c DescribeCases #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeCases #

toConstr :: DescribeCases -> Constr #

dataTypeOf :: DescribeCases -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeCases) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeCases) #

gmapT :: (forall b. Data b => b -> b) -> DescribeCases -> DescribeCases #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeCases -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeCases -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeCases -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeCases -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeCases -> m DescribeCases #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeCases -> m DescribeCases #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeCases -> m DescribeCases #

Read DescribeCases # 
Show DescribeCases # 
Generic DescribeCases # 

Associated Types

type Rep DescribeCases :: * -> * #

Hashable DescribeCases # 
ToJSON DescribeCases # 
NFData DescribeCases # 

Methods

rnf :: DescribeCases -> () #

AWSPager DescribeCases # 
AWSRequest DescribeCases # 
ToQuery DescribeCases # 
ToPath DescribeCases # 
ToHeaders DescribeCases # 
type Rep DescribeCases # 
type Rs DescribeCases # 

Request Lenses

dcIncludeResolvedCases :: Lens' DescribeCases (Maybe Bool) #

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

dcCaseIdList :: Lens' DescribeCases [Text] #

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

dcAfterTime :: Lens' DescribeCases (Maybe Text) #

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) #

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) #

A resumption point for pagination.

dcIncludeCommunications :: Lens' DescribeCases (Maybe Bool) #

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

dcDisplayId :: Lens' DescribeCases (Maybe Text) #

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

dcLanguage :: Lens' DescribeCases (Maybe Text) #

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) #

The maximum number of results to return before paginating.

Destructuring the Response

describeCasesResponse #

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 #

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

See: describeCasesResponse smart constructor.

Instances

Eq DescribeCasesResponse # 
Data DescribeCasesResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeCasesResponse -> c DescribeCasesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeCasesResponse #

toConstr :: DescribeCasesResponse -> Constr #

dataTypeOf :: DescribeCasesResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeCasesResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeCasesResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeCasesResponse -> DescribeCasesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeCasesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeCasesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeCasesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeCasesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeCasesResponse -> m DescribeCasesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeCasesResponse -> m DescribeCasesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeCasesResponse -> m DescribeCasesResponse #

Read DescribeCasesResponse # 
Show DescribeCasesResponse # 
Generic DescribeCasesResponse # 
NFData DescribeCasesResponse # 

Methods

rnf :: DescribeCasesResponse -> () #

type Rep DescribeCasesResponse # 
type Rep DescribeCasesResponse = D1 (MetaData "DescribeCasesResponse" "Network.AWS.Support.DescribeCases" "amazonka-support-1.4.5-LmQIPNTI7OzCplN8wzzWV7" False) (C1 (MetaCons "DescribeCasesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_drsCases") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CaseDetails]))) ((:*:) (S1 (MetaSel (Just Symbol "_drsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_drsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

drsCases :: Lens' DescribeCasesResponse [CaseDetails] #

The details for the cases that match the request.

drsNextToken :: Lens' DescribeCasesResponse (Maybe Text) #

A resumption point for pagination.

drsResponseStatus :: Lens' DescribeCasesResponse Int #

  • - | The response status code.