Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Support.DescribeCommunications

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns communications and attachments for one or more support cases. Use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a specific 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 results. Set maxResults to the number of cases that you want to display on each page, and use nextToken to specify the resumption of pagination.

You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeCommunications Source #

See: newDescribeCommunications smart constructor.

Constructors

DescribeCommunications'

Fields

afterTime :: Maybe Text
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
beforeTime :: Maybe Text
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
maxResults :: Maybe Natural
The maximum number of results to return before paginating.
nextToken :: Maybe Text
A resumption point for pagination.
caseId :: Text
The 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

Instances

Instances details

ToJSON DescribeCommunications Source #
Instance details Defined in Amazonka.Support.DescribeCommunications Methods toJSON :: DescribeCommunications -> Value # toEncoding :: DescribeCommunications -> Encoding # toJSONList :: [DescribeCommunications] -> Value # toEncodingList :: [DescribeCommunications] -> Encoding #
ToHeaders DescribeCommunications Source #
Instance details Defined in Amazonka.Support.DescribeCommunications Methods toHeaders :: DescribeCommunications -> [Header] #
ToPath DescribeCommunications Source #
Instance details Defined in Amazonka.Support.DescribeCommunications Methods toPath :: DescribeCommunications -> ByteString #
ToQuery DescribeCommunications Source #
Instance details Defined in Amazonka.Support.DescribeCommunications Methods toQuery :: DescribeCommunications -> QueryString #
AWSPager DescribeCommunications Source #
Instance details Defined in Amazonka.Support.DescribeCommunications Methods page :: DescribeCommunications -> AWSResponse DescribeCommunications -> Maybe DescribeCommunications #
AWSRequest DescribeCommunications Source #
Instance details Defined in Amazonka.Support.DescribeCommunications Associated Types type AWSResponse DescribeCommunications # Methods request :: (Service -> Service) -> DescribeCommunications -> Request DescribeCommunications # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeCommunications -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeCommunications))) #
Generic DescribeCommunications Source #
Instance details Defined in Amazonka.Support.DescribeCommunications Associated Types type Rep DescribeCommunications :: Type -> Type # Methods from :: DescribeCommunications -> Rep DescribeCommunications x # to :: Rep DescribeCommunications x -> DescribeCommunications #
Read DescribeCommunications Source #
Instance details Defined in Amazonka.Support.DescribeCommunications Methods readsPrec :: Int -> ReadS DescribeCommunications # readList :: ReadS [DescribeCommunications] # readPrec :: ReadPrec DescribeCommunications # readListPrec :: ReadPrec [DescribeCommunications] #
Show DescribeCommunications Source #
Instance details Defined in Amazonka.Support.DescribeCommunications Methods showsPrec :: Int -> DescribeCommunications -> ShowS # show :: DescribeCommunications -> String # showList :: [DescribeCommunications] -> ShowS #
NFData DescribeCommunications Source #
Instance details Defined in Amazonka.Support.DescribeCommunications Methods rnf :: DescribeCommunications -> () #
Eq DescribeCommunications Source #
Instance details Defined in Amazonka.Support.DescribeCommunications Methods (==) :: DescribeCommunications -> DescribeCommunications -> Bool # (/=) :: DescribeCommunications -> DescribeCommunications -> Bool #
Hashable DescribeCommunications Source #
Instance details Defined in Amazonka.Support.DescribeCommunications Methods hashWithSalt :: Int -> DescribeCommunications -> Int # hash :: DescribeCommunications -> Int #
type AWSResponse DescribeCommunications Source #
Instance details Defined in Amazonka.Support.DescribeCommunications type AWSResponse DescribeCommunications = DescribeCommunicationsResponse
type Rep DescribeCommunications Source #
Instance details Defined in Amazonka.Support.DescribeCommunications type Rep DescribeCommunications = D1 ('MetaData "DescribeCommunications" "Amazonka.Support.DescribeCommunications" "amazonka-support-2.0-LbNYGbwzg4MCCJkN4B0nCH" 'False) (C1 ('MetaCons "DescribeCommunications'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "afterTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "beforeTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "caseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribeCommunications Source #

Arguments

:: Text	`DescribeCommunications`
-> DescribeCommunications

Create a value of DescribeCommunications with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:afterTime:DescribeCommunications', describeCommunications_afterTime - The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

$sel:beforeTime:DescribeCommunications', describeCommunications_beforeTime - The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

$sel:maxResults:DescribeCommunications', describeCommunications_maxResults - The maximum number of results to return before paginating.

DescribeCommunications, describeCommunications_nextToken - A resumption point for pagination.

DescribeCommunications, describeCommunications_caseId - The 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

Request Lenses

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

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

describeCommunications_maxResults :: Lens' DescribeCommunications (Maybe Natural) Source #

The maximum number of results to return before paginating.

describeCommunications_nextToken :: Lens' DescribeCommunications (Maybe Text) Source #

A resumption point for pagination.

describeCommunications_caseId :: Lens' DescribeCommunications Text Source #

The 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

data DescribeCommunicationsResponse Source #

The communications returned by the DescribeCommunications operation.

See: newDescribeCommunicationsResponse smart constructor.

Constructors

DescribeCommunicationsResponse'
Fields communications :: Maybe [Communication] The communications for the case. nextToken :: Maybe Text A resumption point for pagination. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeCommunicationsResponse Source #
Instance details Defined in Amazonka.Support.DescribeCommunications Associated Types type Rep DescribeCommunicationsResponse :: Type -> Type # Methods from :: DescribeCommunicationsResponse -> Rep DescribeCommunicationsResponse x # to :: Rep DescribeCommunicationsResponse x -> DescribeCommunicationsResponse #
Read DescribeCommunicationsResponse Source #
Instance details Defined in Amazonka.Support.DescribeCommunications Methods readsPrec :: Int -> ReadS DescribeCommunicationsResponse # readList :: ReadS [DescribeCommunicationsResponse] # readPrec :: ReadPrec DescribeCommunicationsResponse # readListPrec :: ReadPrec [DescribeCommunicationsResponse] #
Show DescribeCommunicationsResponse Source #
Instance details Defined in Amazonka.Support.DescribeCommunications Methods showsPrec :: Int -> DescribeCommunicationsResponse -> ShowS # show :: DescribeCommunicationsResponse -> String # showList :: [DescribeCommunicationsResponse] -> ShowS #
NFData DescribeCommunicationsResponse Source #
Instance details Defined in Amazonka.Support.DescribeCommunications Methods rnf :: DescribeCommunicationsResponse -> () #
Eq DescribeCommunicationsResponse Source #
Instance details Defined in Amazonka.Support.DescribeCommunications Methods (==) :: DescribeCommunicationsResponse -> DescribeCommunicationsResponse -> Bool # (/=) :: DescribeCommunicationsResponse -> DescribeCommunicationsResponse -> Bool #
type Rep DescribeCommunicationsResponse Source #
Instance details Defined in Amazonka.Support.DescribeCommunications type Rep DescribeCommunicationsResponse = D1 ('MetaData "DescribeCommunicationsResponse" "Amazonka.Support.DescribeCommunications" "amazonka-support-2.0-LbNYGbwzg4MCCJkN4B0nCH" 'False) (C1 ('MetaCons "DescribeCommunicationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "communications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Communication])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeCommunicationsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeCommunicationsResponse'`
-> DescribeCommunicationsResponse

Create a value of DescribeCommunicationsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeCommunicationsResponse, describeCommunicationsResponse_communications - The communications for the case.

DescribeCommunications, describeCommunicationsResponse_nextToken - A resumption point for pagination.

$sel:httpStatus:DescribeCommunicationsResponse', describeCommunicationsResponse_httpStatus - The response's http status code.

Response Lenses

describeCommunicationsResponse_communications :: Lens' DescribeCommunicationsResponse (Maybe [Communication]) Source #

The communications for the case.

describeCommunicationsResponse_nextToken :: Lens' DescribeCommunicationsResponse (Maybe Text) Source #

A resumption point for pagination.

describeCommunicationsResponse_httpStatus :: Lens' DescribeCommunicationsResponse Int Source #

The response's http status code.