{-# 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.EC2.DescribeCarrierGateways
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Describes one or more of your carrier gateways.
--
-- This operation returns paginated results.
module Amazonka.EC2.DescribeCarrierGateways
  ( -- * Creating a Request
    DescribeCarrierGateways (..),
    newDescribeCarrierGateways,

    -- * Request Lenses
    describeCarrierGateways_carrierGatewayIds,
    describeCarrierGateways_dryRun,
    describeCarrierGateways_filters,
    describeCarrierGateways_maxResults,
    describeCarrierGateways_nextToken,

    -- * Destructuring the Response
    DescribeCarrierGatewaysResponse (..),
    newDescribeCarrierGatewaysResponse,

    -- * Response Lenses
    describeCarrierGatewaysResponse_carrierGateways,
    describeCarrierGatewaysResponse_nextToken,
    describeCarrierGatewaysResponse_httpStatus,
  )
where

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

-- | /See:/ 'newDescribeCarrierGateways' smart constructor.
data DescribeCarrierGateways = DescribeCarrierGateways'
  { -- | One or more carrier gateway IDs.
    DescribeCarrierGateways -> Maybe [Text]
carrierGatewayIds :: Prelude.Maybe [Prelude.Text],
    -- | Checks whether you have the required permissions for the action, without
    -- actually making the request, and provides an error response. If you have
    -- the required permissions, the error response is @DryRunOperation@.
    -- Otherwise, it is @UnauthorizedOperation@.
    DescribeCarrierGateways -> Maybe Bool
dryRun :: Prelude.Maybe Prelude.Bool,
    -- | One or more filters.
    --
    -- -   @carrier-gateway-id@ - The ID of the carrier gateway.
    --
    -- -   @state@ - The state of the carrier gateway (@pending@ | @failed@ |
    --     @available@ | @deleting@ | @deleted@).
    --
    -- -   @owner-id@ - The Amazon Web Services account ID of the owner of the
    --     carrier gateway.
    --
    -- -   @tag@:\<key> - The key\/value combination of a tag assigned to the
    --     resource. Use the tag key in the filter name and the tag value as
    --     the filter value. For example, to find all resources that have a tag
    --     with the key @Owner@ and the value @TeamA@, specify @tag:Owner@ for
    --     the filter name and @TeamA@ for the filter value.
    --
    -- -   @tag-key@ - The key of a tag assigned to the resource. Use this
    --     filter to find all resources assigned a tag with a specific key,
    --     regardless of the tag value.
    --
    -- -   @vpc-id@ - The ID of the VPC associated with the carrier gateway.
    DescribeCarrierGateways -> Maybe [Filter]
filters :: Prelude.Maybe [Filter],
    -- | The maximum number of results to return with a single call. To retrieve
    -- the remaining results, make another call with the returned @nextToken@
    -- value.
    DescribeCarrierGateways -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | The token for the next page of results.
    DescribeCarrierGateways -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (DescribeCarrierGateways -> DescribeCarrierGateways -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeCarrierGateways -> DescribeCarrierGateways -> Bool
$c/= :: DescribeCarrierGateways -> DescribeCarrierGateways -> Bool
== :: DescribeCarrierGateways -> DescribeCarrierGateways -> Bool
$c== :: DescribeCarrierGateways -> DescribeCarrierGateways -> Bool
Prelude.Eq, ReadPrec [DescribeCarrierGateways]
ReadPrec DescribeCarrierGateways
Int -> ReadS DescribeCarrierGateways
ReadS [DescribeCarrierGateways]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeCarrierGateways]
$creadListPrec :: ReadPrec [DescribeCarrierGateways]
readPrec :: ReadPrec DescribeCarrierGateways
$creadPrec :: ReadPrec DescribeCarrierGateways
readList :: ReadS [DescribeCarrierGateways]
$creadList :: ReadS [DescribeCarrierGateways]
readsPrec :: Int -> ReadS DescribeCarrierGateways
$creadsPrec :: Int -> ReadS DescribeCarrierGateways
Prelude.Read, Int -> DescribeCarrierGateways -> ShowS
[DescribeCarrierGateways] -> ShowS
DescribeCarrierGateways -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeCarrierGateways] -> ShowS
$cshowList :: [DescribeCarrierGateways] -> ShowS
show :: DescribeCarrierGateways -> String
$cshow :: DescribeCarrierGateways -> String
showsPrec :: Int -> DescribeCarrierGateways -> ShowS
$cshowsPrec :: Int -> DescribeCarrierGateways -> ShowS
Prelude.Show, forall x. Rep DescribeCarrierGateways x -> DescribeCarrierGateways
forall x. DescribeCarrierGateways -> Rep DescribeCarrierGateways x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeCarrierGateways x -> DescribeCarrierGateways
$cfrom :: forall x. DescribeCarrierGateways -> Rep DescribeCarrierGateways x
Prelude.Generic)

-- |
-- Create a value of 'DescribeCarrierGateways' 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:
--
-- 'carrierGatewayIds', 'describeCarrierGateways_carrierGatewayIds' - One or more carrier gateway IDs.
--
-- 'dryRun', 'describeCarrierGateways_dryRun' - Checks whether you have the required permissions for the action, without
-- actually making the request, and provides an error response. If you have
-- the required permissions, the error response is @DryRunOperation@.
-- Otherwise, it is @UnauthorizedOperation@.
--
-- 'filters', 'describeCarrierGateways_filters' - One or more filters.
--
-- -   @carrier-gateway-id@ - The ID of the carrier gateway.
--
-- -   @state@ - The state of the carrier gateway (@pending@ | @failed@ |
--     @available@ | @deleting@ | @deleted@).
--
-- -   @owner-id@ - The Amazon Web Services account ID of the owner of the
--     carrier gateway.
--
-- -   @tag@:\<key> - The key\/value combination of a tag assigned to the
--     resource. Use the tag key in the filter name and the tag value as
--     the filter value. For example, to find all resources that have a tag
--     with the key @Owner@ and the value @TeamA@, specify @tag:Owner@ for
--     the filter name and @TeamA@ for the filter value.
--
-- -   @tag-key@ - The key of a tag assigned to the resource. Use this
--     filter to find all resources assigned a tag with a specific key,
--     regardless of the tag value.
--
-- -   @vpc-id@ - The ID of the VPC associated with the carrier gateway.
--
-- 'maxResults', 'describeCarrierGateways_maxResults' - The maximum number of results to return with a single call. To retrieve
-- the remaining results, make another call with the returned @nextToken@
-- value.
--
-- 'nextToken', 'describeCarrierGateways_nextToken' - The token for the next page of results.
newDescribeCarrierGateways ::
  DescribeCarrierGateways
newDescribeCarrierGateways :: DescribeCarrierGateways
newDescribeCarrierGateways =
  DescribeCarrierGateways'
    { $sel:carrierGatewayIds:DescribeCarrierGateways' :: Maybe [Text]
carrierGatewayIds =
        forall a. Maybe a
Prelude.Nothing,
      $sel:dryRun:DescribeCarrierGateways' :: Maybe Bool
dryRun = forall a. Maybe a
Prelude.Nothing,
      $sel:filters:DescribeCarrierGateways' :: Maybe [Filter]
filters = forall a. Maybe a
Prelude.Nothing,
      $sel:maxResults:DescribeCarrierGateways' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeCarrierGateways' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | One or more carrier gateway IDs.
describeCarrierGateways_carrierGatewayIds :: Lens.Lens' DescribeCarrierGateways (Prelude.Maybe [Prelude.Text])
describeCarrierGateways_carrierGatewayIds :: Lens' DescribeCarrierGateways (Maybe [Text])
describeCarrierGateways_carrierGatewayIds = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCarrierGateways' {Maybe [Text]
carrierGatewayIds :: Maybe [Text]
$sel:carrierGatewayIds:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe [Text]
carrierGatewayIds} -> Maybe [Text]
carrierGatewayIds) (\s :: DescribeCarrierGateways
s@DescribeCarrierGateways' {} Maybe [Text]
a -> DescribeCarrierGateways
s {$sel:carrierGatewayIds:DescribeCarrierGateways' :: Maybe [Text]
carrierGatewayIds = Maybe [Text]
a} :: DescribeCarrierGateways) 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

-- | Checks whether you have the required permissions for the action, without
-- actually making the request, and provides an error response. If you have
-- the required permissions, the error response is @DryRunOperation@.
-- Otherwise, it is @UnauthorizedOperation@.
describeCarrierGateways_dryRun :: Lens.Lens' DescribeCarrierGateways (Prelude.Maybe Prelude.Bool)
describeCarrierGateways_dryRun :: Lens' DescribeCarrierGateways (Maybe Bool)
describeCarrierGateways_dryRun = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCarrierGateways' {Maybe Bool
dryRun :: Maybe Bool
$sel:dryRun:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe Bool
dryRun} -> Maybe Bool
dryRun) (\s :: DescribeCarrierGateways
s@DescribeCarrierGateways' {} Maybe Bool
a -> DescribeCarrierGateways
s {$sel:dryRun:DescribeCarrierGateways' :: Maybe Bool
dryRun = Maybe Bool
a} :: DescribeCarrierGateways)

-- | One or more filters.
--
-- -   @carrier-gateway-id@ - The ID of the carrier gateway.
--
-- -   @state@ - The state of the carrier gateway (@pending@ | @failed@ |
--     @available@ | @deleting@ | @deleted@).
--
-- -   @owner-id@ - The Amazon Web Services account ID of the owner of the
--     carrier gateway.
--
-- -   @tag@:\<key> - The key\/value combination of a tag assigned to the
--     resource. Use the tag key in the filter name and the tag value as
--     the filter value. For example, to find all resources that have a tag
--     with the key @Owner@ and the value @TeamA@, specify @tag:Owner@ for
--     the filter name and @TeamA@ for the filter value.
--
-- -   @tag-key@ - The key of a tag assigned to the resource. Use this
--     filter to find all resources assigned a tag with a specific key,
--     regardless of the tag value.
--
-- -   @vpc-id@ - The ID of the VPC associated with the carrier gateway.
describeCarrierGateways_filters :: Lens.Lens' DescribeCarrierGateways (Prelude.Maybe [Filter])
describeCarrierGateways_filters :: Lens' DescribeCarrierGateways (Maybe [Filter])
describeCarrierGateways_filters = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCarrierGateways' {Maybe [Filter]
filters :: Maybe [Filter]
$sel:filters:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe [Filter]
filters} -> Maybe [Filter]
filters) (\s :: DescribeCarrierGateways
s@DescribeCarrierGateways' {} Maybe [Filter]
a -> DescribeCarrierGateways
s {$sel:filters:DescribeCarrierGateways' :: Maybe [Filter]
filters = Maybe [Filter]
a} :: DescribeCarrierGateways) 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 maximum number of results to return with a single call. To retrieve
-- the remaining results, make another call with the returned @nextToken@
-- value.
describeCarrierGateways_maxResults :: Lens.Lens' DescribeCarrierGateways (Prelude.Maybe Prelude.Natural)
describeCarrierGateways_maxResults :: Lens' DescribeCarrierGateways (Maybe Natural)
describeCarrierGateways_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCarrierGateways' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: DescribeCarrierGateways
s@DescribeCarrierGateways' {} Maybe Natural
a -> DescribeCarrierGateways
s {$sel:maxResults:DescribeCarrierGateways' :: Maybe Natural
maxResults = Maybe Natural
a} :: DescribeCarrierGateways)

