{-# 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.Pinpoint.GetSegmentExportJobs
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Retrieves information about the status and settings of the export jobs
-- for a segment.
module Amazonka.Pinpoint.GetSegmentExportJobs
  ( -- * Creating a Request
    GetSegmentExportJobs (..),
    newGetSegmentExportJobs,

    -- * Request Lenses
    getSegmentExportJobs_pageSize,
    getSegmentExportJobs_token,
    getSegmentExportJobs_segmentId,
    getSegmentExportJobs_applicationId,

    -- * Destructuring the Response
    GetSegmentExportJobsResponse (..),
    newGetSegmentExportJobsResponse,

    -- * Response Lenses
    getSegmentExportJobsResponse_httpStatus,
    getSegmentExportJobsResponse_exportJobsResponse,
  )
where

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

-- | /See:/ 'newGetSegmentExportJobs' smart constructor.
data GetSegmentExportJobs = GetSegmentExportJobs'
  { -- | The maximum number of items to include in each page of a paginated
    -- response. This parameter is not supported for application, campaign, and
    -- journey metrics.
    GetSegmentExportJobs -> Maybe Text
pageSize :: Prelude.Maybe Prelude.Text,
    -- | The NextToken string that specifies which page of results to return in a
    -- paginated response.
    GetSegmentExportJobs -> Maybe Text
token :: Prelude.Maybe Prelude.Text,
    -- | The unique identifier for the segment.
    GetSegmentExportJobs -> Text
segmentId :: Prelude.Text,
    -- | The unique identifier for the application. This identifier is displayed
    -- as the __Project ID__ on the Amazon Pinpoint console.
    GetSegmentExportJobs -> Text
applicationId :: Prelude.Text
  }
  deriving (GetSegmentExportJobs -> GetSegmentExportJobs -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetSegmentExportJobs -> GetSegmentExportJobs -> Bool
$c/= :: GetSegmentExportJobs -> GetSegmentExportJobs -> Bool
== :: GetSegmentExportJobs -> GetSegmentExportJobs -> Bool
$c== :: GetSegmentExportJobs -> GetSegmentExportJobs -> Bool
Prelude.Eq, ReadPrec [GetSegmentExportJobs]
ReadPrec GetSegmentExportJobs
Int -> ReadS GetSegmentExportJobs
ReadS [GetSegmentExportJobs]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetSegmentExportJobs]
$creadListPrec :: ReadPrec [GetSegmentExportJobs]
readPrec :: ReadPrec GetSegmentExportJobs
$creadPrec :: ReadPrec GetSegmentExportJobs
readList :: ReadS [GetSegmentExportJobs]
$creadList :: ReadS [GetSegmentExportJobs]
readsPrec :: Int -> ReadS GetSegmentExportJobs
$creadsPrec :: Int -> ReadS GetSegmentExportJobs
Prelude.Read, Int -> GetSegmentExportJobs -> ShowS
[GetSegmentExportJobs] -> ShowS
GetSegmentExportJobs -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetSegmentExportJobs] -> ShowS
$cshowList :: [GetSegmentExportJobs] -> ShowS
show :: GetSegmentExportJobs -> String
$cshow :: GetSegmentExportJobs -> String
showsPrec :: Int -> GetSegmentExportJobs -> ShowS
$cshowsPrec :: Int -> GetSegmentExportJobs -> ShowS
Prelude.Show, forall x. Rep GetSegmentExportJobs x -> GetSegmentExportJobs
forall x. GetSegmentExportJobs -> Rep GetSegmentExportJobs x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetSegmentExportJobs x -> GetSegmentExportJobs
$cfrom :: forall x. GetSegmentExportJobs -> Rep GetSegmentExportJobs x
Prelude.Generic)

-- |
-- Create a value of 'GetSegmentExportJobs' 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:
--
-- 'pageSize', 'getSegmentExportJobs_pageSize' - The maximum number of items to include in each page of a paginated
-- response. This parameter is not supported for application, campaign, and
-- journey metrics.
--
-- 'token', 'getSegmentExportJobs_token' - The NextToken string that specifies which page of results to return in a
-- paginated response.
--
-- 'segmentId', 'getSegmentExportJobs_segmentId' - The unique identifier for the segment.
--
-- 'applicationId', 'getSegmentExportJobs_applicationId' - The unique identifier for the application. This identifier is displayed
-- as the __Project ID__ on the Amazon Pinpoint console.
newGetSegmentExportJobs ::
  -- | 'segmentId'
  Prelude.Text ->
  -- | 'applicationId'
  Prelude.Text ->
  GetSegmentExportJobs
newGetSegmentExportJobs :: Text -> Text -> GetSegmentExportJobs
newGetSegmentExportJobs Text
pSegmentId_ Text
pApplicationId_ =
  GetSegmentExportJobs'
    { $sel:pageSize:GetSegmentExportJobs' :: Maybe Text
pageSize = forall a. Maybe a
Prelude.Nothing,
      $sel:token:GetSegmentExportJobs' :: Maybe Text
token = forall a. Maybe a
Prelude.Nothing,
      $sel:segmentId:GetSegmentExportJobs' :: Text
segmentId = Text
pSegmentId_,
      $sel:applicationId:GetSegmentExportJobs' :: Text
applicationId = Text
pApplicationId_
    }

-- | The maximum number of items to include in each page of a paginated
-- response. This parameter is not supported for application, campaign, and
-- journey metrics.
getSegmentExportJobs_pageSize :: Lens.Lens' GetSegmentExportJobs (Prelude.Maybe Prelude.Text)
getSegmentExportJobs_pageSize :: Lens' GetSegmentExportJobs (Maybe Text)
getSegmentExportJobs_pageSize = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetSegmentExportJobs' {Maybe Text
pageSize :: Maybe Text
$sel:pageSize:GetSegmentExportJobs' :: GetSegmentExportJobs -> Maybe Text
pageSize} -> Maybe Text
pageSize) (\s :: GetSegmentExportJobs
s@GetSegmentExportJobs' {} Maybe Text
a -> GetSegmentExportJobs
s {$sel:pageSize:GetSegmentExportJobs' :: Maybe Text
pageSize = Maybe Text
a} :: GetSegmentExportJobs)

-- | The NextToken string that specifies which page of results to return in a
-- paginated response.
getSegmentExportJobs_token :: Lens.Lens' GetSegmentExportJobs (Prelude.Maybe Prelude.Text)
getSegmentExportJobs_token :: Lens' GetSegmentExportJobs (Maybe Text)
getSegmentExportJobs_token = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetSegmentExportJobs' {Maybe Text
token :: Maybe Text
$sel:token:GetSegmentExportJobs' :: GetSegmentExportJobs -> Maybe Text
token} -> Maybe Text
token) (\s :: GetSegmentExportJobs
s@GetSegmentExportJobs' {} Maybe Text
a -> GetSegmentExportJobs
s {$sel:token:GetSegmentExportJobs' :: Maybe Text
token = Maybe Text
a} :: GetSegmentExportJobs)

-- | The unique identifier for the segment.
getSegmentExportJobs_segmentId :: Lens.Lens' GetSegmentExportJobs Prelude.Text
getSegmentExportJobs_segmentId :: Lens' GetSegmentExportJobs Text
getSegmentExportJobs_segmentId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetSegmentExportJobs' {Text
segmentId :: Text
$sel:segmentId:GetSegmentExportJobs' :: GetSegmentExportJobs -> Text
segmentId} -> Text
segmentId) (\s :: GetSegmentExportJobs
s@GetSegmentExportJobs' {} Text
a -> GetSegmentExportJobs
s {$sel:segmentId:GetSegmentExportJobs' :: Text
segmentId = Text
a} :: GetSegmentExportJobs)

-- | The unique identifier for the application. This identifier is displayed
-- as the __Project ID__ on the Amazon Pinpoint console.
getSegmentExportJobs_applicationId :: Lens.Lens' GetSegmentExportJobs Prelude.Text
getSegmentExportJobs_applicationId :: Lens' GetSegmentExportJobs Text
getSegmentExportJobs_applicationId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetSegmentExportJobs' {Text
applicationId :: Text
$sel:applicationId:GetSegmentExportJobs' :: GetSegmentExportJobs -> Text
applicationId} -> Text
applicationId) (\s :: GetSegmentExportJobs
s@GetSegmentExportJobs' {} Text
a -> GetSegmentExportJobs
s {$sel:applicationId:GetSegmentExportJobs' :: Text
applicationId = Text
a} :: GetSegmentExportJobs)

instance Core.AWSRequest GetSegmentExportJobs where
  type
    AWSResponse GetSegmentExportJobs =
      GetSegmentExportJobsResponse
  request :: (Service -> Service)
-> GetSegmentExportJobs -> Request GetSegmentExportJobs
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 GetSegmentExportJobs
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse GetSegmentExportJobs)))
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 ->
          Int -> ExportJobsResponse -> GetSegmentExportJobsResponse
