Class: Aws::Personalize::Types::DatasetGroup

Inherits:

Struct

• Object
• Struct
• Aws::Personalize::Types::DatasetGroup

Includes:

Structure

Defined in:

lib/aws-sdk-personalize/types.rb

Overview

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 AWS Key Management Service (KMS) key to encrypt the datasets in the group.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_date_time ⇒ Time

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

• #dataset_group_arn ⇒ String

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

• #failure_reason ⇒ String

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

• #kms_key_arn ⇒ String

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

• #last_updated_date_time ⇒ Time

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

• #name ⇒ String

  The name of the dataset group.

• #role_arn ⇒ String

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

• #status ⇒ String

  The current status of the dataset group.

Instance Attribute Details

#creation_date_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-personalize/types.rb', line 1386

class DatasetGroup < Struct.new(
  :name,
  :dataset_group_arn,
  :status,
  :role_arn,
  :kms_key_arn,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_group_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-personalize/types.rb', line 1386

class DatasetGroup < Struct.new(
  :name,
  :dataset_group_arn,
  :status,
  :role_arn,
  :kms_key_arn,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-personalize/types.rb', line 1386

class DatasetGroup < Struct.new(
  :name,
  :dataset_group_arn,
  :status,
  :role_arn,
  :kms_key_arn,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-personalize/types.rb', line 1386

class DatasetGroup < Struct.new(
  :name,
  :dataset_group_arn,
  :status,
  :role_arn,
  :kms_key_arn,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_date_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-personalize/types.rb', line 1386

class DatasetGroup < Struct.new(
  :name,
  :dataset_group_arn,
  :status,
  :role_arn,
  :kms_key_arn,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the dataset group.

Returns:

• (String)

# File 'lib/aws-sdk-personalize/types.rb', line 1386

class DatasetGroup < Struct.new(
  :name,
  :dataset_group_arn,
  :status,
  :role_arn,
  :kms_key_arn,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-personalize/types.rb', line 1386

class DatasetGroup < Struct.new(
  :name,
  :dataset_group_arn,
  :status,
  :role_arn,
  :kms_key_arn,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-personalize/types.rb', line 1386

class DatasetGroup < Struct.new(
  :name,
  :dataset_group_arn,
  :status,
  :role_arn,
  :kms_key_arn,
  :creation_date_time,
  :last_updated_date_time,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end