FinSpaceData / Client / get_data_view

get_data_view

FinSpaceData.Client.get_data_view(**kwargs)

Gets information about a Dataview.

See also: AWS API Documentation

Request Syntax

response = client.get_data_view(
    dataViewId='string',
    datasetId='string'
)

Parameters:

• dataViewId (string) –

  [REQUIRED]

  The unique identifier for the Dataview.

• datasetId (string) –

  [REQUIRED]

  The unique identifier for the Dataset used in the Dataview.

Return type:

dict

Returns:

Response Syntax

{
    'autoUpdate': True|False,
    'partitionColumns': [
        'string',
    ],
    'datasetId': 'string',
    'asOfTimestamp': 123,
    'errorInfo': {
        'errorMessage': 'string',
        'errorCategory': 'VALIDATION'|'SERVICE_QUOTA_EXCEEDED'|'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'THROTTLING'|'INTERNAL_SERVICE_EXCEPTION'|'CANCELLED'|'USER_RECOVERABLE'
    },
    'lastModifiedTime': 123,
    'createTime': 123,
    'sortColumns': [
        'string',
    ],
    'dataViewId': 'string',
    'dataViewArn': 'string',
    'destinationTypeParams': {
        'destinationType': 'string',
        's3DestinationExportFileFormat': 'PARQUET'|'DELIMITED_TEXT',
        's3DestinationExportFileFormatOptions': {
            'string': 'string'
        }
    },
    'status': 'RUNNING'|'STARTING'|'FAILED'|'CANCELLED'|'TIMEOUT'|'SUCCESS'|'PENDING'|'FAILED_CLEANUP_FAILED'
}

Response Structure

• (dict) – Response from retrieving a dataview, which includes details on the target database and table name

  • autoUpdate (boolean) –

    Flag to indicate Dataview should be updated automatically.

  • partitionColumns (list) –

    Ordered set of column names used to partition data.

    • (string) – 1 - 255 character String

  • datasetId (string) –

    The unique identifier for the Dataset used in the Dataview.

  • asOfTimestamp (integer) –

    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.

  • errorInfo (dict) –

    Information about an error that occurred for the Dataview.

    • errorMessage (string) –

      The text of the error message.

    • errorCategory (string) –

      The category of the error.

      • VALIDATION – The inputs to this request are invalid.

      • SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please contact AWS support to increase quotas.

      • ACCESS_DENIED – Missing required permission to perform this request.

      • RESOURCE_NOT_FOUND – One or more inputs to this request were not found.

      • THROTTLING – The system temporarily lacks sufficient resources to process the request.

      • INTERNAL_SERVICE_EXCEPTION – An internal service error has occurred.

      • CANCELLED – Cancelled.

      • USER_RECOVERABLE – A user recoverable error has occurred.

  • lastModifiedTime (integer) –

    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.

  • createTime (integer) –

    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.

  • sortColumns (list) –

    Columns to be used for sorting the data.

    • (string) – 1 - 255 character String

  • dataViewId (string) –

    The unique identifier for the Dataview.

  • dataViewArn (string) –

    The ARN identifier of the Dataview.

  • destinationTypeParams (dict) –

    Options that define the destination type for the Dataview.

    • destinationType (string) –

      Destination type for a Dataview.

      • GLUE_TABLE – Glue table destination type.

      • S3 – S3 destination type.

    • s3DestinationExportFileFormat (string) –

      Dataview export file format.

      • PARQUET – Parquet export file format.

      • DELIMITED_TEXT – Delimited text export file format.

    • s3DestinationExportFileFormatOptions (dict) –

      Format Options for S3 Destination type.

      Here is an example of how you could specify the s3DestinationExportFileFormatOptions

      { "header": "true", "delimiter": ",", "compression": "gzip" }

      • (string) –

        • (string) –

  • status (string) –

    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.

Exceptions

• FinSpaceData.Client.exceptions.ResourceNotFoundException

• FinSpaceData.Client.exceptions.InternalServerException

• FinSpaceData.Client.exceptions.ThrottlingException

• FinSpaceData.Client.exceptions.ValidationException

• FinSpaceData.Client.exceptions.ConflictException