{-# 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.MediaConnect.ListOfferings
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Displays a list of all offerings that are available to this account in
-- the current AWS Region. If you have an active reservation (which means
-- you\'ve purchased an offering that has already started and hasn\'t
-- expired yet), your account isn\'t eligible for other offerings.
--
-- This operation returns paginated results.
module Amazonka.MediaConnect.ListOfferings
  ( -- * Creating a Request
    ListOfferings (..),
    newListOfferings,

    -- * Request Lenses
    listOfferings_maxResults,
    listOfferings_nextToken,

    -- * Destructuring the Response
    ListOfferingsResponse (..),
    newListOfferingsResponse,

    -- * Response Lenses
    listOfferingsResponse_nextToken,
    listOfferingsResponse_offerings,
    listOfferingsResponse_httpStatus,
  )
where

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

-- | /See:/ 'newListOfferings' smart constructor.
data ListOfferings = ListOfferings'
  { -- | The maximum number of results to return per API request. For example,
    -- you submit a ListOfferings request with MaxResults set at 5. Although 20
    -- items match your request, the service returns no more than the first 5
    -- items. (The service also returns a NextToken value that you can use to
    -- fetch the next batch of results.) The service might return fewer results
    -- than the MaxResults value. If MaxResults is not included in the request,
    -- the service defaults to pagination with a maximum of 10 results per
    -- page.
    ListOfferings -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | The token that identifies which batch of results that you want to see.
    -- For example, you submit a ListOfferings request with MaxResults set at
    -- 5. The service returns the first batch of results (up to 5) and a
    -- NextToken value. To see the next batch of results, you can submit the
    -- ListOfferings request a second time and specify the NextToken value.
    ListOfferings -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (ListOfferings -> ListOfferings -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListOfferings -> ListOfferings -> Bool
$c/= :: ListOfferings -> ListOfferings -> Bool
== :: ListOfferings -> ListOfferings -> Bool
$c== :: ListOfferings -> ListOfferings -> Bool
Prelude.Eq, ReadPrec [ListOfferings]
ReadPrec ListOfferings
Int -> ReadS ListOfferings
ReadS [ListOfferings]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListOfferings]
$creadListPrec :: ReadPrec [ListOfferings]
readPrec :: ReadPrec ListOfferings
$creadPrec :: ReadPrec ListOfferings
readList :: ReadS [ListOfferings]
$creadList :: ReadS [ListOfferings]
readsPrec :: Int -> ReadS ListOfferings
$creadsPrec :: Int -> ReadS ListOfferings
Prelude.Read, Int -> ListOfferings -> ShowS
[ListOfferings] -> ShowS
ListOfferings -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListOfferings] -> ShowS
$cshowList :: [ListOfferings] -> ShowS
show :: ListOfferings -> String
$cshow :: ListOfferings -> String
showsPrec :: Int -> ListOfferings -> ShowS
$cshowsPrec :: Int -> ListOfferings -> ShowS
Prelude.Show, forall x. Rep ListOfferings x -> ListOfferings
forall x. ListOfferings -> Rep ListOfferings x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListOfferings x -> ListOfferings
$cfrom :: forall x. ListOfferings -> Rep ListOfferings x
Prelude.Generic)

-- |
-- Create a value of 'ListOfferings' 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:
--
-- 'maxResults', 'listOfferings_maxResults' - The maximum number of results to return per API request. For example,
-- you submit a ListOfferings request with MaxResults set at 5. Although 20
-- items match your request, the service returns no more than the first 5
-- items. (The service also returns a NextToken value that you can use to
-- fetch the next batch of results.) The service might return fewer results
-- than the MaxResults value. If MaxResults is not included in the request,
-- the service defaults to pagination with a maximum of 10 results per
-- page.
--
-- 'nextToken', 'listOfferings_nextToken' - The token that identifies which batch of results that you want to see.
-- For example, you submit a ListOfferings request with MaxResults set at
-- 5. The service returns the first batch of results (up to 5) and a
-- NextToken value. To see the next batch of results, you can submit the
-- ListOfferings request a second time and specify the NextToken value.
newListOfferings ::
  ListOfferings
