{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Support.DescribeCases
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- 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
--     <https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html 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
--     <http://aws.amazon.com/premiumsupport/ Amazon Web Services Support>.
--
-- This operation returns paginated results.
module Amazonka.Support.DescribeCases
  ( -- * Creating a Request
    DescribeCases (..),
    newDescribeCases,

    -- * Request Lenses
    describeCases_afterTime,
    describeCases_beforeTime,
    describeCases_caseIdList,
    describeCases_displayId,
    describeCases_includeCommunications,
    describeCases_includeResolvedCases,
    describeCases_language,
    describeCases_maxResults,
    describeCases_nextToken,

    -- * Destructuring the Response
    DescribeCasesResponse (..),
    newDescribeCasesResponse,

    -- * Response Lenses
    describeCasesResponse_cases,
    describeCasesResponse_nextToken,
    describeCasesResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.Support.Types

-- | /See:/ 'newDescribeCases' smart constructor.
data DescribeCases = DescribeCases'
  { -- | The start date for a filtered date search on support case
    -- communications. Case communications are available for 12 months after
    -- creation.
    DescribeCases -> Maybe Text
afterTime :: Prelude.Maybe Prelude.Text,
    -- | The end date for a filtered date search on support case communications.
    -- Case communications are available for 12 months after creation.
    DescribeCases -> Maybe Text
beforeTime :: Prelude.Maybe Prelude.Text,
    -- | A list of ID numbers of the support cases you want returned. The maximum
    -- number of cases is 100.
    DescribeCases -> Maybe [Text]
caseIdList :: Prelude.Maybe [Prelude.Text],
    -- | The ID displayed for a case in the Amazon Web Services Support Center
    -- user interface.
    DescribeCases -> Maybe Text
displayId :: Prelude.Maybe Prelude.Text,
    -- | Specifies whether to include communications in the @DescribeCases@
    -- response. By default, communications are included.
    DescribeCases -> Maybe Bool
includeCommunications :: Prelude.Maybe Prelude.Bool,
    -- | Specifies whether to include resolved support cases in the
    -- @DescribeCases@ response. By default, resolved cases aren\'t included.
    DescribeCases -> Maybe Bool
includeResolvedCases :: Prelude.Maybe Prelude.Bool,
    -- | 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 -> Maybe Text
language :: Prelude.Maybe Prelude.Text,
    -- | The maximum number of results to return before paginating.
    DescribeCases -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | A resumption point for pagination.
    DescribeCases -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (DescribeCases -> DescribeCases -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeCases -> DescribeCases -> Bool
$c/= :: DescribeCases -> DescribeCases -> Bool
== :: DescribeCases -> DescribeCases -> Bool
$c== :: DescribeCases -> DescribeCases -> Bool
Prelude.Eq, ReadPrec [DescribeCases]
ReadPrec DescribeCases
Int -> ReadS DescribeCases
ReadS [DescribeCases]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeCases]
$creadListPrec :: ReadPrec [DescribeCases]
readPrec :: ReadPrec DescribeCases
$creadPrec :: ReadPrec DescribeCases
readList :: ReadS [DescribeCases]
$creadList :: ReadS [DescribeCases]
readsPrec :: Int -> ReadS DescribeCases
$creadsPrec :: Int -> ReadS DescribeCases
Prelude.Read, Int -> DescribeCases -> ShowS
[DescribeCases] -> ShowS
DescribeCases -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeCases] -> ShowS
$cshowList :: [DescribeCases] -> ShowS
show :: DescribeCases -> String
$cshow :: DescribeCases -> String
showsPrec :: Int -> DescribeCases -> ShowS
$cshowsPrec :: Int -> DescribeCases -> ShowS
Prelude.Show, forall x. Rep DescribeCases x -> DescribeCases
forall x. DescribeCases -> Rep DescribeCases x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeCases x -> DescribeCases
$cfrom :: forall x. DescribeCases -> Rep DescribeCases x
Prelude.Generic)

-- |
-- Create a value of 'DescribeCases' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'afterTime', 'describeCases_afterTime' - The start date for a filtered date search on support case
-- communications. Case communications are available for 12 months after
-- creation.
--
-- 'beforeTime', 'describeCases_beforeTime' - The end date for a filtered date search on support case communications.
-- Case communications are available for 12 months after creation.
--
-- 'caseIdList', 'describeCases_caseIdList' - A list of ID numbers of the support cases you want returned. The maximum
-- number of cases is 100.
--
-- 'displayId', 'describeCases_displayId' - The ID displayed for a case in the Amazon Web Services Support Center
-- user interface.
--
-- 'includeCommunications', 'describeCases_includeCommunications' - Specifies whether to include communications in the @DescribeCases@
-- response. By default, communications are included.
--
-- 'includeResolvedCases', 'describeCases_includeResolvedCases' - Specifies whether to include resolved support cases in the
-- @DescribeCases@ response. By default, resolved cases aren\'t included.
--
-- 'language', '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.
--
-- 'maxResults', 'describeCases_maxResults' - The maximum number of results to return before paginating.
--
-- 'nextToken', 'describeCases_nextToken' - A resumption point for pagination.
newDescribeCases ::
  DescribeCases
newDescribeCases :: DescribeCases
newDescribeCases =
  DescribeCases'
    { $sel:afterTime:DescribeCases' :: Maybe Text
afterTime = forall a. Maybe a
Prelude.Nothing,
      $sel:beforeTime:DescribeCases' :: Maybe Text
beforeTime = forall a. Maybe a
Prelude.Nothing,
      $sel:caseIdList:DescribeCases' :: Maybe [Text]
caseIdList = forall a. Maybe a
Prelude.Nothing,
      $sel:displayId:DescribeCases' :: Maybe Text
displayId = forall a. Maybe a
Prelude.Nothing,
      $sel:includeCommunications:DescribeCases' :: Maybe Bool
includeCommunications = forall a. Maybe a
Prelude.Nothing,
      $sel:includeResolvedCases:DescribeCases' :: Maybe Bool
includeResolvedCases = forall a. Maybe a
Prelude.Nothing,
      $sel:language:DescribeCases' :: Maybe Text
language = forall a. Maybe a
Prelude.Nothing,
      $sel:maxResults:DescribeCases' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeCases' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | The start date for a filtered date search on support case
-- communications. Case communications are available for 12 months after
-- creation.
describeCases_afterTime :: Lens.Lens' DescribeCases (Prelude.Maybe Prelude.Text)
describeCases_afterTime :: Lens' DescribeCases (Maybe Text)
describeCases_afterTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCases' {Maybe Text
afterTime :: Maybe Text
$sel:afterTime:DescribeCases' :: DescribeCases -> Maybe Text
afterTime} -> Maybe Text
afterTime) (\s :: DescribeCases
s@DescribeCases' {} Maybe Text
a -> DescribeCases
s {$sel:afterTime:DescribeCases' :: Maybe Text
afterTime = Maybe Text
a} :: DescribeCases)

