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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb

Overview

A dataset group is a collection of related datasets (Item interactions, Users, Items, Actions, Action interactions). 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 Key Management Service (KMS) key to encrypt the datasets in the group.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_date_timeTime

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

Returns:

  • (Time)


2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2292

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

#dataset_group_arnString

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

Returns:

  • (String)


2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2292

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

#domainString

The domain of a Domain dataset group.

Returns:

  • (String)


2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2292

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

#failure_reasonString

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

Returns:

  • (String)


2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2292

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

#kms_key_arnString

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

Returns:

  • (String)


2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2292

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

#last_updated_date_timeTime

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

Returns:

  • (Time)


2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2292

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

#nameString

The name of the dataset group.

Returns:

  • (String)


2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2292

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

#role_arnString

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.

Returns:

  • (String)


2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2292

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

#statusString

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)


2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 2292

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