Skip to content

Dataset

Source code in docs_src/capo_personalize/types/dataset.py
class Dataset(TypedDict, closed=True):
    name: NotRequired["capo_personalize.types.name.Name"]
    """<p>The name of the dataset.</p>"""
    dataset_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the dataset that you want metadata for.</p>"""
    dataset_group_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the dataset group.</p>"""
    dataset_type: NotRequired["capo_personalize.types.dataset_type.DatasetType"]
    """<p>One of the following values:</p> <ul> <li> <p>Interactions</p> </li> <li> <p>Items</p> </li> <li> <p>Users</p> </li> <li> <p>Actions</p> </li> <li> <p>Action_Interactions</p> </li> </ul>"""
    schema_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The ARN of the associated schema.</p>"""
    status: NotRequired["capo_personalize.types.status.Status"]
    """<p>The status of the dataset.</p> <p>A dataset 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 > DELETE IN_PROGRESS</p> </li> </ul>"""
    creation_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>The creation date and time (in Unix time) of the dataset.</p>"""
    last_updated_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>A time stamp that shows when the dataset was updated.</p>"""
    latest_dataset_update: NotRequired[
        "capo_personalize.types.dataset_update_summary.DatasetUpdateSummary"
    ]
    """<p>Describes the latest update to the dataset.</p>"""
    tracking_id: NotRequired["capo_personalize.types.tracking_id.TrackingId"]
    """<p>The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the <code>PutActionInteractions</code> API operation. Amazon Personalize uses it to direct new data to the Action interactions dataset in your dataset group.</p>"""

creation_date_time instance-attribute

creation_date_time: NotRequired[Date]

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

dataset_arn instance-attribute

dataset_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the dataset that you want metadata for.

dataset_group_arn instance-attribute

dataset_group_arn: NotRequired[Arn]

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

dataset_type instance-attribute

dataset_type: NotRequired[DatasetType]

One of the following values:

  • Interactions

  • Items

  • Users

  • Actions

  • Action_Interactions

last_updated_date_time instance-attribute

last_updated_date_time: NotRequired[Date]

A time stamp that shows when the dataset was updated.

latest_dataset_update instance-attribute

latest_dataset_update: NotRequired[DatasetUpdateSummary]

Describes the latest update to the dataset.

name instance-attribute

name: NotRequired[Name]

The name of the dataset.

schema_arn instance-attribute

schema_arn: NotRequired[Arn]

The ARN of the associated schema.

status instance-attribute

status: NotRequired[Status]

The status of the dataset.

A dataset can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

tracking_id instance-attribute

tracking_id: NotRequired[TrackingId]

The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the PutActionInteractions API operation. Amazon Personalize uses it to direct new data to the Action interactions dataset in your dataset group.