libZSservicesZSamazonka-personalizeZSamazonka-personalize
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Personalize.Types.DatasetGroup

Description

 
Synopsis

Documentation

data DatasetGroup Source #

A dataset group is a collection of related datasets (Interactions, User, and Item). You create a dataset group by calling CreateDatasetGroup. You then create a dataset and add it to a dataset group by calling CreateDataset. The dataset group is used to create and train a solution by calling CreateSolution. A dataset group can contain only one of each type of dataset.

You can specify an Key Management Service (KMS) key to encrypt the datasets in the group.

See: newDatasetGroup smart constructor.

Constructors

DatasetGroup' 

Fields

  • failureReason :: Maybe Text

    If creating a dataset group fails, provides the reason why.

  • status :: Maybe Text

    The current status of the dataset group.

    A dataset group can be in one of the following states:

    • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
    • DELETE PENDING
  • kmsKeyArn :: Maybe Text

    The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.

  • lastUpdatedDateTime :: Maybe POSIX

    The last update date and time (in Unix time) of the dataset group.

  • name :: Maybe Text

    The name of the dataset group.

  • creationDateTime :: Maybe POSIX

    The creation date and time (in Unix time) of the dataset group.

  • datasetGroupArn :: Maybe Text

    The Amazon Resource Name (ARN) of the dataset group.

  • roleArn :: Maybe Text

    The ARN of the IAM role that has permissions to create the dataset group.

Instances

Instances details
Eq DatasetGroup Source # 
Instance details

Defined in Amazonka.Personalize.Types.DatasetGroup

Read DatasetGroup Source # 
Instance details

Defined in Amazonka.Personalize.Types.DatasetGroup

Show DatasetGroup Source # 
Instance details

Defined in Amazonka.Personalize.Types.DatasetGroup

Generic DatasetGroup Source # 
Instance details

Defined in Amazonka.Personalize.Types.DatasetGroup

Associated Types

type Rep DatasetGroup :: Type -> Type #

NFData DatasetGroup Source # 
Instance details

Defined in Amazonka.Personalize.Types.DatasetGroup

Methods

rnf :: DatasetGroup -> () #

Hashable DatasetGroup Source # 
Instance details

Defined in Amazonka.Personalize.Types.DatasetGroup

FromJSON DatasetGroup Source # 
Instance details

Defined in Amazonka.Personalize.Types.DatasetGroup

type Rep DatasetGroup Source # 
Instance details

Defined in Amazonka.Personalize.Types.DatasetGroup

type Rep DatasetGroup = D1 ('MetaData "DatasetGroup" "Amazonka.Personalize.Types.DatasetGroup" "libZSservicesZSamazonka-personalizeZSamazonka-personalize" 'False) (C1 ('MetaCons "DatasetGroup'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "kmsKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastUpdatedDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "datasetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDatasetGroup :: DatasetGroup Source #

Create a value of DatasetGroup 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:failureReason:DatasetGroup', datasetGroup_failureReason - If creating a dataset group fails, provides the reason why.

$sel:status:DatasetGroup', datasetGroup_status - The current status of the dataset group.

A dataset group can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
  • DELETE PENDING

$sel:kmsKeyArn:DatasetGroup', datasetGroup_kmsKeyArn - The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.

$sel:lastUpdatedDateTime:DatasetGroup', datasetGroup_lastUpdatedDateTime - The last update date and time (in Unix time) of the dataset group.

$sel:name:DatasetGroup', datasetGroup_name - The name of the dataset group.

$sel:creationDateTime:DatasetGroup', datasetGroup_creationDateTime - The creation date and time (in Unix time) of the dataset group.

$sel:datasetGroupArn:DatasetGroup', datasetGroup_datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group.

$sel:roleArn:DatasetGroup', datasetGroup_roleArn - The ARN of the IAM role that has permissions to create the dataset group.

datasetGroup_failureReason :: Lens' DatasetGroup (Maybe Text) Source #

If creating a dataset group fails, provides the reason why.

datasetGroup_status :: Lens' DatasetGroup (Maybe Text) Source #

The current status of the dataset group.

A dataset group can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
  • DELETE PENDING

datasetGroup_kmsKeyArn :: Lens' DatasetGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.

datasetGroup_lastUpdatedDateTime :: Lens' DatasetGroup (Maybe UTCTime) Source #

The last update date and time (in Unix time) of the dataset group.

datasetGroup_name :: Lens' DatasetGroup (Maybe Text) Source #

The name of the dataset group.

datasetGroup_creationDateTime :: Lens' DatasetGroup (Maybe UTCTime) Source #

The creation date and time (in Unix time) of the dataset group.

datasetGroup_datasetGroupArn :: Lens' DatasetGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset group.

datasetGroup_roleArn :: Lens' DatasetGroup (Maybe Text) Source #

The ARN of the IAM role that has permissions to create the dataset group.