newListOfferings :: ListOfferings
newListOfferings =
  ListOfferings'
    { $sel:maxResults:ListOfferings' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListOfferings' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | The maximum number of results to return per API request. For example,
-- you submit a ListOfferings request with MaxResults set at 5. Although 20
-- items match your request, the service returns no more than the first 5
-- items. (The service also returns a NextToken value that you can use to
-- fetch the next batch of results.) The service might return fewer results
-- than the MaxResults value. If MaxResults is not included in the request,
-- the service defaults to pagination with a maximum of 10 results per
-- page.
listOfferings_maxResults :: Lens.Lens' ListOfferings (Prelude.Maybe Prelude.Natural)
listOfferings_maxResults :: Lens' ListOfferings (Maybe Natural)
listOfferings_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListOfferings' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListOfferings' :: ListOfferings -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListOfferings
s@ListOfferings' {} Maybe Natural
a -> ListOfferings
s {$sel:maxResults:ListOfferings' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListOfferings)

-- | The token that identifies which batch of results that you want to see.
-- For example, you submit a ListOfferings request with MaxResults set at
-- 5. The service returns the first batch of results (up to 5) and a
-- NextToken value. To see the next batch of results, you can submit the
-- ListOfferings request a second time and specify the NextToken value.
listOfferings_nextToken :: Lens.Lens' ListOfferings (Prelude.Maybe Prelude.Text)
listOfferings_nextToken :: Lens' ListOfferings (Maybe Text)
listOfferings_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListOfferings' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListOfferings' :: ListOfferings -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListOfferings
s@ListOfferings' {} Maybe Text
a -> ListOfferings
s {$sel:nextToken:ListOfferings' :: Maybe Text
nextToken = Maybe Text
a} :: ListOfferings)

instance Core.AWSPager ListOfferings where
  page :: ListOfferings -> AWSResponse ListOfferings -> Maybe ListOfferings
page ListOfferings
rq AWSResponse ListOfferings
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListOfferings
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListOfferingsResponse (Maybe Text)
listOfferingsResponse_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 ListOfferings
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListOfferingsResponse (Maybe [Offering])
listOfferingsResponse_offerings
            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.$ ListOfferings
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' ListOfferings (Maybe Text)
listOfferings_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse ListOfferings
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListOfferingsResponse (Maybe Text)
listOfferingsResponse_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 ListOfferings where
  type
    AWSResponse ListOfferings =
      ListOfferingsResponse
  request :: (Service -> Service) -> ListOfferings -> Request ListOfferings
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.get (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy ListOfferings
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListOfferings)))
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 Text -> Maybe [Offering] -> Int -> ListOfferingsResponse
ListOfferingsResponse'
            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
"nextToken")
            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
"offerings" 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.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable ListOfferings where
  hashWithSalt :: Int -> ListOfferings -> Int
hashWithSalt Int
_salt ListOfferings' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListOfferings' :: ListOfferings -> Maybe Text
$sel:maxResults:ListOfferings' :: ListOfferings -> Maybe Natural
..} =
    Int
_salt
      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 ListOfferings where
  rnf :: ListOfferings -> ()
rnf ListOfferings' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListOfferings' :: ListOfferings -> Maybe Text
$sel:maxResults:ListOfferings' :: ListOfferings -> Maybe Natural
..} =
    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 ListOfferings where
  toHeaders :: ListOfferings -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

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

instance Data.ToQuery ListOfferings where
  toQuery :: ListOfferings -> QueryString
toQuery ListOfferings' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListOfferings' :: ListOfferings -> Maybe Text
$sel:maxResults:ListOfferings' :: ListOfferings -> Maybe Natural
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"maxResults" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Natural
maxResults,
        ByteString
"nextToken" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
nextToken
      ]