-- | The end date for a filtered date search on support case communications.
-- Case communications are available for 12 months after creation.
describeCases_beforeTime :: Lens.Lens' DescribeCases (Prelude.Maybe Prelude.Text)
describeCases_beforeTime :: Lens' DescribeCases (Maybe Text)
describeCases_beforeTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCases' {Maybe Text
beforeTime :: Maybe Text
$sel:beforeTime:DescribeCases' :: DescribeCases -> Maybe Text
beforeTime} -> Maybe Text
beforeTime) (\s :: DescribeCases
s@DescribeCases' {} Maybe Text
a -> DescribeCases
s {$sel:beforeTime:DescribeCases' :: Maybe Text
beforeTime = Maybe Text
a} :: DescribeCases)

-- | A list of ID numbers of the support cases you want returned. The maximum
-- number of cases is 100.
describeCases_caseIdList :: Lens.Lens' DescribeCases (Prelude.Maybe [Prelude.Text])
describeCases_caseIdList :: Lens' DescribeCases (Maybe [Text])
describeCases_caseIdList = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCases' {Maybe [Text]
caseIdList :: Maybe [Text]
$sel:caseIdList:DescribeCases' :: DescribeCases -> Maybe [Text]
caseIdList} -> Maybe [Text]
caseIdList) (\s :: DescribeCases
s@DescribeCases' {} Maybe [Text]
a -> DescribeCases
s {$sel:caseIdList:DescribeCases' :: Maybe [Text]
caseIdList = Maybe [Text]
a} :: DescribeCases) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The ID displayed for a case in the Amazon Web Services Support Center
-- user interface.
describeCases_displayId :: Lens.Lens' DescribeCases (Prelude.Maybe Prelude.Text)
describeCases_displayId :: Lens' DescribeCases (Maybe Text)
describeCases_displayId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCases' {Maybe Text
displayId :: Maybe Text
$sel:displayId:DescribeCases' :: DescribeCases -> Maybe Text
displayId} -> Maybe Text
displayId) (\s :: DescribeCases
s@DescribeCases' {} Maybe Text
a -> DescribeCases
s {$sel:displayId:DescribeCases' :: Maybe Text
displayId = Maybe Text
a} :: DescribeCases)

