Skip to content

DatasetGroup

Source code in docs_src/capo_personalize/types/dataset_group.py
class DatasetGroup(TypedDict, closed=True):
    name: NotRequired["capo_personalize.types.name.Name"]
    """<p>The name of the dataset group.</p>"""
    dataset_group_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the dataset group.</p>"""
    status: NotRequired["capo_personalize.types.status.Status"]
    """<p>The current status of the dataset group.</p> <p>A dataset group can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING</p> </li> </ul>"""
    role_arn: NotRequired["capo_personalize.types.role_arn.RoleArn"]
    """<p>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.</p>"""
    kms_key_arn: NotRequired["capo_personalize.types.kms_key_arn.KmsKeyArn"]
    """<p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.</p>"""
    creation_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>The creation date and time (in Unix time) of the dataset group.</p>"""
    last_updated_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>The last update date and time (in Unix time) of the dataset group.</p>"""
    failure_reason: NotRequired["capo_personalize.types.failure_reason.FailureReason"]
    """<p>If creating a dataset group fails, provides the reason why.</p>"""
    domain: NotRequired["capo_personalize.types.domain.Domain"]
    """<p>The domain of a Domain dataset group.</p>"""

creation_date_time instance-attribute

creation_date_time: NotRequired[Date]

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

dataset_group_arn instance-attribute

dataset_group_arn: NotRequired[Arn]

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

domain instance-attribute

domain: NotRequired[Domain]

The domain of a Domain dataset group.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

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

kms_key_arn instance-attribute

kms_key_arn: NotRequired[KmsKeyArn]

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

last_updated_date_time instance-attribute

last_updated_date_time: NotRequired[Date]

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

name instance-attribute

name: NotRequired[Name]

The name of the dataset group.

role_arn instance-attribute

role_arn: NotRequired[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.

status instance-attribute

status: NotRequired[Status]

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