Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Rekognition.CreateDataset

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Creating a Request

data CreateDataset Source #

See: newCreateDataset smart constructor.

Constructors

CreateDataset'

Fields

datasetSource :: Maybe 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 :: DatasetType
The type of the dataset. Specify train to create a training dataset. Specify test to create a test dataset.
projectArn :: Text
The ARN of the Amazon Rekognition Custom Labels project to which you want to asssign the dataset.

Instances

Instances details

ToJSON CreateDataset Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset Methods toJSON :: CreateDataset -> Value # toEncoding :: CreateDataset -> Encoding # toJSONList :: [CreateDataset] -> Value # toEncodingList :: [CreateDataset] -> Encoding #
ToHeaders CreateDataset Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset Methods toHeaders :: CreateDataset -> [Header] #
ToPath CreateDataset Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset Methods toPath :: CreateDataset -> ByteString #
ToQuery CreateDataset Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset Methods toQuery :: CreateDataset -> QueryString #
AWSRequest CreateDataset Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset Associated Types type AWSResponse CreateDataset # Methods request :: (Service -> Service) -> CreateDataset -> Request CreateDataset # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDataset -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDataset))) #
Generic CreateDataset Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset Associated Types type Rep CreateDataset :: Type -> Type # Methods from :: CreateDataset -> Rep CreateDataset x # to :: Rep CreateDataset x -> CreateDataset #
Read CreateDataset Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset Methods readsPrec :: Int -> ReadS CreateDataset # readList :: ReadS [CreateDataset] # readPrec :: ReadPrec CreateDataset # readListPrec :: ReadPrec [CreateDataset] #
Show CreateDataset Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset Methods showsPrec :: Int -> CreateDataset -> ShowS # show :: CreateDataset -> String # showList :: [CreateDataset] -> ShowS #
NFData CreateDataset Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset Methods rnf :: CreateDataset -> () #
Eq CreateDataset Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset Methods (==) :: CreateDataset -> CreateDataset -> Bool # (/=) :: CreateDataset -> CreateDataset -> Bool #
Hashable CreateDataset Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset Methods hashWithSalt :: Int -> CreateDataset -> Int # hash :: CreateDataset -> Int #
type AWSResponse CreateDataset Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset type AWSResponse CreateDataset = CreateDatasetResponse
type Rep CreateDataset Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset type Rep CreateDataset = D1 ('MetaData "CreateDataset" "Amazonka.Rekognition.CreateDataset" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "CreateDataset'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DatasetSource)) :: (S1 ('MetaSel ('Just "datasetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DatasetType) :: S1 ('MetaSel ('Just "projectArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateDataset Source #

Arguments

:: DatasetType	`CreateDataset`
-> Text	`CreateDataset`
-> CreateDataset

Create a value of CreateDataset with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:datasetSource:CreateDataset', 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.

CreateDataset, createDataset_datasetType - The type of the dataset. Specify train to create a training dataset. Specify test to create a test dataset.

CreateDataset, createDataset_projectArn - The ARN of the Amazon Rekognition Custom Labels project to which you want to asssign the dataset.

Request Lenses

createDataset_datasetSource :: Lens' CreateDataset (Maybe DatasetSource) Source #

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_datasetType :: Lens' CreateDataset DatasetType Source #

The type of the dataset. Specify train to create a training dataset. Specify test to create a test dataset.

createDataset_projectArn :: Lens' CreateDataset Text Source #

The ARN of the Amazon Rekognition Custom Labels project to which you want to asssign the dataset.

Destructuring the Response

data CreateDatasetResponse Source #

See: newCreateDatasetResponse smart constructor.

Constructors

CreateDatasetResponse'
Fields datasetArn :: Maybe Text The ARN of the created Amazon Rekognition Custom Labels dataset. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDatasetResponse Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset Associated Types type Rep CreateDatasetResponse :: Type -> Type # Methods from :: CreateDatasetResponse -> Rep CreateDatasetResponse x # to :: Rep CreateDatasetResponse x -> CreateDatasetResponse #
Read CreateDatasetResponse Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset Methods readsPrec :: Int -> ReadS CreateDatasetResponse # readList :: ReadS [CreateDatasetResponse] # readPrec :: ReadPrec CreateDatasetResponse # readListPrec :: ReadPrec [CreateDatasetResponse] #
Show CreateDatasetResponse Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset Methods showsPrec :: Int -> CreateDatasetResponse -> ShowS # show :: CreateDatasetResponse -> String # showList :: [CreateDatasetResponse] -> ShowS #
NFData CreateDatasetResponse Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset Methods rnf :: CreateDatasetResponse -> () #
Eq CreateDatasetResponse Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset Methods (==) :: CreateDatasetResponse -> CreateDatasetResponse -> Bool # (/=) :: CreateDatasetResponse -> CreateDatasetResponse -> Bool #
type Rep CreateDatasetResponse Source #
Instance details Defined in Amazonka.Rekognition.CreateDataset type Rep CreateDatasetResponse = D1 ('MetaData "CreateDatasetResponse" "Amazonka.Rekognition.CreateDataset" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "CreateDatasetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDatasetResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDatasetResponse'`
-> CreateDatasetResponse

Create a value of CreateDatasetResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateDatasetResponse, createDatasetResponse_datasetArn - The ARN of the created Amazon Rekognition Custom Labels dataset.

$sel:httpStatus:CreateDatasetResponse', createDatasetResponse_httpStatus - The response's http status code.

Response Lenses

createDatasetResponse_datasetArn :: Lens' CreateDatasetResponse (Maybe Text) Source #

The ARN of the created Amazon Rekognition Custom Labels dataset.

createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int Source #

The response's http status code.