Network.AWS.Support.DescribeCommunications

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.

Creating a Request

describeCommunications

Arguments

:: Text

dCaseId

-> 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
• dBeforeTime
• dNextToken
• dMaxResults
• dCaseId

data DescribeCommunications

See: describeCommunications smart constructor.

Instances

Eq DescribeCommunications

Methods

(==) :: DescribeCommunications -> DescribeCommunications -> Bool

(/=) :: DescribeCommunications -> DescribeCommunications -> Bool

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

Methods

readsPrec :: Int -> ReadS DescribeCommunications

readList :: ReadS [DescribeCommunications]

readPrec :: ReadPrec DescribeCommunications

readListPrec :: ReadPrec [DescribeCommunications]

Show DescribeCommunications

Methods

showsPrec :: Int -> DescribeCommunications -> ShowS

show :: DescribeCommunications -> String

showList :: [DescribeCommunications] -> ShowS

Generic DescribeCommunications

Associated Types

type Rep DescribeCommunications :: * -> *

Methods

from :: DescribeCommunications -> Rep DescribeCommunications x

to :: Rep DescribeCommunications x -> DescribeCommunications

Hashable DescribeCommunications

Methods

hashWithSalt :: Int -> DescribeCommunications -> Int

hash :: DescribeCommunications -> Int

ToJSON DescribeCommunications

Methods

toJSON :: DescribeCommunications -> Value

toEncoding :: DescribeCommunications -> Encoding

toJSONList :: [DescribeCommunications] -> Value

toEncodingList :: [DescribeCommunications] -> Encoding

NFData DescribeCommunications

Methods

rnf :: DescribeCommunications -> ()

AWSPager DescribeCommunications

Methods

page :: DescribeCommunications -> Rs DescribeCommunications -> Maybe DescribeCommunications

AWSRequest DescribeCommunications

Associated Types

type Rs DescribeCommunications :: *

Methods

request :: DescribeCommunications -> Request DescribeCommunications

response :: MonadResource m => Logger -> Service -> Proxy * DescribeCommunications -> ClientResponse -> m (Response DescribeCommunications)

ToQuery DescribeCommunications

Methods

toQuery :: DescribeCommunications -> QueryString

ToPath DescribeCommunications

Methods

toPath :: DescribeCommunications -> ByteString

ToHeaders DescribeCommunications

Methods

toHeaders :: DescribeCommunications -> [Header]

type Rep DescribeCommunications

type Rep DescribeCommunications = D1 (MetaData "DescribeCommunications" "Network.AWS.Support.DescribeCommunications" "amazonka-support-1.4.1-LTIX5uJntX0LNU8CzhRGbQ" 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

type Rs DescribeCommunications = DescribeCommunicationsResponse

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

Arguments

:: Int

dcrsResponseStatus

-> 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:

• dcrsNextToken
• dcrsCommunications
• dcrsResponseStatus

data DescribeCommunicationsResponse

The communications returned by the DescribeCommunications operation.

See: describeCommunicationsResponse smart constructor.

Instances

Eq DescribeCommunicationsResponse

Methods

(==) :: DescribeCommunicationsResponse -> DescribeCommunicationsResponse -> Bool

(/=) :: DescribeCommunicationsResponse -> DescribeCommunicationsResponse -> Bool

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

Methods

readsPrec :: Int -> ReadS DescribeCommunicationsResponse

readList :: ReadS [DescribeCommunicationsResponse]

readPrec :: ReadPrec DescribeCommunicationsResponse

readListPrec :: ReadPrec [DescribeCommunicationsResponse]

Show DescribeCommunicationsResponse

Methods

showsPrec :: Int -> DescribeCommunicationsResponse -> ShowS

show :: DescribeCommunicationsResponse -> String

showList :: [DescribeCommunicationsResponse] -> ShowS

Generic DescribeCommunicationsResponse

Associated Types

type Rep DescribeCommunicationsResponse :: * -> *

Methods

from :: DescribeCommunicationsResponse -> Rep DescribeCommunicationsResponse x

to :: Rep DescribeCommunicationsResponse x -> DescribeCommunicationsResponse

NFData DescribeCommunicationsResponse

Methods

rnf :: DescribeCommunicationsResponse -> ()

type Rep DescribeCommunicationsResponse

type Rep DescribeCommunicationsResponse = D1 (MetaData "DescribeCommunicationsResponse" "Network.AWS.Support.DescribeCommunications" "amazonka-support-1.4.1-LTIX5uJntX0LNU8CzhRGbQ" 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 DecidedStrict) (Rec0 Int)))))

Response Lenses

dcrsNextToken :: Lens' DescribeCommunicationsResponse (Maybe Text)

A resumption point for pagination.

dcrsCommunications :: Lens' DescribeCommunicationsResponse [Communication]

The communications for the case.

dcrsResponseStatus :: Lens' DescribeCommunicationsResponse Int

The response status code.