GetSegmentExportJobsResponse'
            forall (f :: * -> *) a b. Functor 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))
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall a. FromJSON a => Object -> Either String a
Data.eitherParseJSON Object
x)
      )

instance Prelude.Hashable GetSegmentExportJobs where
  hashWithSalt :: Int -> GetSegmentExportJobs -> Int
hashWithSalt Int
_salt GetSegmentExportJobs' {Maybe Text
Text
applicationId :: Text
segmentId :: Text
token :: Maybe Text
pageSize :: Maybe Text
$sel:applicationId:GetSegmentExportJobs' :: GetSegmentExportJobs -> Text
$sel:segmentId:GetSegmentExportJobs' :: GetSegmentExportJobs -> Text
$sel:token:GetSegmentExportJobs' :: GetSegmentExportJobs -> Maybe Text
$sel:pageSize:GetSegmentExportJobs' :: GetSegmentExportJobs -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
pageSize
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
token
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
segmentId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
applicationId

instance Prelude.NFData GetSegmentExportJobs where
  rnf :: GetSegmentExportJobs -> ()
rnf GetSegmentExportJobs' {Maybe Text
Text
applicationId :: Text
segmentId :: Text
token :: Maybe Text
pageSize :: Maybe Text
$sel:applicationId:GetSegmentExportJobs' :: GetSegmentExportJobs -> Text
$sel:segmentId:GetSegmentExportJobs' :: GetSegmentExportJobs -> Text
$sel:token:GetSegmentExportJobs' :: GetSegmentExportJobs -> Maybe Text
$sel:pageSize:GetSegmentExportJobs' :: GetSegmentExportJobs -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
pageSize
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
token
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
segmentId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
applicationId

instance Data.ToHeaders GetSegmentExportJobs where
  toHeaders :: GetSegmentExportJobs -> 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 GetSegmentExportJobs where
  toPath :: GetSegmentExportJobs -> ByteString
toPath GetSegmentExportJobs' {Maybe Text
Text
applicationId :: Text
segmentId :: Text
token :: Maybe Text
pageSize :: Maybe Text
$sel:applicationId:GetSegmentExportJobs' :: GetSegmentExportJobs -> Text
$sel:segmentId:GetSegmentExportJobs' :: GetSegmentExportJobs -> Text
$sel:token:GetSegmentExportJobs' :: GetSegmentExportJobs -> Maybe Text
$sel:pageSize:GetSegmentExportJobs' :: GetSegmentExportJobs -> Maybe Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"/v1/apps/",
        forall a. ToByteString a => a -> ByteString
Data.toBS Text
applicationId,
        ByteString
"/segments/",
        forall a. ToByteString a => a -> ByteString
Data.toBS Text
segmentId,
        ByteString
"/jobs/export"
      ]

instance Data.ToQuery GetSegmentExportJobs where
  toQuery :: GetSegmentExportJobs -> QueryString
toQuery GetSegmentExportJobs' {Maybe Text
Text
applicationId :: Text
segmentId :: Text
token :: Maybe Text
pageSize :: Maybe Text
$sel:applicationId:GetSegmentExportJobs' :: GetSegmentExportJobs -> Text
$sel:segmentId:GetSegmentExportJobs' :: GetSegmentExportJobs -> Text
$sel:token:GetSegmentExportJobs' :: GetSegmentExportJobs -> Maybe Text
$sel:pageSize:GetSegmentExportJobs' :: GetSegmentExportJobs -> Maybe Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ByteString
"page-size" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
pageSize, ByteString
"token" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
token]