-- | The token for the next page of results.
describeCarrierGateways_nextToken :: Lens.Lens' DescribeCarrierGateways (Prelude.Maybe Prelude.Text)
describeCarrierGateways_nextToken :: Lens' DescribeCarrierGateways (Maybe Text)
describeCarrierGateways_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCarrierGateways' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeCarrierGateways
s@DescribeCarrierGateways' {} Maybe Text
a -> DescribeCarrierGateways
s {$sel:nextToken:DescribeCarrierGateways' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeCarrierGateways)

instance Core.AWSPager DescribeCarrierGateways where
  page :: DescribeCarrierGateways
-> AWSResponse DescribeCarrierGateways
-> Maybe DescribeCarrierGateways
page DescribeCarrierGateways
rq AWSResponse DescribeCarrierGateways
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse DescribeCarrierGateways
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeCarrierGatewaysResponse (Maybe Text)
describeCarrierGatewaysResponse_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 DescribeCarrierGateways
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeCarrierGatewaysResponse (Maybe [CarrierGateway])
describeCarrierGatewaysResponse_carrierGateways
            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.$ DescribeCarrierGateways
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' DescribeCarrierGateways (Maybe Text)
describeCarrierGateways_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse DescribeCarrierGateways
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeCarrierGatewaysResponse (Maybe Text)
describeCarrierGatewaysResponse_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 DescribeCarrierGateways where
  type
    AWSResponse DescribeCarrierGateways =
      DescribeCarrierGatewaysResponse
  request :: (Service -> Service)
-> DescribeCarrierGateways -> Request DescribeCarrierGateways
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.postQuery (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy DescribeCarrierGateways
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse DescribeCarrierGateways)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> [Node] -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveXML
      ( \Int
s ResponseHeaders
h [Node]
x ->
          Maybe [CarrierGateway]
-> Maybe Text -> Int -> DescribeCarrierGatewaysResponse
DescribeCarrierGatewaysResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ( [Node]
x
                            forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"carrierGatewaySet"
                            forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                            forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
Prelude.>>= forall (f :: * -> *) a b.
Applicative f =>
([a] -> f b) -> [a] -> f (Maybe b)
Core.may (forall a. FromXML a => Text -> [Node] -> Either String [a]
Data.parseXMLList Text
"item")
                        )
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"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 DescribeCarrierGateways where
  hashWithSalt :: Int -> DescribeCarrierGateways -> Int
hashWithSalt Int
_salt DescribeCarrierGateways' {Maybe Bool
Maybe Natural
Maybe [Text]
Maybe [Filter]
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
filters :: Maybe [Filter]
dryRun :: Maybe Bool
carrierGatewayIds :: Maybe [Text]
$sel:nextToken:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe Text
$sel:maxResults:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe Natural
$sel:filters:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe [Filter]
$sel:dryRun:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe Bool
$sel:carrierGatewayIds:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe [Text]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
carrierGatewayIds
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
dryRun
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Filter]
filters
      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 DescribeCarrierGateways where
  rnf :: DescribeCarrierGateways -> ()
rnf DescribeCarrierGateways' {Maybe Bool
Maybe Natural
Maybe [Text]
Maybe [Filter]
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
filters :: Maybe [Filter]
dryRun :: Maybe Bool
carrierGatewayIds :: Maybe [Text]
$sel:nextToken:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe Text
$sel:maxResults:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe Natural
$sel:filters:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe [Filter]
$sel:dryRun:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe Bool
$sel:carrierGatewayIds:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe [Text]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
carrierGatewayIds
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
dryRun
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Filter]
filters
      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 DescribeCarrierGateways where
  toHeaders :: DescribeCarrierGateways -> ResponseHeaders
toHeaders = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

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

instance Data.ToQuery DescribeCarrierGateways where
  toQuery :: DescribeCarrierGateways -> QueryString
toQuery DescribeCarrierGateways' {Maybe Bool
Maybe Natural
Maybe [Text]
Maybe [Filter]
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
filters :: Maybe [Filter]
dryRun :: Maybe Bool
carrierGatewayIds :: Maybe [Text]
$sel:nextToken:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe Text
$sel:maxResults:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe Natural
$sel:filters:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe [Filter]
$sel:dryRun:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe Bool
$sel:carrierGatewayIds:DescribeCarrierGateways' :: DescribeCarrierGateways -> Maybe [Text]
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"Action"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: (ByteString
"DescribeCarrierGateways" :: Prelude.ByteString),
        ByteString
"Version"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: (ByteString
"2016-11-15" :: Prelude.ByteString),
        forall a. ToQuery a => a -> QueryString
Data.toQuery
          ( forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Data.toQueryList ByteString
"CarrierGatewayId"
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Text]
carrierGatewayIds
          ),
        ByteString
"DryRun" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Bool
dryRun,
        forall a. ToQuery a => a -> QueryString
Data.toQuery
          (forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Data.toQueryList ByteString
"Filter" forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Filter]
filters),
        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:/ 'newDescribeCarrierGatewaysResponse' smart constructor.
data DescribeCarrierGatewaysResponse = DescribeCarrierGatewaysResponse'
  { -- | Information about the carrier gateway.
    DescribeCarrierGatewaysResponse -> Maybe [CarrierGateway]
carrierGateways :: Prelude.Maybe [CarrierGateway],
    -- | The token to use to retrieve the next page of results. This value is
    -- @null@ when there are no more results to return.
    DescribeCarrierGatewaysResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    DescribeCarrierGatewaysResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeCarrierGatewaysResponse
-> DescribeCarrierGatewaysResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeCarrierGatewaysResponse
-> DescribeCarrierGatewaysResponse -> Bool
$c/= :: DescribeCarrierGatewaysResponse
-> DescribeCarrierGatewaysResponse -> Bool
== :: DescribeCarrierGatewaysResponse
-> DescribeCarrierGatewaysResponse -> Bool
$c== :: DescribeCarrierGatewaysResponse
-> DescribeCarrierGatewaysResponse -> Bool
Prelude.Eq, ReadPrec [DescribeCarrierGatewaysResponse]
ReadPrec DescribeCarrierGatewaysResponse
Int -> ReadS DescribeCarrierGatewaysResponse
ReadS [DescribeCarrierGatewaysResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeCarrierGatewaysResponse]
$creadListPrec :: ReadPrec [DescribeCarrierGatewaysResponse]
readPrec :: ReadPrec DescribeCarrierGatewaysResponse
$creadPrec :: ReadPrec DescribeCarrierGatewaysResponse
readList :: ReadS [DescribeCarrierGatewaysResponse]
$creadList :: ReadS [DescribeCarrierGatewaysResponse]
readsPrec :: Int -> ReadS DescribeCarrierGatewaysResponse
$creadsPrec :: Int -> ReadS DescribeCarrierGatewaysResponse
Prelude.Read, Int -> DescribeCarrierGatewaysResponse -> ShowS
[DescribeCarrierGatewaysResponse] -> ShowS
DescribeCarrierGatewaysResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeCarrierGatewaysResponse] -> ShowS
$cshowList :: [DescribeCarrierGatewaysResponse] -> ShowS
show :: DescribeCarrierGatewaysResponse -> String
$cshow :: DescribeCarrierGatewaysResponse -> String
showsPrec :: Int -> DescribeCarrierGatewaysResponse -> ShowS
$cshowsPrec :: Int -> DescribeCarrierGatewaysResponse -> ShowS
Prelude.Show, forall x.
Rep DescribeCarrierGatewaysResponse x
-> DescribeCarrierGatewaysResponse
forall x.
DescribeCarrierGatewaysResponse
-> Rep DescribeCarrierGatewaysResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeCarrierGatewaysResponse x
-> DescribeCarrierGatewaysResponse
$cfrom :: forall x.
DescribeCarrierGatewaysResponse
-> Rep DescribeCarrierGatewaysResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeCarrierGatewaysResponse' 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:
--
-- 'carrierGateways', 'describeCarrierGatewaysResponse_carrierGateways' - Information about the carrier gateway.
--
-- 'nextToken', 'describeCarrierGatewaysResponse_nextToken' - The token to use to retrieve the next page of results. This value is
-- @null@ when there are no more results to return.
--
-- 'httpStatus', 'describeCarrierGatewaysResponse_httpStatus' - The response's http status code.
newDescribeCarrierGatewaysResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeCarrierGatewaysResponse
newDescribeCarrierGatewaysResponse :: Int -> DescribeCarrierGatewaysResponse
newDescribeCarrierGatewaysResponse Int
pHttpStatus_ =
  DescribeCarrierGatewaysResponse'
    { $sel:carrierGateways:DescribeCarrierGatewaysResponse' :: Maybe [CarrierGateway]
carrierGateways =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeCarrierGatewaysResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeCarrierGatewaysResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Information about the carrier gateway.
describeCarrierGatewaysResponse_carrierGateways :: Lens.Lens' DescribeCarrierGatewaysResponse (Prelude.Maybe [CarrierGateway])
describeCarrierGatewaysResponse_carrierGateways :: Lens' DescribeCarrierGatewaysResponse (Maybe [CarrierGateway])
describeCarrierGatewaysResponse_carrierGateways = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCarrierGatewaysResponse' {Maybe [CarrierGateway]
carrierGateways :: Maybe [CarrierGateway]
$sel:carrierGateways:DescribeCarrierGatewaysResponse' :: DescribeCarrierGatewaysResponse -> Maybe [CarrierGateway]
carrierGateways} -> Maybe [CarrierGateway]
carrierGateways) (\s :: DescribeCarrierGatewaysResponse
s@DescribeCarrierGatewaysResponse' {} Maybe [CarrierGateway]
a -> DescribeCarrierGatewaysResponse
s {$sel:carrierGateways:DescribeCarrierGatewaysResponse' :: Maybe [CarrierGateway]
carrierGateways = Maybe [CarrierGateway]
a} :: DescribeCarrierGatewaysResponse) 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 token to use to retrieve the next page of results. This value is
-- @null@ when there are no more results to return.
describeCarrierGatewaysResponse_nextToken :: Lens.Lens' DescribeCarrierGatewaysResponse (Prelude.Maybe Prelude.Text)
describeCarrierGatewaysResponse_nextToken :: Lens' DescribeCarrierGatewaysResponse (Maybe Text)
describeCarrierGatewaysResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCarrierGatewaysResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeCarrierGatewaysResponse' :: DescribeCarrierGatewaysResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeCarrierGatewaysResponse
s@DescribeCarrierGatewaysResponse' {} Maybe Text
a -> DescribeCarrierGatewaysResponse
s {$sel:nextToken:DescribeCarrierGatewaysResponse' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeCarrierGatewaysResponse)

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

instance
  Prelude.NFData
    DescribeCarrierGatewaysResponse
  where
  rnf :: DescribeCarrierGatewaysResponse -> ()
rnf DescribeCarrierGatewaysResponse' {Int
Maybe [CarrierGateway]
Maybe Text
httpStatus :: Int
nextToken :: Maybe Text
carrierGateways :: Maybe [CarrierGateway]
$sel:httpStatus:DescribeCarrierGatewaysResponse' :: DescribeCarrierGatewaysResponse -> Int
$sel:nextToken:DescribeCarrierGatewaysResponse' :: DescribeCarrierGatewaysResponse -> Maybe Text
$sel:carrierGateways:DescribeCarrierGatewaysResponse' :: DescribeCarrierGatewaysResponse -> Maybe [CarrierGateway]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [CarrierGateway]
carrierGateways
      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