{-# 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.Personalize.DescribeDatasetExportJob
-- 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 the dataset export job created by
-- <https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html CreateDatasetExportJob>,
-- including the export job status.
module Amazonka.Personalize.DescribeDatasetExportJob
  ( -- * Creating a Request
    DescribeDatasetExportJob (..),
    newDescribeDatasetExportJob,

    -- * Request Lenses
    describeDatasetExportJob_datasetExportJobArn,

    -- * Destructuring the Response
    DescribeDatasetExportJobResponse (..),
    newDescribeDatasetExportJobResponse,

    -- * Response Lenses
    describeDatasetExportJobResponse_datasetExportJob,
    describeDatasetExportJobResponse_httpStatus,
  )
where

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

-- | /See:/ 'newDescribeDatasetExportJob' smart constructor.
data DescribeDatasetExportJob = DescribeDatasetExportJob'
  { -- | The Amazon Resource Name (ARN) of the dataset export job to describe.
    DescribeDatasetExportJob -> Text
datasetExportJobArn :: Prelude.Text
  }
  deriving (DescribeDatasetExportJob -> DescribeDatasetExportJob -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeDatasetExportJob -> DescribeDatasetExportJob -> Bool
$c/= :: DescribeDatasetExportJob -> DescribeDatasetExportJob -> Bool
== :: DescribeDatasetExportJob -> DescribeDatasetExportJob -> Bool
$c== :: DescribeDatasetExportJob -> DescribeDatasetExportJob -> Bool
Prelude.Eq, ReadPrec [DescribeDatasetExportJob]
ReadPrec DescribeDatasetExportJob
Int -> ReadS DescribeDatasetExportJob
ReadS [DescribeDatasetExportJob]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeDatasetExportJob]
$creadListPrec :: ReadPrec [DescribeDatasetExportJob]
readPrec :: ReadPrec DescribeDatasetExportJob
$creadPrec :: ReadPrec DescribeDatasetExportJob
readList :: ReadS [DescribeDatasetExportJob]
$creadList :: ReadS [DescribeDatasetExportJob]
readsPrec :: Int -> ReadS DescribeDatasetExportJob
$creadsPrec :: Int -> ReadS DescribeDatasetExportJob
Prelude.Read, Int -> DescribeDatasetExportJob -> ShowS
[DescribeDatasetExportJob] -> ShowS
DescribeDatasetExportJob -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeDatasetExportJob] -> ShowS
$cshowList :: [DescribeDatasetExportJob] -> ShowS
show :: DescribeDatasetExportJob -> String
$cshow :: DescribeDatasetExportJob -> String
showsPrec :: Int -> DescribeDatasetExportJob -> ShowS
$cshowsPrec :: Int -> DescribeDatasetExportJob -> ShowS
Prelude.Show, forall x.
Rep DescribeDatasetExportJob x -> DescribeDatasetExportJob
forall x.
DescribeDatasetExportJob -> Rep DescribeDatasetExportJob x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeDatasetExportJob x -> DescribeDatasetExportJob
$cfrom :: forall x.
DescribeDatasetExportJob -> Rep DescribeDatasetExportJob x
Prelude.Generic)

-- |
-- Create a value of 'DescribeDatasetExportJob' 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:
--
-- 'datasetExportJobArn', 'describeDatasetExportJob_datasetExportJobArn' - The Amazon Resource Name (ARN) of the dataset export job to describe.
newDescribeDatasetExportJob ::
  -- | 'datasetExportJobArn'
  Prelude.Text ->
  DescribeDatasetExportJob
newDescribeDatasetExportJob :: Text -> DescribeDatasetExportJob
newDescribeDatasetExportJob Text
pDatasetExportJobArn_ =
  DescribeDatasetExportJob'
    { $sel:datasetExportJobArn:DescribeDatasetExportJob' :: Text
datasetExportJobArn =
        Text
pDatasetExportJobArn_
    }