-- | /See:/ 'newGetSegmentExportJobsResponse' smart constructor.
data GetSegmentExportJobsResponse = GetSegmentExportJobsResponse'
  { -- | The response's http status code.
    GetSegmentExportJobsResponse -> Int
httpStatus :: Prelude.Int,
    GetSegmentExportJobsResponse -> ExportJobsResponse
exportJobsResponse :: ExportJobsResponse
  }
  deriving (GetSegmentExportJobsResponse
-> GetSegmentExportJobsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetSegmentExportJobsResponse
-> GetSegmentExportJobsResponse -> Bool
$c/= :: GetSegmentExportJobsResponse
-> GetSegmentExportJobsResponse -> Bool
== :: GetSegmentExportJobsResponse
-> GetSegmentExportJobsResponse -> Bool
$c== :: GetSegmentExportJobsResponse
-> GetSegmentExportJobsResponse -> Bool
Prelude.Eq, ReadPrec [GetSegmentExportJobsResponse]
ReadPrec GetSegmentExportJobsResponse
Int -> ReadS GetSegmentExportJobsResponse
ReadS [GetSegmentExportJobsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetSegmentExportJobsResponse]
$creadListPrec :: ReadPrec [GetSegmentExportJobsResponse]
readPrec :: ReadPrec GetSegmentExportJobsResponse
$creadPrec :: ReadPrec GetSegmentExportJobsResponse
readList :: ReadS [GetSegmentExportJobsResponse]
$creadList :: ReadS [GetSegmentExportJobsResponse]
readsPrec :: Int -> ReadS GetSegmentExportJobsResponse
$creadsPrec :: Int -> ReadS GetSegmentExportJobsResponse
Prelude.Read, Int -> GetSegmentExportJobsResponse -> ShowS
[GetSegmentExportJobsResponse] -> ShowS
GetSegmentExportJobsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetSegmentExportJobsResponse] -> ShowS
$cshowList :: [GetSegmentExportJobsResponse] -> ShowS
show :: GetSegmentExportJobsResponse -> String
$cshow :: GetSegmentExportJobsResponse -> String
showsPrec :: Int -> GetSegmentExportJobsResponse -> ShowS
$cshowsPrec :: Int -> GetSegmentExportJobsResponse -> ShowS
Prelude.Show, forall x.
Rep GetSegmentExportJobsResponse x -> GetSegmentExportJobsResponse
forall x.
GetSegmentExportJobsResponse -> Rep GetSegmentExportJobsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep GetSegmentExportJobsResponse x -> GetSegmentExportJobsResponse
$cfrom :: forall x.
GetSegmentExportJobsResponse -> Rep GetSegmentExportJobsResponse x
Prelude.Generic)

-- |
-- Create a value of 'GetSegmentExportJobsResponse' 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:
--
-- 'httpStatus', 'getSegmentExportJobsResponse_httpStatus' - The response's http status code.
--
-- 'exportJobsResponse', 'getSegmentExportJobsResponse_exportJobsResponse' - Undocumented member.
newGetSegmentExportJobsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  -- | 'exportJobsResponse'
  ExportJobsResponse ->
  GetSegmentExportJobsResponse
newGetSegmentExportJobsResponse :: Int -> ExportJobsResponse -> GetSegmentExportJobsResponse
newGetSegmentExportJobsResponse
  Int
pHttpStatus_
  ExportJobsResponse
pExportJobsResponse_ =
    GetSegmentExportJobsResponse'
      { $sel:httpStatus:GetSegmentExportJobsResponse' :: Int
httpStatus =
          Int
pHttpStatus_,
        $sel:exportJobsResponse:GetSegmentExportJobsResponse' :: ExportJobsResponse
exportJobsResponse = ExportJobsResponse
pExportJobsResponse_
      }

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

-- | Undocumented member.
getSegmentExportJobsResponse_exportJobsResponse :: Lens.Lens' GetSegmentExportJobsResponse ExportJobsResponse
getSegmentExportJobsResponse_exportJobsResponse :: Lens' GetSegmentExportJobsResponse ExportJobsResponse
getSegmentExportJobsResponse_exportJobsResponse = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetSegmentExportJobsResponse' {ExportJobsResponse
exportJobsResponse :: ExportJobsResponse
$sel:exportJobsResponse:GetSegmentExportJobsResponse' :: GetSegmentExportJobsResponse -> ExportJobsResponse
exportJobsResponse} -> ExportJobsResponse
exportJobsResponse) (\s :: GetSegmentExportJobsResponse
s@GetSegmentExportJobsResponse' {} ExportJobsResponse
a -> GetSegmentExportJobsResponse
s {$sel:exportJobsResponse:GetSegmentExportJobsResponse' :: ExportJobsResponse
exportJobsResponse = ExportJobsResponse
a} :: GetSegmentExportJobsResponse)

instance Prelude.NFData GetSegmentExportJobsResponse where
  rnf :: GetSegmentExportJobsResponse -> ()
rnf GetSegmentExportJobsResponse' {Int
ExportJobsResponse
exportJobsResponse :: ExportJobsResponse
httpStatus :: Int
$sel:exportJobsResponse:GetSegmentExportJobsResponse' :: GetSegmentExportJobsResponse -> ExportJobsResponse
$sel:httpStatus:GetSegmentExportJobsResponse' :: GetSegmentExportJobsResponse -> Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf ExportJobsResponse
exportJobsResponse