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
KxDataviewListEntry
A collection of kdb dataview entries.
Contents
Note
In the following list, the required parameters are described first.
- activeVersions
-
The active changeset versions for the given dataview entry.
Type: Array of KxDataviewActiveVersion objects
Required: No
- autoUpdate
-
The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. The default value is false.
Type: Boolean
Required: No
- availabilityZoneId
-
The identifier of the availability zones.
Type: String
Length Constraints: Minimum length of 8. Maximum length of 12.
Pattern:
^[a-zA-Z0-9-]+$Required: No
- azMode
-
The number of availability zones you want to assign per volume. Currently, FinSpace only supports
SINGLEfor volumes. This places dataview in a single AZ.Type: String
Valid Values:
SINGLE | MULTIRequired: No
- changesetId
-
A unique identifier for the changeset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Pattern:
^[a-zA-Z0-9]+$Required: No
- createdTimestamp
-
The timestamp at which the dataview list entry 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: Timestamp
Required: No
- databaseName
-
A unique identifier of the database.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$Required: No
- dataviewName
-
A unique identifier of the dataview.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$Required: No
- description
-
A description for the dataview list entry.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
^[a-zA-Z0-9. ]{1,1000}$Required: No
- environmentId
-
A unique identifier for the kdb environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
.*\S.*Required: No
- lastModifiedTimestamp
-
The last time that the dataview list was updated 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: Timestamp
Required: No
- readWrite
-
Returns True if the dataview is created as writeable and False otherwise.
Type: Boolean
Required: No
- segmentConfigurations
-
The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
Type: Array of KxDataviewSegmentConfiguration objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
- status
-
The status of a given dataview entry.
Type: String
Valid Values:
CREATING | ACTIVE | UPDATING | FAILED | DELETINGRequired: No
- statusReason
-
The error message when a failed state occurs.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 250.
Pattern:
^[a-zA-Z0-9\_\-\.\s]+$Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
