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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime and beforeTime parameters to filter the cases by date. You can set values for the includeResolvedCases and includeCommunications parameters to specify how much information to return.

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.

Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.

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

data DescribeCases = DescribeCases' {
- afterTime :: Maybe Text
- beforeTime :: Maybe Text
- caseIdList :: Maybe [Text]
- displayId :: Maybe Text
- includeCommunications :: Maybe Bool
- includeResolvedCases :: Maybe Bool
- language :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newDescribeCases :: DescribeCases
describeCases_afterTime :: Lens' DescribeCases (Maybe Text)
describeCases_beforeTime :: Lens' DescribeCases (Maybe Text)
describeCases_caseIdList :: Lens' DescribeCases (Maybe [Text])
describeCases_displayId :: Lens' DescribeCases (Maybe Text)
describeCases_includeCommunications :: Lens' DescribeCases (Maybe Bool)
describeCases_includeResolvedCases :: Lens' DescribeCases (Maybe Bool)
describeCases_language :: Lens' DescribeCases (Maybe Text)
describeCases_maxResults :: Lens' DescribeCases (Maybe Natural)
describeCases_nextToken :: Lens' DescribeCases (Maybe Text)
data DescribeCasesResponse = DescribeCasesResponse' {
- cases :: Maybe [CaseDetails]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeCasesResponse :: Int -> DescribeCasesResponse
describeCasesResponse_cases :: Lens' DescribeCasesResponse (Maybe [CaseDetails])
describeCasesResponse_nextToken :: Lens' DescribeCasesResponse (Maybe Text)
describeCasesResponse_httpStatus :: Lens' DescribeCasesResponse Int

Creating a Request

data DescribeCases Source #

See: newDescribeCases smart constructor.

Constructors

DescribeCases'

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.
caseIdList :: Maybe [Text]
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
displayId :: Maybe Text
The ID displayed for a case in the Amazon Web Services Support Center user interface.
includeCommunications :: Maybe Bool
Specifies whether to include communications in the DescribeCases response. By default, communications are included.
includeResolvedCases :: Maybe Bool
Specifies whether to include resolved support cases in the DescribeCases response. By default, resolved cases aren't included.
language :: Maybe Text
The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). You must specify the ISO 639-1 code for the language parameter if you want support in that language.
maxResults :: Maybe Natural
The maximum number of results to return before paginating.
nextToken :: Maybe Text
A resumption point for pagination.

Instances

Instances details

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

newDescribeCases :: DescribeCases Source #

Create a value of DescribeCases 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:DescribeCases', describeCases_afterTime - The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

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

$sel:caseIdList:DescribeCases', describeCases_caseIdList - A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

DescribeCases, describeCases_displayId - The ID displayed for a case in the Amazon Web Services Support Center user interface.

$sel:includeCommunications:DescribeCases', describeCases_includeCommunications - Specifies whether to include communications in the DescribeCases response. By default, communications are included.

$sel:includeResolvedCases:DescribeCases', describeCases_includeResolvedCases - Specifies whether to include resolved support cases in the DescribeCases response. By default, resolved cases aren't included.

DescribeCases, describeCases_language - The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

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

DescribeCases, describeCases_nextToken - A resumption point for pagination.

Request Lenses

describeCases_afterTime :: Lens' DescribeCases (Maybe Text) Source #

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

describeCases_beforeTime :: Lens' DescribeCases (Maybe Text) Source #

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

describeCases_caseIdList :: Lens' DescribeCases (Maybe [Text]) Source #

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

describeCases_displayId :: Lens' DescribeCases (Maybe Text) Source #

The ID displayed for a case in the Amazon Web Services Support Center user interface.

describeCases_includeCommunications :: Lens' DescribeCases (Maybe Bool) Source #

Specifies whether to include communications in the DescribeCases response. By default, communications are included.

describeCases_includeResolvedCases :: Lens' DescribeCases (Maybe Bool) Source #

Specifies whether to include resolved support cases in the DescribeCases response. By default, resolved cases aren't included.

describeCases_language :: Lens' DescribeCases (Maybe Text) Source #

The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

describeCases_maxResults :: Lens' DescribeCases (Maybe Natural) Source #

The maximum number of results to return before paginating.

describeCases_nextToken :: Lens' DescribeCases (Maybe Text) Source #

A resumption point for pagination.

Destructuring the Response

data DescribeCasesResponse Source #

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

See: newDescribeCasesResponse smart constructor.

Constructors

DescribeCasesResponse'
Fields cases :: Maybe [CaseDetails] The details for the cases that match the request. nextToken :: Maybe Text A resumption point for pagination. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeCasesResponse Source #

Arguments

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

Create a value of DescribeCasesResponse 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:cases:DescribeCasesResponse', describeCasesResponse_cases - The details for the cases that match the request.

DescribeCases, describeCasesResponse_nextToken - A resumption point for pagination.

$sel:httpStatus:DescribeCasesResponse', describeCasesResponse_httpStatus - The response's http status code.

Response Lenses

describeCasesResponse_cases :: Lens' DescribeCasesResponse (Maybe [CaseDetails]) Source #

The details for the cases that match the request.

describeCasesResponse_nextToken :: Lens' DescribeCasesResponse (Maybe Text) Source #

A resumption point for pagination.

describeCasesResponse_httpStatus :: Lens' DescribeCasesResponse Int Source #

The response's http status code.