DataViewSummary - Amazon FinSpace

Amazon FinSpace Dataset Browser will be discontinued on November 29, 2024. Starting November 29, 2023, FinSpace will no longer accept the creation of new Dataset Browser environments. Customers using Amazon FinSpace with Managed Kdb Insights will not be affected. For more information, review the FAQ or contact AWS Support to assist with your transition.

DataViewSummary

Structure for the summary of a Dataview.

Contents

Note

In the following list, the required parameters are described first.

asOfTimestamp

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.

Type: Long

Required: No

autoUpdate

The flag to indicate Dataview should be updated automatically.

Type: Boolean

Required: No

createTime

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.

Type: Long

Required: No

datasetId

Th unique identifier for the Dataview Dataset.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 26.

Required: No

dataViewArn

The ARN identifier of the Dataview.

Type: String

Required: No

dataViewId

The unique identifier for the Dataview.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 26.

Required: No

destinationTypeProperties

Information about the Dataview destination.

Type: DataViewDestinationTypeParams object

Required: No

errorInfo

The structure with error messages.

Type: DataViewErrorInfo object

Required: No

lastModifiedTime

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.

Type: Long

Required: No

partitionColumns

Ordered set of column names used to partition data.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\s\S]*\S[\s\S]*

Required: No

sortColumns

Columns to be used for sorting the data.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\s\S]*\S[\s\S]*

Required: No

status

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.

Type: String

Valid Values: RUNNING | STARTING | FAILED | CANCELLED | TIMEOUT | SUCCESS | PENDING | FAILED_CLEANUP_FAILED

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: