update_dataset

FinSpaceData.Client.update_dataset(**kwargs)

Updates a FinSpace Dataset.

See also: AWS API Documentation

Request Syntax

response = client.update_dataset(
    clientToken='string',
    datasetId='string',
    datasetTitle='string',
    kind='TABULAR'|'NON_TABULAR',
    datasetDescription='string',
    alias='string',
    schemaDefinition={
        'tabularSchemaConfig': {
            'columns': [
                {
                    'dataType': 'STRING'|'CHAR'|'INTEGER'|'TINYINT'|'SMALLINT'|'BIGINT'|'FLOAT'|'DOUBLE'|'DATE'|'DATETIME'|'BOOLEAN'|'BINARY',
                    'columnName': 'string',
                    'columnDescription': 'string'
                },
            ],
            'primaryKeyColumns': [
                'string',
            ]
        }
    }
)

Parameters

• clientToken (string) --

  A token that ensures idempotency. This token expires in 10 minutes.

  This field is autopopulated if not provided.

• datasetId (string) --

  [REQUIRED]

  The unique identifier for the Dataset to update.

• datasetTitle (string) --

  [REQUIRED]

  A display title for the Dataset.

• kind (string) --

  [REQUIRED]

  The format in which the 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 for the Dataset.
• alias (string) -- The unique resource identifier for a Dataset.
• 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

Return type

dict

Returns

Response Syntax

{
    'datasetId': 'string'
}

Response Structure

• (dict) -- The response from an UpdateDataset operation

  • datasetId (string) --

    The unique identifier for updated Dataset.

Exceptions

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