-- | The Amazon Resource Name (ARN) of the dataset export job to describe.
describeDatasetExportJob_datasetExportJobArn :: Lens.Lens' DescribeDatasetExportJob Prelude.Text
describeDatasetExportJob_datasetExportJobArn :: Lens' DescribeDatasetExportJob Text
describeDatasetExportJob_datasetExportJobArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDatasetExportJob' {Text
datasetExportJobArn :: Text
$sel:datasetExportJobArn:DescribeDatasetExportJob' :: DescribeDatasetExportJob -> Text
datasetExportJobArn} -> Text
datasetExportJobArn) (\s :: DescribeDatasetExportJob
s@DescribeDatasetExportJob' {} Text
a -> DescribeDatasetExportJob
s {$sel:datasetExportJobArn:DescribeDatasetExportJob' :: Text
datasetExportJobArn = Text
a} :: DescribeDatasetExportJob)

instance Core.AWSRequest DescribeDatasetExportJob where
  type
    AWSResponse DescribeDatasetExportJob =
      DescribeDatasetExportJobResponse
  request :: (Service -> Service)
-> DescribeDatasetExportJob -> Request DescribeDatasetExportJob
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 DescribeDatasetExportJob
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse DescribeDatasetExportJob)))
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 DatasetExportJob -> Int -> DescribeDatasetExportJobResponse
DescribeDatasetExportJobResponse'
            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
"datasetExportJob")
            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 DescribeDatasetExportJob where
  hashWithSalt :: Int -> DescribeDatasetExportJob -> Int
hashWithSalt Int
_salt DescribeDatasetExportJob' {Text
datasetExportJobArn :: Text
$sel:datasetExportJobArn:DescribeDatasetExportJob' :: DescribeDatasetExportJob -> Text
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
datasetExportJobArn

instance Prelude.NFData DescribeDatasetExportJob where
  rnf :: DescribeDatasetExportJob -> ()
rnf DescribeDatasetExportJob' {Text
datasetExportJobArn :: Text
$sel:datasetExportJobArn:DescribeDatasetExportJob' :: DescribeDatasetExportJob -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
datasetExportJobArn

instance Data.ToHeaders DescribeDatasetExportJob where
  toHeaders :: DescribeDatasetExportJob -> 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
"AmazonPersonalize.DescribeDatasetExportJob" ::
                          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 DescribeDatasetExportJob where
  toJSON :: DescribeDatasetExportJob -> Value
toJSON DescribeDatasetExportJob' {Text
datasetExportJobArn :: Text
$sel:datasetExportJobArn:DescribeDatasetExportJob' :: DescribeDatasetExportJob -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just
              (Key
"datasetExportJobArn" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
datasetExportJobArn)
          ]
      )

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

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

