list_datasets

FinSpaceData.Client.list_datasets(**kwargs)

Lists all of the active Datasets that a user has access to.

See also: AWS API Documentation

Request Syntax

response = client.list_datasets(
    nextToken='string',
    maxResults=123
)

Parameters

• nextToken (string) -- A token that indicates where a results page should begin.
• maxResults (integer) -- The maximum number of results per page.

Return type

dict

Returns

Response Syntax

{
    'datasets': [
        {
            'datasetId': 'string',
            'datasetArn': 'string',
            'datasetTitle': 'string',
            'kind': 'TABULAR'|'NON_TABULAR',
            'datasetDescription': 'string',
            'ownerInfo': {
                'name': 'string',
                'phoneNumber': 'string',
                'email': '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'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) -- Response for the ListDatasets operation

  • datasets (list) --

    List of Datasets.

    • (dict) --

      The structure for a Dataset.

      • datasetId (string) --

        An 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) --

        Description for a Dataset.

      • ownerInfo (dict) --

        Contact information for a Dataset owner.

        • name (string) --

          The name of the Dataset owner.

        • phoneNumber (string) --

          Phone number for the Dataset owner.

        • email (string) --

          Email address for the Dataset owner.

      • 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.

  • nextToken (string) --

    A token that indicates where a results page should begin.

Exceptions

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