{-# 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.Rekognition.CreateDataset
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Creates a new Amazon Rekognition Custom Labels dataset. You can create a
-- dataset by using an Amazon Sagemaker format manifest file or by copying
-- an existing Amazon Rekognition Custom Labels dataset.
--
-- To create a training dataset for a project, specify @train@ for the
-- value of @DatasetType@. To create the test dataset for a project,
-- specify @test@ for the value of @DatasetType@.
--
-- The response from @CreateDataset@ is the Amazon Resource Name (ARN) for
-- the dataset. Creating a dataset takes a while to complete. Use
-- DescribeDataset to check the current status. The dataset created
-- successfully if the value of @Status@ is @CREATE_COMPLETE@.
--
-- To check if any non-terminal errors occurred, call ListDatasetEntries
-- and check for the presence of @errors@ lists in the JSON Lines.
--
-- Dataset creation fails if a terminal error occurs (@Status@ =
-- @CREATE_FAILED@). Currently, you can\'t access the terminal error
-- information.
--
-- For more information, see Creating dataset in the /Amazon Rekognition
-- Custom Labels Developer Guide/.
--
-- This operation requires permissions to perform the
-- @rekognition:CreateDataset@ action. If you want to copy an existing
-- dataset, you also require permission to perform the
-- @rekognition:ListDatasetEntries@ action.
module Amazonka.Rekognition.CreateDataset
  ( -- * Creating a Request
    CreateDataset (..),
    newCreateDataset,

    -- * Request Lenses
    createDataset_datasetSource,
    createDataset_datasetType,
    createDataset_projectArn,

    -- * Destructuring the Response
    CreateDatasetResponse (..),
    newCreateDatasetResponse,

    -- * Response Lenses
    createDatasetResponse_datasetArn,
    createDatasetResponse_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 Amazonka.Rekognition.Types
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newCreateDataset' smart constructor.
data CreateDataset = CreateDataset'
  { -- | The source files for the dataset. You can specify the ARN of an existing
    -- dataset or specify the Amazon S3 bucket location of an Amazon Sagemaker
    -- format manifest file. If you don\'t specify @datasetSource@, an empty
    -- dataset is created. To add labeled images to the dataset, You can use
    -- the console or call UpdateDatasetEntries.
    CreateDataset -> Maybe DatasetSource
datasetSource :: Prelude.Maybe DatasetSource,
    -- | The type of the dataset. Specify @train@ to create a training dataset.
    -- Specify @test@ to create a test dataset.
    CreateDataset -> DatasetType
datasetType :: DatasetType,
    -- | The ARN of the Amazon Rekognition Custom Labels project to which you
    -- want to asssign the dataset.
    CreateDataset -> Text
projectArn :: Prelude.Text
  }
  deriving (CreateDataset -> CreateDataset -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CreateDataset -> CreateDataset -> Bool
$c/= :: CreateDataset -> CreateDataset -> Bool
== :: CreateDataset -> CreateDataset -> Bool
$c== :: CreateDataset -> CreateDataset -> Bool
Prelude.Eq, ReadPrec [CreateDataset]
ReadPrec CreateDataset
Int -> ReadS CreateDataset
ReadS [CreateDataset]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CreateDataset]
$creadListPrec :: ReadPrec [CreateDataset]
readPrec :: ReadPrec CreateDataset
$creadPrec :: ReadPrec CreateDataset
readList :: ReadS [CreateDataset]
$creadList :: ReadS [CreateDataset]
readsPrec :: Int -> ReadS CreateDataset
$creadsPrec :: Int -> ReadS CreateDataset
Prelude.Read, Int -> CreateDataset -> ShowS
[CreateDataset] -> ShowS
CreateDataset -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CreateDataset] -> ShowS
$cshowList :: [CreateDataset] -> ShowS
show :: CreateDataset -> String
$cshow :: CreateDataset -> String
showsPrec :: Int -> CreateDataset -> ShowS
$cshowsPrec :: Int -> CreateDataset -> ShowS
Prelude.Show, forall x. Rep CreateDataset x -> CreateDataset
forall x. CreateDataset -> Rep CreateDataset x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep CreateDataset x -> CreateDataset
$cfrom :: forall x. CreateDataset -> Rep CreateDataset x
Prelude.Generic)

-- |
-- Create a value of 'CreateDataset' 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:
--
-- 'datasetSource', 'createDataset_datasetSource' - The source files for the dataset. You can specify the ARN of an existing
-- dataset or specify the Amazon S3 bucket location of an Amazon Sagemaker
-- format manifest file. If you don\'t specify @datasetSource@, an empty
-- dataset is created. To add labeled images to the dataset, You can use
-- the console or call UpdateDatasetEntries.
--
-- 'datasetType', 'createDataset_datasetType' - The type of the dataset. Specify @train@ to create a training dataset.
-- Specify @test@ to create a test dataset.
--
-- 'projectArn', 'createDataset_projectArn' - The ARN of the Amazon Rekognition Custom Labels project to which you
-- want to asssign the dataset.
newCreateDataset ::
  -- | 'datasetType'
  DatasetType ->
  -- | 'projectArn'
  Prelude.Text ->
  CreateDataset
newCreateDataset :: DatasetType -> Text -> CreateDataset
newCreateDataset DatasetType
pDatasetType_ Text
pProjectArn_ =
  CreateDataset'
    { $sel:datasetSource:CreateDataset' :: Maybe DatasetSource
datasetSource = forall a. Maybe a
Prelude.Nothing,
      $sel:datasetType:CreateDataset' :: DatasetType
datasetType = DatasetType
pDatasetType_,
      $sel:projectArn:CreateDataset' :: Text
projectArn = Text
pProjectArn_
    }

-- | The source files for the dataset. You can specify the ARN of an existing
-- dataset or specify the Amazon S3 bucket location of an Amazon Sagemaker
-- format manifest file. If you don\'t specify @datasetSource@, an empty
-- dataset is created. To add labeled images to the dataset, You can use
-- the console or call UpdateDatasetEntries.
createDataset_datasetSource :: Lens.Lens' CreateDataset (Prelude.Maybe DatasetSource)
createDataset_datasetSource :: Lens' CreateDataset (Maybe DatasetSource)
createDataset_datasetSource = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateDataset' {Maybe DatasetSource
datasetSource :: Maybe DatasetSource
$sel:datasetSource:CreateDataset' :: CreateDataset -> Maybe DatasetSource
datasetSource} -> Maybe DatasetSource
datasetSource) (\s :: CreateDataset
s@CreateDataset' {} Maybe DatasetSource
a -> CreateDataset
s {$sel:datasetSource:CreateDataset' :: Maybe DatasetSource
datasetSource = Maybe DatasetSource
a} :: CreateDataset)

-- | The type of the dataset. Specify @train@ to create a training dataset.
-- Specify @test@ to create a test dataset.
createDataset_datasetType :: Lens.Lens' CreateDataset DatasetType
createDataset_datasetType :: Lens' CreateDataset DatasetType
createDataset_datasetType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateDataset' {DatasetType
datasetType :: DatasetType
$sel:datasetType:CreateDataset' :: CreateDataset -> DatasetType
datasetType} -> DatasetType
datasetType) (\s :: CreateDataset
s@CreateDataset' {} DatasetType
a -> CreateDataset
s {$sel:datasetType:CreateDataset' :: DatasetType
datasetType = DatasetType
a} :: CreateDataset)

-- | The ARN of the Amazon Rekognition Custom Labels project to which you
-- want to asssign the dataset.
createDataset_projectArn :: Lens.Lens' CreateDataset Prelude.Text
createDataset_projectArn :: Lens' CreateDataset Text
createDataset_projectArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateDataset' {Text
projectArn :: Text
$sel:projectArn:CreateDataset' :: CreateDataset -> Text
projectArn} -> Text
projectArn) (\s :: CreateDataset
s@CreateDataset' {} Text
a -> CreateDataset
s {$sel:projectArn:CreateDataset' :: Text
projectArn = Text
a} :: CreateDataset)

instance Core.AWSRequest CreateDataset where
  type
    AWSResponse CreateDataset =
      CreateDatasetResponse
  request :: (Service -> Service) -> CreateDataset -> Request CreateDataset
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 CreateDataset
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse CreateDataset)))
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 -> Int -> CreateDatasetResponse
CreateDatasetResponse'
            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
"DatasetArn")
            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 CreateDataset where
  hashWithSalt :: Int -> CreateDataset -> Int
