get_dataset

get_dataset(**kwargs)

Returns information about a Dataset.

See also: AWS API Documentation

Request Syntax

response = client.get_dataset(
    datasetId='string'
)

Parameters

datasetId (string) --

[REQUIRED]

The unique identifier for a Dataset.

Return type

dict

Returns

Response Syntax

{
    'datasetId': 'string',
    'datasetArn': 'string',
    'datasetTitle': 'string',
    'kind': 'TABULAR'|'NON_TABULAR',
    'datasetDescription': 'string',
    'createTime': 123,
    'lastModifiedTime': 123,
    'schemaDefinition': {
        'tabularSchemaConfig': {
            'columns': [
                {
                    'dataType': 'STRING'|'CHAR'|'INTEGER'|'TINYINT'|'SMALLINT'|'BIGINT'|'FLOAT'|'DOUBLE'|'DATE'|'DATETIME'|'BOOLEAN'|'BINARY',
                    'columnName': 'string',
                    'columnDescription': 'string'
                },
            ],
            'primaryKeyColumns': [
                'string',
            ]
        }
    },
    'alias': 'string',
    'status': 'PENDING'|'FAILED'|'SUCCESS'|'RUNNING'
}

Response Structure

• (dict) -- Response for the GetDataset operation
  • datasetId (string) --

    The unique identifier for a Dataset.

  • datasetArn (string) --

    The ARN identifier of the Dataset.

  • datasetTitle (string) --

    Display title for a Dataset.

  • kind (string) --

    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.
  • datasetDescription (string) --

    A description of the Dataset.

  • createTime (integer) --

    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.

  • lastModifiedTime (integer) --

    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.

  • schemaDefinition (dict) --

    Definition for a schema on a tabular Dataset.

    • tabularSchemaConfig (dict) --

      The configuration for a schema on a tabular Dataset.

      • columns (list) --

        List of column definitions.

        • (dict) --

          The definition of a column in a tabular Dataset.

          • dataType (string) --

            Data type of a column.

            • STRING – A String data type. CHAR – A char data type. INTEGER – An integer data type. TINYINT – A tinyint data type. SMALLINT – A smallint data type. BIGINT – A bigint data type. FLOAT – A float data type. DOUBLE – A double data type. DATE – A date data type. DATETIME – A datetime data type. BOOLEAN – A boolean data type. BINARY – A binary data type.
          • columnName (string) --

            The name of a column.

          • columnDescription (string) --

            Description for a column.

      • primaryKeyColumns (list) --

        List of column names used for primary key.

        • (string) -- Column Name
  • alias (string) --

    The unique resource identifier for a Dataset.

  • status (string) --

    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.

Exceptions

• FinSpaceData.Client.exceptions.InternalServerException
• FinSpaceData.Client.exceptions.ValidationException
• FinSpaceData.Client.exceptions.ThrottlingException
• FinSpaceData.Client.exceptions.AccessDeniedException
• FinSpaceData.Client.exceptions.ResourceNotFoundException
• FinSpaceData.Client.exceptions.ConflictException