-- | /See:/ 'newListOfferingsResponse' smart constructor.
data ListOfferingsResponse = ListOfferingsResponse'
  { -- | The token that identifies which batch of results that you want to see.
    -- For example, you submit a ListOfferings request with MaxResults set at
    -- 5. The service returns the first batch of results (up to 5) and a
    -- NextToken value. To see the next batch of results, you can submit the
    -- ListOfferings request a second time and specify the NextToken value.
    ListOfferingsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | A list of offerings that are available to this account in the current
    -- AWS Region.
    ListOfferingsResponse -> Maybe [Offering]
offerings :: Prelude.Maybe [Offering],
    -- | The response's http status code.
    ListOfferingsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListOfferingsResponse -> ListOfferingsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListOfferingsResponse -> ListOfferingsResponse -> Bool
$c/= :: ListOfferingsResponse -> ListOfferingsResponse -> Bool
== :: ListOfferingsResponse -> ListOfferingsResponse -> Bool
$c== :: ListOfferingsResponse -> ListOfferingsResponse -> Bool
Prelude.Eq, ReadPrec [ListOfferingsResponse]
ReadPrec ListOfferingsResponse
Int -> ReadS ListOfferingsResponse
ReadS [ListOfferingsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListOfferingsResponse]
$creadListPrec :: ReadPrec [ListOfferingsResponse]
readPrec :: ReadPrec ListOfferingsResponse
$creadPrec :: ReadPrec ListOfferingsResponse
readList :: ReadS [ListOfferingsResponse]
$creadList :: ReadS [ListOfferingsResponse]
readsPrec :: Int -> ReadS ListOfferingsResponse
$creadsPrec :: Int -> ReadS ListOfferingsResponse
Prelude.Read, Int -> ListOfferingsResponse -> ShowS
[ListOfferingsResponse] -> ShowS
ListOfferingsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListOfferingsResponse] -> ShowS
$cshowList :: [ListOfferingsResponse] -> ShowS
show :: ListOfferingsResponse -> String
$cshow :: ListOfferingsResponse -> String
showsPrec :: Int -> ListOfferingsResponse -> ShowS
$cshowsPrec :: Int -> ListOfferingsResponse -> ShowS
Prelude.Show, forall x. Rep ListOfferingsResponse x -> ListOfferingsResponse
forall x. ListOfferingsResponse -> Rep ListOfferingsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListOfferingsResponse x -> ListOfferingsResponse
$cfrom :: forall x. ListOfferingsResponse -> Rep ListOfferingsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListOfferingsResponse' 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:
--
-- 'nextToken', 'listOfferingsResponse_nextToken' - The token that identifies which batch of results that you want to see.
-- For example, you submit a ListOfferings request with MaxResults set at
-- 5. The service returns the first batch of results (up to 5) and a
-- NextToken value. To see the next batch of results, you can submit the
-- ListOfferings request a second time and specify the NextToken value.
--
-- 'offerings', 'listOfferingsResponse_offerings' - A list of offerings that are available to this account in the current
-- AWS Region.
--
-- 'httpStatus', 'listOfferingsResponse_httpStatus' - The response's http status code.
newListOfferingsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListOfferingsResponse
newListOfferingsResponse :: Int -> ListOfferingsResponse
newListOfferingsResponse Int
pHttpStatus_ =
  ListOfferingsResponse'
    { $sel:nextToken:ListOfferingsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:offerings:ListOfferingsResponse' :: Maybe [Offering]
offerings = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListOfferingsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The token that identifies which batch of results that you want to see.
-- For example, you submit a ListOfferings request with MaxResults set at
-- 5. The service returns the first batch of results (up to 5) and a
-- NextToken value. To see the next batch of results, you can submit the
-- ListOfferings request a second time and specify the NextToken value.
listOfferingsResponse_nextToken :: Lens.Lens' ListOfferingsResponse (Prelude.Maybe Prelude.Text)
listOfferingsResponse_nextToken :: Lens' ListOfferingsResponse (Maybe Text)
listOfferingsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListOfferingsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListOfferingsResponse' :: ListOfferingsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListOfferingsResponse
s@ListOfferingsResponse' {} Maybe Text
a -> ListOfferingsResponse
s {$sel:nextToken:ListOfferingsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListOfferingsResponse)

-- | A list of offerings that are available to this account in the current
-- AWS Region.
listOfferingsResponse_offerings :: Lens.Lens' ListOfferingsResponse (Prelude.Maybe [Offering])
listOfferingsResponse_offerings :: Lens' ListOfferingsResponse (Maybe [Offering])
listOfferingsResponse_offerings = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListOfferingsResponse' {Maybe [Offering]
offerings :: Maybe [Offering]
$sel:offerings:ListOfferingsResponse' :: ListOfferingsResponse -> Maybe [Offering]
offerings} -> Maybe [Offering]
offerings) (\s :: ListOfferingsResponse
s@ListOfferingsResponse' {} Maybe [Offering]
a -> ListOfferingsResponse
s {$sel:offerings:ListOfferingsResponse' :: Maybe [Offering]
offerings = Maybe [Offering]
a} :: ListOfferingsResponse) 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 response's http status code.
listOfferingsResponse_httpStatus :: Lens.Lens' ListOfferingsResponse Prelude.Int
listOfferingsResponse_httpStatus :: Lens' ListOfferingsResponse Int
listOfferingsResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListOfferingsResponse' {Int
httpStatus :: Int
$sel:httpStatus:ListOfferingsResponse' :: ListOfferingsResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: ListOfferingsResponse
s@ListOfferingsResponse' {} Int
a -> ListOfferingsResponse
s {$sel:httpStatus:ListOfferingsResponse' :: Int
httpStatus = Int
a} :: ListOfferingsResponse)

instance Prelude.NFData ListOfferingsResponse where
  rnf :: ListOfferingsResponse -> ()
rnf ListOfferingsResponse' {Int
Maybe [Offering]
Maybe Text
httpStatus :: Int
offerings :: Maybe [Offering]
nextToken :: Maybe Text
$sel:httpStatus:ListOfferingsResponse' :: ListOfferingsResponse -> Int
$sel:offerings:ListOfferingsResponse' :: ListOfferingsResponse -> Maybe [Offering]
$sel:nextToken:ListOfferingsResponse' :: ListOfferingsResponse -> Maybe Text
..} =
    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 Maybe [Offering]
offerings
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus