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

GetDataset

Returns information about a Dataset.

Request Syntax


GET /datasetsv2/datasetId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

datasetId

The unique identifier for a Dataset.

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "alias": "string",
   "createTime": number,
   "datasetArn": "string",
   "datasetDescription": "string",
   "datasetId": "string",
   "datasetTitle": "string",
   "kind": "string",
   "lastModifiedTime": number,
   "schemaDefinition": { 
      "tabularSchemaConfig": { 
         "columns": [ 
            { 
               "columnDescription": "string",
               "columnName": "string",
               "dataType": "string"
            }
         ],
         "primaryKeyColumns": [ "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.

alias

The unique resource identifier for a Dataset.

Type: String

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

Pattern: ^alias\/\S+

createTime

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.

Type: Long

datasetArn

The ARN identifier of the Dataset.

Type: String

datasetDescription

A description of the Dataset.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: [\s\S]*

datasetId

The unique identifier for a Dataset.

Type: String

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

datasetTitle

Display title for a Dataset.

Type: String

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

Pattern: .*\S.*

kind

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.

Type: String

Valid Values: TABULAR | NON_TABULAR

lastModifiedTime

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.

Type: Long

schemaDefinition

Definition for a schema on a tabular Dataset.

Type: SchemaUnion object

status

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.

Type: String

Valid Values: PENDING | FAILED | SUCCESS | RUNNING

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

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