-- | Specifies whether to include communications in the @DescribeCases@
-- response. By default, communications are included.
describeCases_includeCommunications :: Lens.Lens' DescribeCases (Prelude.Maybe Prelude.Bool)
describeCases_includeCommunications :: Lens' DescribeCases (Maybe Bool)
describeCases_includeCommunications = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCases' {Maybe Bool
includeCommunications :: Maybe Bool
$sel:includeCommunications:DescribeCases' :: DescribeCases -> Maybe Bool
includeCommunications} -> Maybe Bool
includeCommunications) (\s :: DescribeCases
s@DescribeCases' {} Maybe Bool
a -> DescribeCases
s {$sel:includeCommunications:DescribeCases' :: Maybe Bool
includeCommunications = Maybe Bool
a} :: DescribeCases)

-- | Specifies whether to include resolved support cases in the
-- @DescribeCases@ response. By default, resolved cases aren\'t included.
describeCases_includeResolvedCases :: Lens.Lens' DescribeCases (Prelude.Maybe Prelude.Bool)
describeCases_includeResolvedCases :: Lens' DescribeCases (Maybe Bool)
describeCases_includeResolvedCases = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCases' {Maybe Bool
includeResolvedCases :: Maybe Bool
$sel:includeResolvedCases:DescribeCases' :: DescribeCases -> Maybe Bool
includeResolvedCases} -> Maybe Bool
includeResolvedCases) (\s :: DescribeCases
s@DescribeCases' {} Maybe Bool
a -> DescribeCases
s {$sel:includeResolvedCases:DescribeCases' :: Maybe Bool
includeResolvedCases = Maybe Bool
a} :: DescribeCases)

-- | 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_language :: Lens.Lens' DescribeCases (Prelude.Maybe Prelude.Text)
describeCases_language :: Lens' DescribeCases (Maybe Text)
describeCases_language = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCases' {Maybe Text
language :: Maybe Text
$sel:language:DescribeCases' :: DescribeCases -> Maybe Text
language} -> Maybe Text
language) (\s :: DescribeCases
s@DescribeCases' {} Maybe Text
a -> DescribeCases
s {$sel:language:DescribeCases' :: Maybe Text
language = Maybe Text
a} :: DescribeCases)

-- | The maximum number of results to return before paginating.
describeCases_maxResults :: Lens.Lens' DescribeCases (Prelude.Maybe Prelude.Natural)
describeCases_maxResults :: Lens' DescribeCases (Maybe Natural)
describeCases_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCases' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:DescribeCases' :: DescribeCases -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: DescribeCases
s@DescribeCases' {} Maybe Natural
a -> DescribeCases
s {$sel:maxResults:DescribeCases' :: Maybe Natural
maxResults = Maybe Natural
a} :: DescribeCases)

-- | A resumption point for pagination.
describeCases_nextToken :: Lens.Lens' DescribeCases (Prelude.Maybe Prelude.Text)
describeCases_nextToken :: Lens' DescribeCases (Maybe Text)
describeCases_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCases' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeCases' :: DescribeCases -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeCases
s@DescribeCases' {} Maybe Text
a -> DescribeCases
s {$sel:nextToken:DescribeCases' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeCases)

instance Core.AWSPager DescribeCases where
  page :: DescribeCases -> AWSResponse DescribeCases -> Maybe DescribeCases
page DescribeCases
rq AWSResponse DescribeCases
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse DescribeCases
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeCasesResponse (Maybe Text)
describeCasesResponse_nextToken
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse DescribeCases
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeCasesResponse (Maybe [CaseDetails])
describeCasesResponse_cases
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ DescribeCases
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' DescribeCases (Maybe Text)
describeCases_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse DescribeCases
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeCasesResponse (Maybe Text)
describeCasesResponse_nextToken
          forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just

instance Core.AWSRequest DescribeCases where
  type
    AWSResponse DescribeCases =
      DescribeCasesResponse
  request :: (Service -> Service) -> DescribeCases -> Request DescribeCases
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy DescribeCases
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeCases)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe [CaseDetails] -> Maybe Text -> Int -> DescribeCasesResponse
DescribeCasesResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"cases" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"nextToken")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable DescribeCases where
  hashWithSalt :: Int -> DescribeCases -> Int
hashWithSalt Int
_salt DescribeCases' {Maybe Bool
Maybe Natural
Maybe [Text]
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
language :: Maybe Text
includeResolvedCases :: Maybe Bool
includeCommunications :: Maybe Bool
displayId :: Maybe Text
caseIdList :: Maybe [Text]
beforeTime :: Maybe Text
afterTime :: Maybe Text
$sel:nextToken:DescribeCases' :: DescribeCases -> Maybe Text
$sel:maxResults:DescribeCases' :: DescribeCases -> Maybe Natural
$sel:language:DescribeCases' :: DescribeCases -> Maybe Text
$sel:includeResolvedCases:DescribeCases' :: DescribeCases -> Maybe Bool
$sel:includeCommunications:DescribeCases' :: DescribeCases -> Maybe Bool
$sel:displayId:DescribeCases' :: DescribeCases -> Maybe Text
$sel:caseIdList:DescribeCases' :: DescribeCases -> Maybe [Text]
$sel:beforeTime:DescribeCases' :: DescribeCases -> Maybe Text
$sel:afterTime:DescribeCases' :: DescribeCases -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
afterTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
beforeTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
caseIdList
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
displayId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
includeCommunications
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
includeResolvedCases
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
language
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
maxResults
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken

instance Prelude.NFData DescribeCases where
  rnf :: DescribeCases -> ()
rnf DescribeCases' {Maybe Bool
Maybe Natural
Maybe [Text]
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
language :: Maybe Text
includeResolvedCases :: Maybe Bool
includeCommunications :: Maybe Bool
displayId :: Maybe Text
caseIdList :: Maybe [Text]
beforeTime :: Maybe Text
afterTime :: Maybe Text
$sel:nextToken:DescribeCases' :: DescribeCases -> Maybe Text
$sel:maxResults:DescribeCases' :: DescribeCases -> Maybe Natural
$sel:language:DescribeCases' :: DescribeCases -> Maybe Text
$sel:includeResolvedCases:DescribeCases' :: DescribeCases -> Maybe Bool
$sel:includeCommunications:DescribeCases' :: DescribeCases -> Maybe Bool
$sel:displayId:DescribeCases' :: DescribeCases -> Maybe Text
$sel:caseIdList:DescribeCases' :: DescribeCases -> Maybe [Text]
$sel:beforeTime:DescribeCases' :: DescribeCases -> Maybe Text
$sel:afterTime:DescribeCases' :: DescribeCases -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
afterTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
beforeTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
caseIdList
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
displayId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
includeCommunications
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
includeResolvedCases
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
language
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
maxResults
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken

instance Data.ToHeaders DescribeCases where
  toHeaders :: DescribeCases -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"AWSSupport_20130415.DescribeCases" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON DescribeCases where
  toJSON :: DescribeCases -> Value
toJSON DescribeCases' {Maybe Bool
Maybe Natural
Maybe [Text]
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
language :: Maybe Text
includeResolvedCases :: Maybe Bool
includeCommunications :: Maybe Bool
displayId :: Maybe Text
caseIdList :: Maybe [Text]
beforeTime :: Maybe Text
afterTime :: Maybe Text
$sel:nextToken:DescribeCases' :: DescribeCases -> Maybe Text
$sel:maxResults:DescribeCases' :: DescribeCases -> Maybe Natural
$sel:language:DescribeCases' :: DescribeCases -> Maybe Text
$sel:includeResolvedCases:DescribeCases' :: DescribeCases -> Maybe Bool
$sel:includeCommunications:DescribeCases' :: DescribeCases -> Maybe Bool
$sel:displayId:DescribeCases' :: DescribeCases -> Maybe Text
$sel:caseIdList:DescribeCases' :: DescribeCases -> Maybe [Text]
$sel:beforeTime:DescribeCases' :: DescribeCases -> Maybe Text
$sel:afterTime:DescribeCases' :: DescribeCases -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"afterTime" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
afterTime,
            (Key
"beforeTime" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
beforeTime,
            (Key
"caseIdList" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Text]
caseIdList,
            (Key
"displayId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
displayId,
            (Key
"includeCommunications" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
includeCommunications,
            (Key
"includeResolvedCases" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
includeResolvedCases,
            (Key
"language" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
language,
            (Key
"maxResults" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
maxResults,
            (Key
"nextToken" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
nextToken
          ]
      )

instance Data.ToPath DescribeCases where
  toPath :: DescribeCases -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery DescribeCases where
  toQuery :: DescribeCases -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | Returns an array of
-- <https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html CaseDetails>
-- objects and a @nextToken@ that defines a point for pagination in the
-- result set.
--
-- /See:/ 'newDescribeCasesResponse' smart constructor.
data DescribeCasesResponse = DescribeCasesResponse'
  { -- | The details for the cases that match the request.
    DescribeCasesResponse -> Maybe [CaseDetails]
cases :: Prelude.Maybe [CaseDetails],
    -- | A resumption point for pagination.
    DescribeCasesResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    DescribeCasesResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeCasesResponse -> DescribeCasesResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeCasesResponse -> DescribeCasesResponse -> Bool
$c/= :: DescribeCasesResponse -> DescribeCasesResponse -> Bool
== :: DescribeCasesResponse -> DescribeCasesResponse -> Bool
$c== :: DescribeCasesResponse -> DescribeCasesResponse -> Bool
Prelude.Eq, ReadPrec [DescribeCasesResponse]
ReadPrec DescribeCasesResponse
Int -> ReadS DescribeCasesResponse
ReadS [DescribeCasesResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeCasesResponse]
$creadListPrec :: ReadPrec [DescribeCasesResponse]
readPrec :: ReadPrec DescribeCasesResponse
$creadPrec :: ReadPrec DescribeCasesResponse
readList :: ReadS [DescribeCasesResponse]
$creadList :: ReadS [DescribeCasesResponse]
readsPrec :: Int -> ReadS DescribeCasesResponse
$creadsPrec :: Int -> ReadS DescribeCasesResponse
Prelude.Read, Int -> DescribeCasesResponse -> ShowS
[DescribeCasesResponse] -> ShowS
DescribeCasesResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeCasesResponse] -> ShowS
$cshowList :: [DescribeCasesResponse] -> ShowS
show :: DescribeCasesResponse -> String
$cshow :: DescribeCasesResponse -> String
showsPrec :: Int -> DescribeCasesResponse -> ShowS
$cshowsPrec :: Int -> DescribeCasesResponse -> ShowS
Prelude.Show, forall x. Rep DescribeCasesResponse x -> DescribeCasesResponse
forall x. DescribeCasesResponse -> Rep DescribeCasesResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeCasesResponse x -> DescribeCasesResponse
$cfrom :: forall x. DescribeCasesResponse -> Rep DescribeCasesResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeCasesResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'cases', 'describeCasesResponse_cases' - The details for the cases that match the request.
--
-- 'nextToken', 'describeCasesResponse_nextToken' - A resumption point for pagination.
--
-- 'httpStatus', 'describeCasesResponse_httpStatus' - The response's http status code.
newDescribeCasesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeCasesResponse
newDescribeCasesResponse :: Int -> DescribeCasesResponse
newDescribeCasesResponse Int
pHttpStatus_ =
  DescribeCasesResponse'
    { $sel:cases:DescribeCasesResponse' :: Maybe [CaseDetails]
cases = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeCasesResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeCasesResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The details for the cases that match the request.
describeCasesResponse_cases :: Lens.Lens' DescribeCasesResponse (Prelude.Maybe [CaseDetails])
describeCasesResponse_cases :: Lens' DescribeCasesResponse (Maybe [CaseDetails])
describeCasesResponse_cases = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCasesResponse' {Maybe [CaseDetails]
cases :: Maybe [CaseDetails]
$sel:cases:DescribeCasesResponse' :: DescribeCasesResponse -> Maybe [CaseDetails]
cases} -> Maybe [CaseDetails]
cases) (\s :: DescribeCasesResponse
s@DescribeCasesResponse' {} Maybe [CaseDetails]
a -> DescribeCasesResponse
s {$sel:cases:DescribeCasesResponse' :: Maybe [CaseDetails]
cases = Maybe [CaseDetails]
a} :: DescribeCasesResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | A resumption point for pagination.
describeCasesResponse_nextToken :: Lens.Lens' DescribeCasesResponse (Prelude.Maybe Prelude.Text)
describeCasesResponse_nextToken :: Lens' DescribeCasesResponse (Maybe Text)
describeCasesResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCasesResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeCasesResponse' :: DescribeCasesResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeCasesResponse
s@DescribeCasesResponse' {} Maybe Text
a -> DescribeCasesResponse
s {$sel:nextToken:DescribeCasesResponse' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeCasesResponse)

-- | The response's http status code.
describeCasesResponse_httpStatus :: Lens.Lens' DescribeCasesResponse Prelude.Int
describeCasesResponse_httpStatus :: Lens' DescribeCasesResponse Int
describeCasesResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCasesResponse' {Int
httpStatus :: Int
$sel:httpStatus:DescribeCasesResponse' :: DescribeCasesResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: DescribeCasesResponse
s@DescribeCasesResponse' {} Int
a -> DescribeCasesResponse
s {$sel:httpStatus:DescribeCasesResponse' :: Int
httpStatus = Int
a} :: DescribeCasesResponse)

instance Prelude.NFData DescribeCasesResponse where
  rnf :: DescribeCasesResponse -> ()
rnf DescribeCasesResponse' {Int
Maybe [CaseDetails]
Maybe Text
httpStatus :: Int
nextToken :: Maybe Text
cases :: Maybe [CaseDetails]
$sel:httpStatus:DescribeCasesResponse' :: DescribeCasesResponse -> Int
$sel:nextToken:DescribeCasesResponse' :: DescribeCasesResponse -> Maybe Text
$sel:cases:DescribeCasesResponse' :: DescribeCasesResponse -> Maybe [CaseDetails]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [CaseDetails]
cases
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus