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 |
Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset:
- Interactions
- Items
- Users
A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns.
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
Related APIs
Synopsis
- data CreateDatasetGroup = CreateDatasetGroup' {}
- newCreateDatasetGroup :: Text -> CreateDatasetGroup
- createDatasetGroup_domain :: Lens' CreateDatasetGroup (Maybe Domain)
- createDatasetGroup_kmsKeyArn :: Lens' CreateDatasetGroup (Maybe Text)
- createDatasetGroup_roleArn :: Lens' CreateDatasetGroup (Maybe Text)
- createDatasetGroup_tags :: Lens' CreateDatasetGroup (Maybe [Tag])
- createDatasetGroup_name :: Lens' CreateDatasetGroup Text
- data CreateDatasetGroupResponse = CreateDatasetGroupResponse' {
- datasetGroupArn :: Maybe Text
- domain :: Maybe Domain
- httpStatus :: Int
- newCreateDatasetGroupResponse :: Int -> CreateDatasetGroupResponse
- createDatasetGroupResponse_datasetGroupArn :: Lens' CreateDatasetGroupResponse (Maybe Text)
- createDatasetGroupResponse_domain :: Lens' CreateDatasetGroupResponse (Maybe Domain)
- createDatasetGroupResponse_httpStatus :: Lens' CreateDatasetGroupResponse Int
Creating a Request
data CreateDatasetGroup Source #
See: newCreateDatasetGroup
smart constructor.
CreateDatasetGroup' | |
|
Instances
newCreateDatasetGroup Source #
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:
CreateDatasetGroup
, createDatasetGroup_domain
- The domain of the dataset group. Specify a domain to create a Domain
dataset group. The domain you specify determines the default schemas for
datasets and the use cases available for recommenders. If you don't
specify a domain, you create a Custom dataset group with solution
versions that you deploy with a campaign.
CreateDatasetGroup
, createDatasetGroup_kmsKeyArn
- The Amazon Resource Name (ARN) of a Key Management Service (KMS) key
used to encrypt the datasets.
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:tags:CreateDatasetGroup'
, createDatasetGroup_tags
- A list of
tags
to apply to the dataset group.
CreateDatasetGroup
, createDatasetGroup_name
- The name for the new dataset group.
Request Lenses
createDatasetGroup_domain :: Lens' CreateDatasetGroup (Maybe Domain) Source #
The domain of the dataset group. Specify a domain to create a Domain dataset group. The domain you specify determines the default schemas for datasets and the use cases available for recommenders. If you don't specify a domain, you create a Custom dataset group with solution versions that you deploy with a campaign.
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_tags :: Lens' CreateDatasetGroup (Maybe [Tag]) Source #
A list of tags to apply to the dataset group.
createDatasetGroup_name :: Lens' CreateDatasetGroup Text Source #
The name for the new dataset group.
Destructuring the Response
data CreateDatasetGroupResponse Source #
See: newCreateDatasetGroupResponse
smart constructor.
CreateDatasetGroupResponse' | |
|
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:
CreateDatasetGroupResponse
, createDatasetGroupResponse_datasetGroupArn
- The Amazon Resource Name (ARN) of the new dataset group.
CreateDatasetGroup
, createDatasetGroupResponse_domain
- The domain for the new Domain 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_domain :: Lens' CreateDatasetGroupResponse (Maybe Domain) Source #
The domain for the new Domain dataset group.
createDatasetGroupResponse_httpStatus :: Lens' CreateDatasetGroupResponse Int Source #
The response's http status code.