Struct aws_sdk_personalize::client::fluent_builders::CreateDatasetGroup

pub struct CreateDatasetGroup { /* private fields */ }

Fluent builder constructing a request to CreateDatasetGroup.

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

• CreateDataset

• CreateEventTracker

• CreateSolution

Related APIs

• ListDatasetGroups

• DescribeDatasetGroup

• DeleteDatasetGroup

Implementations

impl CreateDatasetGroup

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateDatasetGroup, AwsResponseRetryClassifier>, SdkError<CreateDatasetGroupError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CreateDatasetGroupOutput, SdkError<CreateDatasetGroupError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn name(self, input: impl Into<String>) -> Self

The name for the new dataset group.

pub fn set_name(self, input: Option<String>) -> Self

The name for the new dataset group.

pub fn role_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_role_arn(self, input: Option<String>) -> Self

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.

pub fn kms_key_arn(self, input: impl Into<String>) -> Self

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

pub fn set_kms_key_arn(self, input: Option<String>) -> Self

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

pub fn domain(self, input: Domain) -> Self

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.

pub fn set_domain(self, input: Option<Domain>) -> Self

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.

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

A list of tags to apply to the dataset group.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

A list of tags to apply to the dataset group.

Trait Implementations

impl Clone for CreateDatasetGroup

fn clone(&self) -> CreateDatasetGroup

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateDatasetGroup

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.