| 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 |
Network.AWS.Support.DescribeCommunications
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.
See: AWS API Reference for DescribeCommunications.
This operation returns paginated results.
- describeCommunications :: Text -> DescribeCommunications
- data DescribeCommunications
- dAfterTime :: Lens' DescribeCommunications (Maybe Text)
- dBeforeTime :: Lens' DescribeCommunications (Maybe Text)
- dNextToken :: Lens' DescribeCommunications (Maybe Text)
- dMaxResults :: Lens' DescribeCommunications (Maybe Natural)
- dCaseId :: Lens' DescribeCommunications Text
- describeCommunicationsResponse :: Int -> DescribeCommunicationsResponse
- data DescribeCommunicationsResponse
- dcrsNextToken :: Lens' DescribeCommunicationsResponse (Maybe Text)
- dcrsCommunications :: Lens' DescribeCommunicationsResponse [Communication]
- dcrsResponseStatus :: Lens' DescribeCommunicationsResponse Int
Creating a Request
Arguments
| :: Text | |
| -> 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:
data DescribeCommunications Source
See: describeCommunications smart constructor.
Instances
Request Lenses
dAfterTime :: Lens' DescribeCommunications (Maybe Text) Source
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) Source
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) Source
A resumption point for pagination.
dMaxResults :: Lens' DescribeCommunications (Maybe Natural) Source
The maximum number of results to return before paginating.
dCaseId :: Lens' DescribeCommunications Text Source
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 Source
Arguments
| :: Int | |
| -> 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 Source
The communications returned by the DescribeCommunications operation.
See: describeCommunicationsResponse smart constructor.
Response Lenses
dcrsNextToken :: Lens' DescribeCommunicationsResponse (Maybe Text) Source
A resumption point for pagination.
dcrsCommunications :: Lens' DescribeCommunicationsResponse [Communication] Source
The communications for the case.
dcrsResponseStatus :: Lens' DescribeCommunicationsResponse Int Source
The response status code.