Skip to content

GetDataViewResponse

Source code in docs_src/capo_finspace_data/types/get_data_view_response.py
class GetDataViewResponse(TypedDict, closed=True):
    auto_update: "capo_finspace_data.types.boolean.Boolean"
    """<p>Flag to indicate Dataview should be updated automatically.</p>"""
    partition_columns: NotRequired[
        "capo_finspace_data.types.partition_column_list.PartitionColumnList"
    ]
    """<p>Ordered set of column names used to partition data.</p>"""
    dataset_id: NotRequired["capo_finspace_data.types.dataset_id.DatasetId"]
    """<p>The unique identifier for the Dataset used in the Dataview.</p>"""
    as_of_timestamp: NotRequired[
        "capo_finspace_data.types.timestamp_epoch.TimestampEpoch"
    ]
    """<p>Time range to use for the Dataview. 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>"""
    error_info: NotRequired[
        "capo_finspace_data.types.data_view_error_info.DataViewErrorInfo"
    ]
    """<p>Information about an error that occurred for the Dataview.</p>"""
    last_modified_time: "capo_finspace_data.types.timestamp_epoch.TimestampEpoch"
    """<p>The last time that a Dataview 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>"""
    create_time: "capo_finspace_data.types.timestamp_epoch.TimestampEpoch"
    """<p>The timestamp at which the Dataview 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>"""
    sort_columns: NotRequired[
        "capo_finspace_data.types.sort_column_list.SortColumnList"
    ]
    """<p>Columns to be used for sorting the data.</p>"""
    data_view_id: NotRequired["capo_finspace_data.types.data_view_id.DataViewId"]
    """<p>The unique identifier for the Dataview.</p>"""
    data_view_arn: NotRequired["capo_finspace_data.types.data_view_arn.DataViewArn"]
    """<p>The ARN identifier of the Dataview.</p>"""
    destination_type_params: NotRequired[
        "capo_finspace_data.types.data_view_destination_type_params.DataViewDestinationTypeParams"
    ]
    """<p>Options that define the destination type for the Dataview.</p>"""
    status: NotRequired["capo_finspace_data.types.data_view_status.DataViewStatus"]
    """<p>The status of a Dataview creation.</p> <ul> <li> <p> <code>RUNNING</code> – Dataview creation is running.</p> </li> <li> <p> <code>STARTING</code> – Dataview creation is starting.</p> </li> <li> <p> <code>FAILED</code> – Dataview creation has failed.</p> </li> <li> <p> <code>CANCELLED</code> – Dataview creation has been cancelled.</p> </li> <li> <p> <code>TIMEOUT</code> – Dataview creation has timed out.</p> </li> <li> <p> <code>SUCCESS</code> – Dataview creation has succeeded.</p> </li> <li> <p> <code>PENDING</code> – Dataview creation is pending.</p> </li> <li> <p> <code>FAILED_CLEANUP_FAILED</code> – Dataview creation failed and resource cleanup failed.</p> </li> </ul>"""

as_of_timestamp instance-attribute

as_of_timestamp: NotRequired[TimestampEpoch]

Time range to use for the Dataview. 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.

auto_update instance-attribute

auto_update: Boolean

Flag to indicate Dataview should be updated automatically.

create_time instance-attribute

create_time: TimestampEpoch

The timestamp at which the Dataview 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.

data_view_arn instance-attribute

data_view_arn: NotRequired[DataViewArn]

The ARN identifier of the Dataview.

data_view_id instance-attribute

data_view_id: NotRequired[DataViewId]

The unique identifier for the Dataview.

dataset_id instance-attribute

dataset_id: NotRequired[DatasetId]

The unique identifier for the Dataset used in the Dataview.

destination_type_params instance-attribute

destination_type_params: NotRequired[DataViewDestinationTypeParams]

Options that define the destination type for the Dataview.

error_info instance-attribute

error_info: NotRequired[DataViewErrorInfo]

Information about an error that occurred for the Dataview.

last_modified_time instance-attribute

last_modified_time: TimestampEpoch

The last time that a Dataview 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.

partition_columns instance-attribute

partition_columns: NotRequired[PartitionColumnList]

Ordered set of column names used to partition data.

sort_columns instance-attribute

sort_columns: NotRequired[SortColumnList]

Columns to be used for sorting the data.

status instance-attribute

status: NotRequired[DataViewStatus]

The status of a Dataview creation.

  • RUNNING – Dataview creation is running.

  • STARTING – Dataview creation is starting.

  • FAILED – Dataview creation has failed.

  • CANCELLED – Dataview creation has been cancelled.

  • TIMEOUT – Dataview creation has timed out.

  • SUCCESS – Dataview creation has succeeded.

  • PENDING – Dataview creation is pending.

  • FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup failed.