| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Personalize.CreateDatasetGroup
Description
Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset:
- Interactions
- Items
- Users
To train a model (create a solution), a dataset group that contains an
Interactions dataset is required. Call CreateDataset to add a dataset
to the group.
A dataset group can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING
To get the status of the dataset group, call DescribeDatasetGroup. If
the status shows as CREATE FAILED, the response includes a
failureReason key, which describes why the creation failed.
You must wait until the status of the dataset group is ACTIVE before
adding a dataset to the group.
You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.
APIs that require a dataset group ARN in the request
- CreateDataset
- CreateEventTracker
- CreateSolution
Related APIs
- ListDatasetGroups
- DescribeDatasetGroup
- DeleteDatasetGroup
Synopsis
- data CreateDatasetGroup = CreateDatasetGroup' {}
- newCreateDatasetGroup :: Text -> CreateDatasetGroup
- createDatasetGroup_kmsKeyArn :: Lens' CreateDatasetGroup (Maybe Text)
- createDatasetGroup_roleArn :: Lens' CreateDatasetGroup (Maybe Text)
- createDatasetGroup_name :: Lens' CreateDatasetGroup Text
- data CreateDatasetGroupResponse = CreateDatasetGroupResponse' {}
- newCreateDatasetGroupResponse :: Int -> CreateDatasetGroupResponse
- createDatasetGroupResponse_datasetGroupArn :: Lens' CreateDatasetGroupResponse (Maybe Text)
- createDatasetGroupResponse_httpStatus :: Lens' CreateDatasetGroupResponse Int
Creating a Request
data CreateDatasetGroup Source #
See: newCreateDatasetGroup smart constructor.
Constructors
| CreateDatasetGroup' | |
Fields
| |
Instances
newCreateDatasetGroup Source #
Arguments
| :: Text | |
| -> CreateDatasetGroup |
Create a value of CreateDatasetGroup 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:kmsKeyArn:CreateDatasetGroup', createDatasetGroup_kmsKeyArn - The Amazon Resource Name (ARN) of a Key Management Service (KMS) key
used to encrypt the datasets.
$sel:roleArn:CreateDatasetGroup', createDatasetGroup_roleArn - The ARN of the Identity and Access Management (IAM) role that has
permissions to access the Key Management Service (KMS) key. Supplying an
IAM role is only valid when also specifying a KMS key.
$sel:name:CreateDatasetGroup', createDatasetGroup_name - The name for the new dataset group.
Request Lenses
createDatasetGroup_kmsKeyArn :: Lens' CreateDatasetGroup (Maybe Text) Source #
The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.
createDatasetGroup_roleArn :: Lens' CreateDatasetGroup (Maybe Text) Source #
The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.
createDatasetGroup_name :: Lens' CreateDatasetGroup Text Source #
The name for the new dataset group.
Destructuring the Response
data CreateDatasetGroupResponse Source #
See: newCreateDatasetGroupResponse smart constructor.
Constructors
| CreateDatasetGroupResponse' | |
Fields
| |
Instances
newCreateDatasetGroupResponse Source #
Create a value of CreateDatasetGroupResponse 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:datasetGroupArn:CreateDatasetGroupResponse', createDatasetGroupResponse_datasetGroupArn - The Amazon Resource Name (ARN) of the new dataset group.
$sel:httpStatus:CreateDatasetGroupResponse', createDatasetGroupResponse_httpStatus - The response's http status code.
Response Lenses
createDatasetGroupResponse_datasetGroupArn :: Lens' CreateDatasetGroupResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the new dataset group.
createDatasetGroupResponse_httpStatus :: Lens' CreateDatasetGroupResponse Int Source #
The response's http status code.