-- | /See:/ 'newDescribeDatasetExportJobResponse' smart constructor.
data DescribeDatasetExportJobResponse = DescribeDatasetExportJobResponse'
  { -- | Information about the dataset export job, including the status.
    --
    -- The status is one of the following values:
    --
    -- -   CREATE PENDING
    --
    -- -   CREATE IN_PROGRESS
    --
    -- -   ACTIVE
    --
    -- -   CREATE FAILED
    DescribeDatasetExportJobResponse -> Maybe DatasetExportJob
datasetExportJob :: Prelude.Maybe DatasetExportJob,
    -- | The response's http status code.
    DescribeDatasetExportJobResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeDatasetExportJobResponse
-> DescribeDatasetExportJobResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeDatasetExportJobResponse
-> DescribeDatasetExportJobResponse -> Bool
$c/= :: DescribeDatasetExportJobResponse
-> DescribeDatasetExportJobResponse -> Bool
== :: DescribeDatasetExportJobResponse
-> DescribeDatasetExportJobResponse -> Bool
$c== :: DescribeDatasetExportJobResponse
-> DescribeDatasetExportJobResponse -> Bool
Prelude.Eq, ReadPrec [DescribeDatasetExportJobResponse]
ReadPrec DescribeDatasetExportJobResponse
Int -> ReadS DescribeDatasetExportJobResponse
ReadS [DescribeDatasetExportJobResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeDatasetExportJobResponse]
$creadListPrec :: ReadPrec [DescribeDatasetExportJobResponse]
readPrec :: ReadPrec DescribeDatasetExportJobResponse
$creadPrec :: ReadPrec DescribeDatasetExportJobResponse
readList :: ReadS [DescribeDatasetExportJobResponse]
$creadList :: ReadS [DescribeDatasetExportJobResponse]
readsPrec :: Int -> ReadS DescribeDatasetExportJobResponse
$creadsPrec :: Int -> ReadS DescribeDatasetExportJobResponse
Prelude.Read, Int -> DescribeDatasetExportJobResponse -> ShowS
[DescribeDatasetExportJobResponse] -> ShowS
DescribeDatasetExportJobResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeDatasetExportJobResponse] -> ShowS
$cshowList :: [DescribeDatasetExportJobResponse] -> ShowS
show :: DescribeDatasetExportJobResponse -> String
$cshow :: DescribeDatasetExportJobResponse -> String
showsPrec :: Int -> DescribeDatasetExportJobResponse -> ShowS
$cshowsPrec :: Int -> DescribeDatasetExportJobResponse -> ShowS
Prelude.Show, forall x.
Rep DescribeDatasetExportJobResponse x
-> DescribeDatasetExportJobResponse
forall x.
DescribeDatasetExportJobResponse
-> Rep DescribeDatasetExportJobResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeDatasetExportJobResponse x
-> DescribeDatasetExportJobResponse
$cfrom :: forall x.
DescribeDatasetExportJobResponse
-> Rep DescribeDatasetExportJobResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeDatasetExportJobResponse' 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:
--
-- 'datasetExportJob', 'describeDatasetExportJobResponse_datasetExportJob' - Information about the dataset export job, including the status.
--
-- The status is one of the following values:
--
-- -   CREATE PENDING
--
-- -   CREATE IN_PROGRESS
--
-- -   ACTIVE
--
-- -   CREATE FAILED
--
-- 'httpStatus', 'describeDatasetExportJobResponse_httpStatus' - The response's http status code.
newDescribeDatasetExportJobResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeDatasetExportJobResponse
newDescribeDatasetExportJobResponse :: Int -> DescribeDatasetExportJobResponse
newDescribeDatasetExportJobResponse Int
pHttpStatus_ =
  DescribeDatasetExportJobResponse'
    { $sel:datasetExportJob:DescribeDatasetExportJobResponse' :: Maybe DatasetExportJob
datasetExportJob =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeDatasetExportJobResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Information about the dataset export job, including the status.
--
-- The status is one of the following values:
--
-- -   CREATE PENDING
--
-- -   CREATE IN_PROGRESS
--
-- -   ACTIVE
--
-- -   CREATE FAILED
describeDatasetExportJobResponse_datasetExportJob :: Lens.Lens' DescribeDatasetExportJobResponse (Prelude.Maybe DatasetExportJob)
describeDatasetExportJobResponse_datasetExportJob :: Lens' DescribeDatasetExportJobResponse (Maybe DatasetExportJob)
describeDatasetExportJobResponse_datasetExportJob = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDatasetExportJobResponse' {Maybe DatasetExportJob
datasetExportJob :: Maybe DatasetExportJob
$sel:datasetExportJob:DescribeDatasetExportJobResponse' :: DescribeDatasetExportJobResponse -> Maybe DatasetExportJob
datasetExportJob} -> Maybe DatasetExportJob
datasetExportJob) (\s :: DescribeDatasetExportJobResponse
s@DescribeDatasetExportJobResponse' {} Maybe DatasetExportJob
a -> DescribeDatasetExportJobResponse
s {$sel:datasetExportJob:DescribeDatasetExportJobResponse' :: Maybe DatasetExportJob
datasetExportJob = Maybe DatasetExportJob
a} :: DescribeDatasetExportJobResponse)

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

instance
  Prelude.NFData
    DescribeDatasetExportJobResponse
  where
  rnf :: DescribeDatasetExportJobResponse -> ()
rnf DescribeDatasetExportJobResponse' {Int
Maybe DatasetExportJob
httpStatus :: Int
datasetExportJob :: Maybe DatasetExportJob
$sel:httpStatus:DescribeDatasetExportJobResponse' :: DescribeDatasetExportJobResponse -> Int
$sel:datasetExportJob:DescribeDatasetExportJobResponse' :: DescribeDatasetExportJobResponse -> Maybe DatasetExportJob
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe DatasetExportJob
datasetExportJob
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus