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.Personalize.CreateDatasetGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- domain :: Maybe Domain
- kmsKeyArn :: Maybe Text
- roleArn :: Maybe Text
- tags :: Maybe [Tag]
- name :: Text
}
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.

Constructors

CreateDatasetGroup'

Fields

domain :: Maybe 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.
kmsKeyArn :: Maybe Text
The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.
roleArn :: Maybe Text
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.
tags :: Maybe [Tag]
A list of tags to apply to the dataset group.
name :: Text
The name for the new dataset group.

Instances

Instances details

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

newCreateDatasetGroup Source #

Arguments

:: Text	`CreateDatasetGroup`
-> 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:

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.

Constructors

CreateDatasetGroupResponse'
Fields datasetGroupArn :: Maybe Text The Amazon Resource Name (ARN) of the new dataset group. domain :: Maybe Domain The domain for the new Domain dataset group. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateDatasetGroupResponse Source #

Arguments

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

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.