Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetDataView

Gets information about a Dataview.

Request Syntax


GET /datasets/datasetId/dataviewsv2/dataviewId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

datasetId

The unique identifier for the Dataset used in the Dataview.

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

Required: Yes

dataviewId

The unique identifier for the Dataview.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "asOfTimestamp": number,
   "autoUpdate": boolean,
   "createTime": number,
   "datasetId": "string",
   "dataViewArn": "string",
   "dataViewId": "string",
   "destinationTypeParams": { 
      "destinationType": "string",
      "s3DestinationExportFileFormat": "string",
      "s3DestinationExportFileFormatOptions": { 
         "string" : "string" 
      }
   },
   "errorInfo": { 
      "errorCategory": "string",
      "errorMessage": "string"
   },
   "lastModifiedTime": number,
   "partitionColumns": [ "string" ],
   "sortColumns": [ "string" ],
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

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

autoUpdate

Flag to indicate Dataview should be updated automatically.

Type: Boolean

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

datasetId

The unique identifier for the Dataset used in the Dataview.

Type: String

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

dataViewArn

The ARN identifier of the Dataview.

Type: String

dataViewId

The unique identifier for the Dataview.

Type: String

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

destinationTypeParams

Options that define the destination type for the Dataview.

Type: DataViewDestinationTypeParams object

errorInfo

Information about an error that occurred for the Dataview.

Type: DataViewErrorInfo object

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

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]*

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]*

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

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

The request conflicts with an existing resource.

HTTP Status Code: 409

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400