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.DescribeCommunications

Contents

Description

Returns communications (and attachments) for one or more support cases. You can use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a particular case.

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.

You can use the maxResults and nextToken parameters to control the pagination of the result set. Set maxResults to the number of cases you want displayed on each page, and use nextToken to specify the resumption of pagination.

This operation returns paginated results.

Synopsis

Creating a Request

describeCommunications #

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

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

  • dAfterTime - The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
  • dBeforeTime - The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
  • dNextToken - A resumption point for pagination.
  • dMaxResults - The maximum number of results to return before paginating.
  • dCaseId - The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

data DescribeCommunications #

See: describeCommunications smart constructor.

Instances

Eq DescribeCommunications # 
Data DescribeCommunications # 

Methods

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

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

toConstr :: DescribeCommunications -> Constr #

dataTypeOf :: DescribeCommunications -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeCommunications # 
Show DescribeCommunications # 
Generic DescribeCommunications # 
Hashable DescribeCommunications # 
ToJSON DescribeCommunications # 
NFData DescribeCommunications # 

Methods

rnf :: DescribeCommunications -> () #

AWSPager DescribeCommunications # 
AWSRequest DescribeCommunications # 
ToQuery DescribeCommunications # 
ToPath DescribeCommunications # 
ToHeaders DescribeCommunications # 
type Rep DescribeCommunications # 
type Rep DescribeCommunications = D1 (MetaData "DescribeCommunications" "Network.AWS.Support.DescribeCommunications" "amazonka-support-1.4.5-LmQIPNTI7OzCplN8wzzWV7" False) (C1 (MetaCons "DescribeCommunications'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dAfterTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dBeforeTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_dCaseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs DescribeCommunications # 

Request Lenses

dAfterTime :: Lens' DescribeCommunications (Maybe Text) #

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

dBeforeTime :: Lens' DescribeCommunications (Maybe Text) #

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

dNextToken :: Lens' DescribeCommunications (Maybe Text) #

A resumption point for pagination.

dMaxResults :: Lens' DescribeCommunications (Maybe Natural) #

The maximum number of results to return before paginating.

dCaseId :: Lens' DescribeCommunications Text #

The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

Destructuring the Response

describeCommunicationsResponse #

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

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

data DescribeCommunicationsResponse #

The communications returned by the DescribeCommunications operation.

See: describeCommunicationsResponse smart constructor.

Instances

Eq DescribeCommunicationsResponse # 
Data DescribeCommunicationsResponse # 

Methods

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

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

toConstr :: DescribeCommunicationsResponse -> Constr #

dataTypeOf :: DescribeCommunicationsResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeCommunicationsResponse # 
Show DescribeCommunicationsResponse # 
Generic DescribeCommunicationsResponse # 
NFData DescribeCommunicationsResponse # 
type Rep DescribeCommunicationsResponse # 
type Rep DescribeCommunicationsResponse = D1 (MetaData "DescribeCommunicationsResponse" "Network.AWS.Support.DescribeCommunications" "amazonka-support-1.4.5-LmQIPNTI7OzCplN8wzzWV7" False) (C1 (MetaCons "DescribeCommunicationsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dcrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dcrsCommunications") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Communication]))) (S1 (MetaSel (Just Symbol "_dcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

dcrsNextToken :: Lens' DescribeCommunicationsResponse (Maybe Text) #

A resumption point for pagination.