Skip to content

GetDatasetResponse

Source code in docs_src/capo_finspace_data/types/get_dataset_response.py
class GetDatasetResponse(TypedDict, closed=True):
    dataset_id: NotRequired["capo_finspace_data.types.dataset_id.DatasetId"]
    """<p>The unique identifier for a Dataset.</p>"""
    dataset_arn: NotRequired["capo_finspace_data.types.dataset_arn.DatasetArn"]
    """<p>The ARN identifier of the Dataset.</p>"""
    dataset_title: NotRequired["capo_finspace_data.types.dataset_title.DatasetTitle"]
    """<p>Display title for a Dataset.</p>"""
    kind: NotRequired["capo_finspace_data.types.dataset_kind.DatasetKind"]
    """<p>The format in which Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> – Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p> </li> </ul>"""
    dataset_description: NotRequired[
        "capo_finspace_data.types.dataset_description.DatasetDescription"
    ]
    """<p>A description of the Dataset.</p>"""
    create_time: "capo_finspace_data.types.timestamp_epoch.TimestampEpoch"
    """<p>The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"""
    last_modified_time: "capo_finspace_data.types.timestamp_epoch.TimestampEpoch"
    """<p>The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>"""
    schema_definition: NotRequired["capo_finspace_data.types.schema_union.SchemaUnion"]
    """<p>Definition for a schema on a tabular Dataset.</p>"""
    alias: NotRequired["capo_finspace_data.types.alias_string.AliasString"]
    """<p>The unique resource identifier for a Dataset.</p>"""
    status: NotRequired["capo_finspace_data.types.dataset_status.DatasetStatus"]
    """<p>Status of the Dataset creation.</p> <ul> <li> <p> <code>PENDING</code> – Dataset is pending creation.</p> </li> <li> <p> <code>FAILED</code> – Dataset creation has failed.</p> </li> <li> <p> <code>SUCCESS</code> – Dataset creation has succeeded.</p> </li> <li> <p> <code>RUNNING</code> – Dataset creation is running.</p> </li> </ul>"""

alias instance-attribute

alias: NotRequired[AliasString]

The unique resource identifier for a Dataset.

create_time instance-attribute

create_time: TimestampEpoch

The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

dataset_arn instance-attribute

dataset_arn: NotRequired[DatasetArn]

The ARN identifier of the Dataset.

dataset_description instance-attribute

dataset_description: NotRequired[DatasetDescription]

A description of the Dataset.

dataset_id instance-attribute

dataset_id: NotRequired[DatasetId]

The unique identifier for a Dataset.

dataset_title instance-attribute

dataset_title: NotRequired[DatasetTitle]

Display title for a Dataset.

kind instance-attribute

kind: NotRequired[DatasetKind]

The format in which Dataset data is structured.

  • TABULAR – Data is structured in a tabular format.

  • NON_TABULAR – Data is structured in a non-tabular format.

last_modified_time instance-attribute

last_modified_time: TimestampEpoch

The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

schema_definition instance-attribute

schema_definition: NotRequired[SchemaUnion]

Definition for a schema on a tabular Dataset.

status instance-attribute

status: NotRequired[DatasetStatus]

Status of the Dataset creation.

  • PENDING – Dataset is pending creation.

  • FAILED – Dataset creation has failed.

  • SUCCESS – Dataset creation has succeeded.

  • RUNNING – Dataset creation is running.