hashWithSalt Int
_salt CreateDataset' {Maybe DatasetSource
Text
DatasetType
projectArn :: Text
datasetType :: DatasetType
datasetSource :: Maybe DatasetSource
$sel:projectArn:CreateDataset' :: CreateDataset -> Text
$sel:datasetType:CreateDataset' :: CreateDataset -> DatasetType
$sel:datasetSource:CreateDataset' :: CreateDataset -> Maybe DatasetSource
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe DatasetSource
datasetSource
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` DatasetType
datasetType
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
projectArn

instance Prelude.NFData CreateDataset where
  rnf :: CreateDataset -> ()
rnf CreateDataset' {Maybe DatasetSource
Text
DatasetType
projectArn :: Text
datasetType :: DatasetType
datasetSource :: Maybe DatasetSource
$sel:projectArn:CreateDataset' :: CreateDataset -> Text
$sel:datasetType:CreateDataset' :: CreateDataset -> DatasetType
$sel:datasetSource:CreateDataset' :: CreateDataset -> Maybe DatasetSource
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe DatasetSource
datasetSource
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf DatasetType
datasetType
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
projectArn

instance Data.ToHeaders CreateDataset where
  toHeaders :: CreateDataset -> 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
"RekognitionService.CreateDataset" ::
                          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 CreateDataset where
  toJSON :: CreateDataset -> Value
toJSON CreateDataset' {Maybe DatasetSource
Text
DatasetType
projectArn :: Text
datasetType :: DatasetType
datasetSource :: Maybe DatasetSource
$sel:projectArn:CreateDataset' :: CreateDataset -> Text
$sel:datasetType:CreateDataset' :: CreateDataset -> DatasetType
$sel:datasetSource:CreateDataset' :: CreateDataset -> Maybe DatasetSource
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"DatasetSource" 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 DatasetSource
datasetSource,
            forall a. a -> Maybe a
Prelude.Just (Key
"DatasetType" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= DatasetType
datasetType),
            forall a. a -> Maybe a
Prelude.Just (Key
"ProjectArn" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
projectArn)
          ]
      )

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

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

-- | /See:/ 'newCreateDatasetResponse' smart constructor.
data CreateDatasetResponse = CreateDatasetResponse'
  { -- | The ARN of the created Amazon Rekognition Custom Labels dataset.
    CreateDatasetResponse -> Maybe Text
datasetArn :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    CreateDatasetResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (CreateDatasetResponse -> CreateDatasetResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CreateDatasetResponse -> CreateDatasetResponse -> Bool
$c/= :: CreateDatasetResponse -> CreateDatasetResponse -> Bool
== :: CreateDatasetResponse -> CreateDatasetResponse -> Bool
$c== :: CreateDatasetResponse -> CreateDatasetResponse -> Bool
Prelude.Eq, ReadPrec [CreateDatasetResponse]
ReadPrec CreateDatasetResponse
Int -> ReadS CreateDatasetResponse
ReadS [CreateDatasetResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CreateDatasetResponse]
$creadListPrec :: ReadPrec [CreateDatasetResponse]
readPrec :: ReadPrec CreateDatasetResponse
$creadPrec :: ReadPrec CreateDatasetResponse
readList :: ReadS [CreateDatasetResponse]
$creadList :: ReadS [CreateDatasetResponse]
readsPrec :: Int -> ReadS CreateDatasetResponse
$creadsPrec :: Int -> ReadS CreateDatasetResponse
Prelude.Read, Int -> CreateDatasetResponse -> ShowS
[CreateDatasetResponse] -> ShowS
CreateDatasetResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CreateDatasetResponse] -> ShowS
$cshowList :: [CreateDatasetResponse] -> ShowS
show :: CreateDatasetResponse -> String
$cshow :: CreateDatasetResponse -> String
showsPrec :: Int -> CreateDatasetResponse -> ShowS
$cshowsPrec :: Int -> CreateDatasetResponse -> ShowS
Prelude.Show, forall x. Rep CreateDatasetResponse x -> CreateDatasetResponse
forall x. CreateDatasetResponse -> Rep CreateDatasetResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep CreateDatasetResponse x -> CreateDatasetResponse
$cfrom :: forall x. CreateDatasetResponse -> Rep CreateDatasetResponse x
Prelude.Generic)

-- |
-- Create a value of 'CreateDatasetResponse' 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:
--
-- 'datasetArn', 'createDatasetResponse_datasetArn' - The ARN of the created Amazon Rekognition Custom Labels dataset.
--
-- 'httpStatus', 'createDatasetResponse_httpStatus' - The response's http status code.
newCreateDatasetResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  CreateDatasetResponse
newCreateDatasetResponse :: Int -> CreateDatasetResponse
newCreateDatasetResponse Int
pHttpStatus_ =
  CreateDatasetResponse'
    { $sel:datasetArn:CreateDatasetResponse' :: Maybe Text
datasetArn =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:CreateDatasetResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The ARN of the created Amazon Rekognition Custom Labels dataset.
createDatasetResponse_datasetArn :: Lens.Lens' CreateDatasetResponse (Prelude.Maybe Prelude.Text)
createDatasetResponse_datasetArn :: Lens' CreateDatasetResponse (Maybe Text)
createDatasetResponse_datasetArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateDatasetResponse' {Maybe Text
datasetArn :: Maybe Text
$sel:datasetArn:CreateDatasetResponse' :: CreateDatasetResponse -> Maybe Text
datasetArn} -> Maybe Text
datasetArn) (\s :: CreateDatasetResponse
s@CreateDatasetResponse' {} Maybe Text
a -> CreateDatasetResponse
s {$sel:datasetArn:CreateDatasetResponse' :: Maybe Text
datasetArn = Maybe Text
a} :: CreateDatasetResponse)

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

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