FinSpaceData

Client

class FinSpaceData.Client

A low-level client representing FinSpace Public API (FinSpace Data)

The FinSpace APIs let you take actions inside the FinSpace.

client = session.create_client('finspace-data')

These are the available methods:

associate_user_to_permission_group(**kwargs)

Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.

See also: AWS API Documentation

Request Syntax

response = client.associate_user_to_permission_group(
    permissionGroupId='string',
    userId='string',
    clientToken='string'
)
Parameters
  • permissionGroupId (string) --

    [REQUIRED]

    The unique identifier for the permission group.

  • userId (string) --

    [REQUIRED]

    The unique identifier for the user.

  • clientToken (string) --

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'statusCode': 123
}

Response Structure

  • (dict) --

    • statusCode (integer) --

      The returned status code of the response.

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

create_changeset(**kwargs)

Creates a new Changeset in a FinSpace Dataset.

See also: AWS API Documentation

Request Syntax

response = client.create_changeset(
    clientToken='string',
    datasetId='string',
    changeType='REPLACE'|'APPEND'|'MODIFY',
    sourceParams={
        'string': 'string'
    },
    formatParams={
        'string': '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 FinSpace Dataset where the Changeset will be created.

  • changeType (string) --

    [REQUIRED]

    The option to indicate how a Changeset will be applied to a Dataset.

    • REPLACE – Changeset will be considered as a replacement to all prior loaded Changesets.
    • APPEND – Changeset will be considered as an addition to the end of all prior loaded Changesets.
    • MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.
  • sourceParams (dict) --

    [REQUIRED]

    Options that define the location of the data being ingested (s3SourcePath ) and the source of the changeset (sourceType ).

    Both s3SourcePath and sourceType are required attributes.

    Here is an example of how you could specify the sourceParams :

    "sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", "sourceType": "S3" }

    The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace API section.

    • (string) --
      • (string) --
  • formatParams (dict) --

    [REQUIRED]

    Options that define the structure of the source file(s) including the format type (formatType ), header row (withHeader ), data separation character (separator ) and the type of compression (compression ).

    formatType is a required attribute and can have the following values:
    • PARQUET – Parquet source file format.
    • CSV – CSV source file format.
    • JSON – JSON source file format.
    • XML – XML source file format.

    Here is an example of how you could specify the formatParams :

    "formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" }

    Note that if you only provide formatType as CSV , the rest of the attributes will automatically default to CSV values as following:

    { "withHeader": "true", "separator": "," }

    For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'datasetId': 'string',
    'changesetId': 'string'
}

Response Structure

  • (dict) -- The response from a CreateChangeset operation.

    • datasetId (string) --

      The unique identifier for the FinSpace Dataset where the Changeset is created.

    • changesetId (string) --

      The unique identifier of the Changeset that is created.

Exceptions

create_data_view(**kwargs)

Creates a Dataview for a Dataset.

See also: AWS API Documentation

Request Syntax

response = client.create_data_view(
    clientToken='string',
    datasetId='string',
    autoUpdate=True|False,
    sortColumns=[
        'string',
    ],
    partitionColumns=[
        'string',
    ],
    asOfTimestamp=123,
    destinationTypeParams={
        'destinationType': 'string',
        's3DestinationExportFileFormat': 'PARQUET'|'DELIMITED_TEXT',
        's3DestinationExportFileFormatOptions': {
            'string': '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 Dataset identifier that is used to create a Dataview.

  • autoUpdate (boolean) -- Flag to indicate Dataview should be updated automatically.
  • sortColumns (list) --

    Columns to be used for sorting the data.

    • (string) -- 1 - 255 character String
  • partitionColumns (list) --

    Ordered set of column names used to partition data.

    • (string) -- 1 - 255 character String
  • asOfTimestamp (integer) -- Beginning time 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.
  • destinationTypeParams (dict) --

    [REQUIRED]

    Options that define the destination type for the Dataview.

    • destinationType (string) -- [REQUIRED]

      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) --
Return type

dict

Returns

Response Syntax

{
    'datasetId': 'string',
    'dataViewId': 'string'
}

Response Structure

  • (dict) -- Response for creating a data view.

    • datasetId (string) --

      The unique identifier of the Dataset used for the Dataview.

    • dataViewId (string) --

      The unique identifier for the created Dataview.

Exceptions

create_dataset(**kwargs)

Creates a new FinSpace Dataset.

See also: AWS API Documentation

Request Syntax

response = client.create_dataset(
    clientToken='string',
    datasetTitle='string',
    kind='TABULAR'|'NON_TABULAR',
    datasetDescription='string',
    ownerInfo={
        'name': 'string',
        'phoneNumber': 'string',
        'email': 'string'
    },
    permissionGroupParams={
        'permissionGroupId': 'string',
        'datasetPermissions': [
            {
                'permission': '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.

  • datasetTitle (string) --

    [REQUIRED]

    Display title for a FinSpace Dataset.

  • kind (string) --

    [REQUIRED]

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

  • permissionGroupParams (dict) --

    [REQUIRED]

    Permission group parameters for Dataset permissions.

    • permissionGroupId (string) --

      The unique identifier for the PermissionGroup .

    • datasetPermissions (list) --

      List of resource permissions.

      • (dict) --

        Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.

        The following is a list of valid dataset permissions that you can apply:

        • ViewDatasetDetails
        • ReadDatasetDetails
        • AddDatasetData
        • CreateDataView
        • EditDatasetMetadata
        • DeleteDataset

        For more information on the dataset permissions, see Supported Dataset Permissions in the FinSpace User Guide.

        • permission (string) --

          Permission for a resource.

  • 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 a CreateDataset operation

    • datasetId (string) --

      The unique identifier for the created Dataset.

Exceptions

create_permission_group(**kwargs)

Creates a group of permissions for various actions that a user can perform in FinSpace.

See also: AWS API Documentation

Request Syntax

response = client.create_permission_group(
    name='string',
    description='string',
    applicationPermissions=[
        'CreateDataset'|'ManageClusters'|'ManageUsersAndGroups'|'ManageAttributeSets'|'ViewAuditData'|'AccessNotebooks'|'GetTemporaryCredentials',
    ],
    clientToken='string'
)
Parameters
  • name (string) --

    [REQUIRED]

    The name of the permission group.

  • description (string) -- A brief description for the permission group.
  • applicationPermissions (list) --

    [REQUIRED]

    The option to indicate FinSpace application permissions that are granted to a specific group.

    Warning

    When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.

    • CreateDataset – Group members can create new datasets.
    • ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
    • ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.
    • ManageAttributeSets – Group members can manage attribute sets.
    • ViewAuditData – Group members can view audit data.
    • AccessNotebooks – Group members will have access to FinSpace notebooks.
    • GetTemporaryCredentials – Group members can get temporary API credentials.
    • (string) --
  • clientToken (string) --

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'permissionGroupId': 'string'
}

Response Structure

  • (dict) --

    • permissionGroupId (string) --

      The unique identifier for the permission group.

Exceptions

create_user(**kwargs)

Creates a new user in FinSpace.

See also: AWS API Documentation

Request Syntax

response = client.create_user(
    emailAddress='string',
    type='SUPER_USER'|'APP_USER',
    firstName='string',
    lastName='string',
    ApiAccess='ENABLED'|'DISABLED',
    apiAccessPrincipalArn='string',
    clientToken='string'
)
Parameters
  • emailAddress (string) --

    [REQUIRED]

    The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.

  • type (string) --

    [REQUIRED]

    The option to indicate the type of user. Use one of the following options to specify this parameter:

    • SUPER_USER – A user with permission to all the functionality and data in FinSpace.
    • APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
  • firstName (string) -- The first name of the user that you want to register.
  • lastName (string) -- The last name of the user that you want to register.
  • ApiAccess (string) --

    The option to indicate whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

    • ENABLED – The user has permissions to use the APIs.
    • DISABLED – The user does not have permissions to use any APIs.
  • apiAccessPrincipalArn (string) -- The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.
  • clientToken (string) --

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'userId': 'string'
}

Response Structure

  • (dict) --

    • userId (string) --

      The unique identifier for the user.

Exceptions

delete_dataset(**kwargs)

Deletes a FinSpace Dataset.

See also: AWS API Documentation

Request Syntax

response = client.delete_dataset(
    clientToken='string',
    datasetId='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 of the Dataset to be deleted.

Return type

dict

Returns

Response Syntax

{
    'datasetId': 'string'
}

Response Structure

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

    • datasetId (string) --

      The unique identifier for the deleted Dataset.

Exceptions

delete_permission_group(**kwargs)

Deletes a permission group. This action is irreversible.

See also: AWS API Documentation

Request Syntax

response = client.delete_permission_group(
    permissionGroupId='string',
    clientToken='string'
)
Parameters
  • permissionGroupId (string) --

    [REQUIRED]

    The unique identifier for the permission group that you want to delete.

  • clientToken (string) --

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'permissionGroupId': 'string'
}

Response Structure

  • (dict) --

    • permissionGroupId (string) --

      The unique identifier for the deleted permission group.

Exceptions

disable_user(**kwargs)

Denies access to the FinSpace web application and API for the specified user.

See also: AWS API Documentation

Request Syntax

response = client.disable_user(
    userId='string',
    clientToken='string'
)
Parameters
  • userId (string) --

    [REQUIRED]

    The unique identifier for the user account that you want to disable.

  • clientToken (string) --

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'userId': 'string'
}

Response Structure

  • (dict) --

    • userId (string) --

      The unique identifier for the disabled user account.

Exceptions

disassociate_user_from_permission_group(**kwargs)

Removes a user account from a permission group.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_user_from_permission_group(
    permissionGroupId='string',
    userId='string',
    clientToken='string'
)
Parameters
  • permissionGroupId (string) --

    [REQUIRED]

    The unique identifier for the permission group.

  • userId (string) --

    [REQUIRED]

    The unique identifier for the user.

  • clientToken (string) --

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'statusCode': 123
}

Response Structure

  • (dict) --

    • statusCode (integer) --

      The returned status code of the response.

Exceptions

enable_user(**kwargs)

Allows the specified user to access the FinSpace web application and API.

See also: AWS API Documentation

Request Syntax

response = client.enable_user(
    userId='string',
    clientToken='string'
)
Parameters
  • userId (string) --

    [REQUIRED]

    The unique identifier for the user account that you want to enable.

  • clientToken (string) --

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'userId': 'string'
}

Response Structure

  • (dict) --

    • userId (string) --

      The unique identifier for the enabled user account.

Exceptions

get_changeset(**kwargs)

Get information about a Changeset.

See also: AWS API Documentation

Request Syntax

response = client.get_changeset(
    datasetId='string',
    changesetId='string'
)
Parameters
  • datasetId (string) --

    [REQUIRED]

    The unique identifier for the FinSpace Dataset where the Changeset is created.

  • changesetId (string) --

    [REQUIRED]

    The unique identifier of the Changeset for which to get data.

Return type

dict

Returns

Response Syntax

{
    'changesetId': 'string',
    'changesetArn': 'string',
    'datasetId': 'string',
    'changeType': 'REPLACE'|'APPEND'|'MODIFY',
    'sourceParams': {
        'string': 'string'
    },
    'formatParams': {
        'string': 'string'
    },
    'createTime': 123,
    'status': 'PENDING'|'FAILED'|'SUCCESS'|'RUNNING'|'STOP_REQUESTED',
    'errorInfo': {
        'errorMessage': 'string',
        'errorCategory': 'VALIDATION'|'SERVICE_QUOTA_EXCEEDED'|'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'THROTTLING'|'INTERNAL_SERVICE_EXCEPTION'|'CANCELLED'|'USER_RECOVERABLE'
    },
    'activeUntilTimestamp': 123,
    'activeFromTimestamp': 123,
    'updatesChangesetId': 'string',
    'updatedByChangesetId': 'string'
}

Response Structure

  • (dict) -- The response from a describe changeset operation

    • changesetId (string) --

      The unique identifier for a Changeset.

    • changesetArn (string) --

      The ARN identifier of the Changeset.

    • datasetId (string) --

      The unique identifier for the FinSpace Dataset where the Changeset is created.

    • changeType (string) --

      Type that indicates how a Changeset is applied to a Dataset.

      • REPLACE – Changeset is considered as a replacement to all prior loaded Changesets.
      • APPEND – Changeset is considered as an addition to the end of all prior loaded Changesets.
      • MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.
    • sourceParams (dict) --

      Options that define the location of the data being ingested.

      • (string) --
        • (string) --
    • formatParams (dict) --

      Structure of the source file(s).

      • (string) --
        • (string) --
    • createTime (integer) --

      The timestamp at which the Changeset 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.

    • status (string) --

      The status of Changeset creation operation.

    • errorInfo (dict) --

      The structure with error messages.

      • 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.
    • activeUntilTimestamp (integer) --

      Time until which the Changeset is active. 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.

    • activeFromTimestamp (integer) --

      Beginning time from which the Changeset is active. 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.

    • updatesChangesetId (string) --

      The unique identifier of the Changeset that is being updated.

    • updatedByChangesetId (string) --

      The unique identifier of the updated Changeset.

Exceptions

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

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

get_external_data_view_access_details(**kwargs)

Returns the credentials to access the external Dataview from an S3 location. To call this API:

  • You must retrieve the programmatic credentials.
  • You must be a member of a FinSpace user group, where the dataset that you want to access has Read Dataset Data permissions.

See also: AWS API Documentation

Request Syntax

response = client.get_external_data_view_access_details(
    dataViewId='string',
    datasetId='string'
)
Parameters
  • dataViewId (string) --

    [REQUIRED]

    The unique identifier for the Dataview that you want to access.

  • datasetId (string) --

    [REQUIRED]

    The unique identifier for the Dataset.

Return type

dict

Returns

Response Syntax

{
    'credentials': {
        'accessKeyId': 'string',
        'secretAccessKey': 'string',
        'sessionToken': 'string',
        'expiration': 123
    },
    's3Location': {
        'bucket': 'string',
        'key': 'string'
    }
}

Response Structure

  • (dict) --

    • credentials (dict) --

      The credentials required to access the external Dataview from the S3 location.

      • accessKeyId (string) --

        The unique identifier for the security credentials.

      • secretAccessKey (string) --

        The secret access key that can be used to sign requests.

      • sessionToken (string) --

        The token that users must pass to use the credentials.

      • expiration (integer) --

        The Epoch time when the current credentials expire.

    • s3Location (dict) --

      The location where the external Dataview is stored.

      • bucket (string) --

        The name of the S3 bucket.

      • key (string) --

        The path of the folder, within the S3 bucket that contains the Dataset.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_permission_group(**kwargs)

Retrieves the details of a specific permission group.

See also: AWS API Documentation

Request Syntax

response = client.get_permission_group(
    permissionGroupId='string'
)
Parameters
permissionGroupId (string) --

[REQUIRED]

The unique identifier for the permission group.

Return type
dict
Returns
Response Syntax
{
    'permissionGroup': {
        'permissionGroupId': 'string',
        'name': 'string',
        'description': 'string',
        'applicationPermissions': [
            'CreateDataset'|'ManageClusters'|'ManageUsersAndGroups'|'ManageAttributeSets'|'ViewAuditData'|'AccessNotebooks'|'GetTemporaryCredentials',
        ],
        'createTime': 123,
        'lastModifiedTime': 123,
        'membershipStatus': 'ADDITION_IN_PROGRESS'|'ADDITION_SUCCESS'|'REMOVAL_IN_PROGRESS'
    }
}

Response Structure

  • (dict) --
    • permissionGroup (dict) --

      The structure for a permission group.

      • permissionGroupId (string) --

        The unique identifier for the permission group.

      • name (string) --

        The name of the permission group.

      • description (string) --

        A brief description for the permission group.

      • applicationPermissions (list) --

        Indicates the permissions that are granted to a specific group for accessing the FinSpace application.

        Warning

        When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.

        • CreateDataset – Group members can create new datasets.
        • ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
        • ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.
        • ManageAttributeSets – Group members can manage attribute sets.
        • ViewAuditData – Group members can view audit data.
        • AccessNotebooks – Group members will have access to FinSpace notebooks.
        • GetTemporaryCredentials – Group members can get temporary API credentials.
        • (string) --
      • createTime (integer) --

        The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.

      • lastModifiedTime (integer) --

        Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.

      • membershipStatus (string) --

        Indicates the status of the user account within a permission group.

        • ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
        • ADDITION_SUCCESS – The user account is successfully added to the permission group.
        • REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

Exceptions

get_programmatic_access_credentials(**kwargs)

Request programmatic credentials to use with FinSpace SDK.

See also: AWS API Documentation

Request Syntax

response = client.get_programmatic_access_credentials(
    durationInMinutes=123,
    environmentId='string'
)
Parameters
  • durationInMinutes (integer) -- The time duration in which the credentials remain valid.
  • environmentId (string) --

    [REQUIRED]

    The FinSpace environment identifier.

Return type

dict

Returns

Response Syntax

{
    'credentials': {
        'accessKeyId': 'string',
        'secretAccessKey': 'string',
        'sessionToken': 'string'
    },
    'durationInMinutes': 123
}

Response Structure

  • (dict) -- Response for GetProgrammaticAccessCredentials operation

    • credentials (dict) --

      Returns the programmatic credentials.

      • accessKeyId (string) --

        The access key identifier.

      • secretAccessKey (string) --

        The access key.

      • sessionToken (string) --

        The session token.

    • durationInMinutes (integer) --

      Returns the duration in which the credentials will remain valid.

Exceptions

get_user(**kwargs)

Retrieves details for a specific user.

See also: AWS API Documentation

Request Syntax

response = client.get_user(
    userId='string'
)
Parameters
userId (string) --

[REQUIRED]

The unique identifier of the user to get data for.

Return type
dict
Returns
Response Syntax
{
    'userId': 'string',
    'status': 'CREATING'|'ENABLED'|'DISABLED',
    'firstName': 'string',
    'lastName': 'string',
    'emailAddress': 'string',
    'type': 'SUPER_USER'|'APP_USER',
    'apiAccess': 'ENABLED'|'DISABLED',
    'apiAccessPrincipalArn': 'string',
    'createTime': 123,
    'lastEnabledTime': 123,
    'lastDisabledTime': 123,
    'lastModifiedTime': 123,
    'lastLoginTime': 123
}

Response Structure

  • (dict) --
    • userId (string) --

      The unique identifier for the user account that is retrieved.

    • status (string) --

      The current status of the user account.

      • CREATING – The user account creation is in progress.
      • ENABLED – The user account is created and is currently active.
      • DISABLED – The user account is currently inactive.
    • firstName (string) --

      The first name of the user.

    • lastName (string) --

      The last name of the user.

    • emailAddress (string) --

      The email address that is associated with the user.

    • type (string) --

      Indicates the type of user.

      • SUPER_USER – A user with permission to all the functionality and data in FinSpace.
      • APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
    • apiAccess (string) --

      Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

      • ENABLED – The user has permissions to use the APIs.
      • DISABLED – The user does not have permissions to use any APIs.
    • apiAccessPrincipalArn (string) --

      The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

    • createTime (integer) --

      The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.

    • lastEnabledTime (integer) --

      Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.

    • lastDisabledTime (integer) --

      Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.

    • lastModifiedTime (integer) --

      Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.

    • lastLoginTime (integer) --

      Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
get_working_location(**kwargs)

A temporary Amazon S3 location, where you can copy your files from a source location to stage or use as a scratch space in FinSpace notebook.

See also: AWS API Documentation

Request Syntax

response = client.get_working_location(
    locationType='INGESTION'|'SAGEMAKER'
)
Parameters
locationType (string) --

Specify the type of the working location.

  • SAGEMAKER – Use the Amazon S3 location as a temporary location to store data content when working with FinSpace Notebooks that run on SageMaker studio.
  • INGESTION – Use the Amazon S3 location as a staging location to copy your data content and then use the location with the Changeset creation operation.
Return type
dict
Returns
Response Syntax
{
    's3Uri': 'string',
    's3Path': 'string',
    's3Bucket': 'string'
}

Response Structure

  • (dict) --
    • s3Uri (string) --

      Returns the Amazon S3 URI for the working location.

    • s3Path (string) --

      Returns the Amazon S3 Path for the working location.

    • s3Bucket (string) --

      Returns the Amazon S3 bucket name for the working location.

Exceptions

list_changesets(**kwargs)

Lists the FinSpace Changesets for a Dataset.

See also: AWS API Documentation

Request Syntax

response = client.list_changesets(
    datasetId='string',
    maxResults=123,
    nextToken='string'
)
Parameters
  • datasetId (string) --

    [REQUIRED]

    The unique identifier for the FinSpace Dataset to which the Changeset belongs.

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

dict

Returns

Response Syntax

{
    'changesets': [
        {
            'changesetId': 'string',
            'changesetArn': 'string',
            'datasetId': 'string',
            'changeType': 'REPLACE'|'APPEND'|'MODIFY',
            'sourceParams': {
                'string': 'string'
            },
            'formatParams': {
                'string': 'string'
            },
            'createTime': 123,
            'status': 'PENDING'|'FAILED'|'SUCCESS'|'RUNNING'|'STOP_REQUESTED',
            'errorInfo': {
                'errorMessage': 'string',
                'errorCategory': 'VALIDATION'|'SERVICE_QUOTA_EXCEEDED'|'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'THROTTLING'|'INTERNAL_SERVICE_EXCEPTION'|'CANCELLED'|'USER_RECOVERABLE'
            },
            'activeUntilTimestamp': 123,
            'activeFromTimestamp': 123,
            'updatesChangesetId': 'string',
            'updatedByChangesetId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) -- Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria.

    • changesets (list) --

      List of Changesets found.

      • (dict) --

        A Changeset is unit of data in a Dataset.

        • changesetId (string) --

          The unique identifier for a Changeset.

        • changesetArn (string) --

          The ARN identifier of the Changeset.

        • datasetId (string) --

          The unique identifier for the FinSpace Dataset in which the Changeset is created.

        • changeType (string) --

          Type that indicates how a Changeset is applied to a Dataset.

          • REPLACE – Changeset is considered as a replacement to all prior loaded Changesets.
          • APPEND – Changeset is considered as an addition to the end of all prior loaded Changesets.
          • MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.
        • sourceParams (dict) --

          Options that define the location of the data being ingested.

          • (string) --
            • (string) --
        • formatParams (dict) --

          Options that define the structure of the source file(s).

          • (string) --
            • (string) --
        • createTime (integer) --

          The timestamp at which the Changeset 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.

        • status (string) --

          Status of the Changeset ingestion.

          • PENDING – Changeset is pending creation.
          • FAILED – Changeset creation has failed.
          • SUCCESS – Changeset creation has succeeded.
          • RUNNING – Changeset creation is running.
          • STOP_REQUESTED – User requested Changeset creation to stop.
        • errorInfo (dict) --

          The structure with error messages.

          • 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.
        • activeUntilTimestamp (integer) --

          Time until which the Changeset is active. 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.

        • activeFromTimestamp (integer) --

          Beginning time from which the Changeset is active. 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.

        • updatesChangesetId (string) --

          The unique identifier of the Changeset that is updated.

        • updatedByChangesetId (string) --

          The unique identifier of the updated Changeset.

    • nextToken (string) --

      A token that indicates where a results page should begin.

Exceptions

list_data_views(**kwargs)

Lists all available Dataviews for a Dataset.

See also: AWS API Documentation

Request Syntax

response = client.list_data_views(
    datasetId='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • datasetId (string) --

    [REQUIRED]

    The unique identifier of the Dataset for which to retrieve Dataviews.

  • 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

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

Response Structure

  • (dict) --

    • nextToken (string) --

      A token that indicates where a results page should begin.

    • dataViews (list) --

      A list of Dataviews.

      • (dict) --

        Structure for the summary of a Dataview.

        • dataViewId (string) --

          The unique identifier for the Dataview.

        • dataViewArn (string) --

          The ARN identifier of the Dataview.

        • datasetId (string) --

          Th unique identifier for the Dataview Dataset.

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

        • partitionColumns (list) --

          Ordered set of column names used to partition data.

          • (string) -- 1 - 255 character String
        • sortColumns (list) --

          Columns to be used for sorting the data.

          • (string) -- 1 - 255 character 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.
        • errorInfo (dict) --

          The structure with error messages.

          • 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.
        • destinationTypeProperties (dict) --

          Information about the Dataview destination.

          • 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) --
        • autoUpdate (boolean) --

          The flag to indicate Dataview should be updated automatically.

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

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

Exceptions

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

list_permission_groups(**kwargs)

Lists all available permission groups in FinSpace.

See also: AWS API Documentation

Request Syntax

response = client.list_permission_groups(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- A token that indicates where a results page should begin.
  • maxResults (integer) --

    [REQUIRED]

    The maximum number of results per page.

Return type

dict

Returns

Response Syntax

{
    'permissionGroups': [
        {
            'permissionGroupId': 'string',
            'name': 'string',
            'description': 'string',
            'applicationPermissions': [
                'CreateDataset'|'ManageClusters'|'ManageUsersAndGroups'|'ManageAttributeSets'|'ViewAuditData'|'AccessNotebooks'|'GetTemporaryCredentials',
            ],
            'createTime': 123,
            'lastModifiedTime': 123,
            'membershipStatus': 'ADDITION_IN_PROGRESS'|'ADDITION_SUCCESS'|'REMOVAL_IN_PROGRESS'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • permissionGroups (list) --

      A list of all the permission groups.

      • (dict) --

        The structure for a permission group.

        • permissionGroupId (string) --

          The unique identifier for the permission group.

        • name (string) --

          The name of the permission group.

        • description (string) --

          A brief description for the permission group.

        • applicationPermissions (list) --

          Indicates the permissions that are granted to a specific group for accessing the FinSpace application.

          Warning

          When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.

          • CreateDataset – Group members can create new datasets.
          • ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
          • ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.
          • ManageAttributeSets – Group members can manage attribute sets.
          • ViewAuditData – Group members can view audit data.
          • AccessNotebooks – Group members will have access to FinSpace notebooks.
          • GetTemporaryCredentials – Group members can get temporary API credentials.
          • (string) --
        • createTime (integer) --

          The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.

        • lastModifiedTime (integer) --

          Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.

        • membershipStatus (string) --

          Indicates the status of the user account within a permission group.

          • ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
          • ADDITION_SUCCESS – The user account is successfully added to the permission group.
          • REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
    • nextToken (string) --

      A token that indicates where a results page should begin.

Exceptions

list_permission_groups_by_user(**kwargs)

Lists all the permission groups that are associated with a specific user account.

See also: AWS API Documentation

Request Syntax

response = client.list_permission_groups_by_user(
    userId='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • userId (string) --

    [REQUIRED]

    The unique identifier for the user.

  • nextToken (string) -- A token that indicates where a results page should begin.
  • maxResults (integer) --

    [REQUIRED]

    The maximum number of results per page.

Return type

dict

Returns

Response Syntax

{
    'permissionGroups': [
        {
            'permissionGroupId': 'string',
            'name': 'string',
            'membershipStatus': 'ADDITION_IN_PROGRESS'|'ADDITION_SUCCESS'|'REMOVAL_IN_PROGRESS'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • permissionGroups (list) --

      A list of returned permission groups.

      • (dict) --

        The structure of a permission group associated with a user account.

        • permissionGroupId (string) --

          The unique identifier for the permission group.

        • name (string) --

          The name of the permission group.

        • membershipStatus (string) --

          Indicates the status of the user account within a permission group.

          • ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
          • ADDITION_SUCCESS – The user account is successfully added to the permission group.
          • REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
    • nextToken (string) --

      A token that indicates where a results page should begin.

Exceptions

list_users(**kwargs)

Lists all available user accounts in FinSpace.

See also: AWS API Documentation

Request Syntax

response = client.list_users(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- A token that indicates where a results page should begin.
  • maxResults (integer) --

    [REQUIRED]

    The maximum number of results per page.

Return type

dict

Returns

Response Syntax

{
    'users': [
        {
            'userId': 'string',
            'status': 'CREATING'|'ENABLED'|'DISABLED',
            'firstName': 'string',
            'lastName': 'string',
            'emailAddress': 'string',
            'type': 'SUPER_USER'|'APP_USER',
            'apiAccess': 'ENABLED'|'DISABLED',
            'apiAccessPrincipalArn': 'string',
            'createTime': 123,
            'lastEnabledTime': 123,
            'lastDisabledTime': 123,
            'lastModifiedTime': 123,
            'lastLoginTime': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • users (list) --

      A list of all the user accounts.

      • (dict) --

        The details of the user account.

        • userId (string) --

          The unique identifier for the user.

        • status (string) --

          The current status of the user account.

          • CREATING – The user account creation is in progress.
          • ENABLED – The user account is created and is currently active.
          • DISABLED – The user account is currently inactive.
        • firstName (string) --

          The first name of the user.

        • lastName (string) --

          The last name of the user.

        • emailAddress (string) --

          The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.

        • type (string) --

          Indicates the type of user.

          • SUPER_USER – A user with permission to all the functionality and data in FinSpace.
          • APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
        • apiAccess (string) --

          Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

          • ENABLED – The user has permissions to use the APIs.
          • DISABLED – The user does not have permissions to use any APIs.
        • apiAccessPrincipalArn (string) --

          The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

        • createTime (integer) --

          The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.

        • lastEnabledTime (integer) --

          Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.

        • lastDisabledTime (integer) --

          Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.

        • lastModifiedTime (integer) --

          Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.

        • lastLoginTime (integer) --

          Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.

    • nextToken (string) --

      A token that indicates where a results page should begin.

Exceptions

list_users_by_permission_group(**kwargs)

Lists details of all the users in a specific permission group.

See also: AWS API Documentation

Request Syntax

response = client.list_users_by_permission_group(
    permissionGroupId='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • permissionGroupId (string) --

    [REQUIRED]

    The unique identifier for the permission group.

  • nextToken (string) -- A token that indicates where a results page should begin.
  • maxResults (integer) --

    [REQUIRED]

    The maximum number of results per page.

Return type

dict

Returns

Response Syntax

{
    'users': [
        {
            'userId': 'string',
            'status': 'CREATING'|'ENABLED'|'DISABLED',
            'firstName': 'string',
            'lastName': 'string',
            'emailAddress': 'string',
            'type': 'SUPER_USER'|'APP_USER',
            'apiAccess': 'ENABLED'|'DISABLED',
            'apiAccessPrincipalArn': 'string',
            'membershipStatus': 'ADDITION_IN_PROGRESS'|'ADDITION_SUCCESS'|'REMOVAL_IN_PROGRESS'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • users (list) --

      Lists details of all users in a specific permission group.

      • (dict) --

        The structure of a user account associated with a permission group.

        • userId (string) --

          The unique identifier for the user.

        • status (string) --

          The current status of the user account.

          • CREATING – The user account creation is in progress.
          • ENABLED – The user account is created and is currently active.
          • DISABLED – The user account is currently inactive.
        • firstName (string) --

          The first name of the user.

        • lastName (string) --

          The last name of the user.

        • emailAddress (string) --

          The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.

        • type (string) --

          Indicates the type of user.

          • SUPER_USER – A user with permission to all the functionality and data in FinSpace.
          • APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
        • apiAccess (string) --

          Indicates whether the user can access FinSpace API operations.

          • ENABLED – The user has permissions to use the API operations.
          • DISABLED – The user does not have permissions to use any API operations.
        • apiAccessPrincipalArn (string) --

          The IAM ARN identifier that is attached to FinSpace API calls.

        • membershipStatus (string) --

          Indicates the status of the user account within a permission group.

          • ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
          • ADDITION_SUCCESS – The user account is successfully added to the permission group.
          • REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
    • nextToken (string) --

      A token that indicates where a results page should begin.

Exceptions

reset_user_password(**kwargs)

Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.

See also: AWS API Documentation

Request Syntax

response = client.reset_user_password(
    userId='string',
    clientToken='string'
)
Parameters
  • userId (string) --

    [REQUIRED]

    The unique identifier of the user that a temporary password is requested for.

  • clientToken (string) --

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'userId': 'string',
    'temporaryPassword': 'string'
}

Response Structure

  • (dict) --

    • userId (string) --

      The unique identifier of the user that a new password is generated for.

    • temporaryPassword (string) --

      A randomly generated temporary password for the requested user account. This password expires in 7 days.

Exceptions

update_changeset(**kwargs)

Updates a FinSpace Changeset.

See also: AWS API Documentation

Request Syntax

response = client.update_changeset(
    clientToken='string',
    datasetId='string',
    changesetId='string',
    sourceParams={
        'string': 'string'
    },
    formatParams={
        'string': '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 FinSpace Dataset in which the Changeset is created.

  • changesetId (string) --

    [REQUIRED]

    The unique identifier for the Changeset to update.

  • sourceParams (dict) --

    [REQUIRED]

    Options that define the location of the data being ingested (s3SourcePath ) and the source of the changeset (sourceType ).

    Both s3SourcePath and sourceType are required attributes.

    Here is an example of how you could specify the sourceParams :

    "sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", "sourceType": "S3" }

    The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace API section.

    • (string) --
      • (string) --
  • formatParams (dict) --

    [REQUIRED]

    Options that define the structure of the source file(s) including the format type (formatType ), header row (withHeader ), data separation character (separator ) and the type of compression (compression ).

    formatType is a required attribute and can have the following values:
    • PARQUET – Parquet source file format.
    • CSV – CSV source file format.
    • JSON – JSON source file format.
    • XML – XML source file format.

    Here is an example of how you could specify the formatParams :

    "formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" }

    Note that if you only provide formatType as CSV , the rest of the attributes will automatically default to CSV values as following:

    { "withHeader": "true", "separator": "," }

    For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'changesetId': 'string',
    'datasetId': 'string'
}

Response Structure

  • (dict) -- The response from a update changeset operation.

    • changesetId (string) --

      The unique identifier for the Changeset to update.

    • datasetId (string) --

      The unique identifier for the FinSpace Dataset in which the Changeset is created.

Exceptions

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

update_permission_group(**kwargs)

Modifies the details of a permission group. You cannot modify a permissionGroupID .

See also: AWS API Documentation

Request Syntax

response = client.update_permission_group(
    permissionGroupId='string',
    name='string',
    description='string',
    applicationPermissions=[
        'CreateDataset'|'ManageClusters'|'ManageUsersAndGroups'|'ManageAttributeSets'|'ViewAuditData'|'AccessNotebooks'|'GetTemporaryCredentials',
    ],
    clientToken='string'
)
Parameters
  • permissionGroupId (string) --

    [REQUIRED]

    The unique identifier for the permission group to update.

  • name (string) -- The name of the permission group.
  • description (string) -- A brief description for the permission group.
  • applicationPermissions (list) --

    The permissions that are granted to a specific group for accessing the FinSpace application.

    Warning

    When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.

    • CreateDataset – Group members can create new datasets.
    • ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
    • ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.
    • ManageAttributeSets – Group members can manage attribute sets.
    • ViewAuditData – Group members can view audit data.
    • AccessNotebooks – Group members will have access to FinSpace notebooks.
    • GetTemporaryCredentials – Group members can get temporary API credentials.
    • (string) --
  • clientToken (string) --

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'permissionGroupId': 'string'
}

Response Structure

  • (dict) --

    • permissionGroupId (string) --

      The unique identifier for the updated permission group.

Exceptions

update_user(**kwargs)

Modifies the details of the specified user account. You cannot update the userId for a user.

See also: AWS API Documentation

Request Syntax

response = client.update_user(
    userId='string',
    type='SUPER_USER'|'APP_USER',
    firstName='string',
    lastName='string',
    apiAccess='ENABLED'|'DISABLED',
    apiAccessPrincipalArn='string',
    clientToken='string'
)
Parameters
  • userId (string) --

    [REQUIRED]

    The unique identifier for the user account to update.

  • type (string) --

    The option to indicate the type of user.

    • SUPER_USER – A user with permission to all the functionality and data in FinSpace.
    • APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
  • firstName (string) -- The first name of the user.
  • lastName (string) -- The last name of the user.
  • apiAccess (string) --

    The option to indicate whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

    • ENABLED – The user has permissions to use the APIs.
    • DISABLED – The user does not have permissions to use any APIs.
  • apiAccessPrincipalArn (string) -- The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.
  • clientToken (string) --

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'userId': 'string'
}

Response Structure

  • (dict) --

    • userId (string) --

      The unique identifier of the updated user account.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class FinSpaceData.Client.exceptions.AccessDeniedException

You do not have sufficient access to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have sufficient access to perform this action.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class FinSpaceData.Client.exceptions.ConflictException

The request conflicts with an existing resource.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'reason': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request conflicts with an existing resource.

    • message (string) --
    • reason (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class FinSpaceData.Client.exceptions.InternalServerException

The request processing has failed because of an unknown error, exception or failure.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request processing has failed because of an unknown error, exception or failure.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class FinSpaceData.Client.exceptions.LimitExceededException

A limit has exceeded.

Example

try:
  ...
except client.exceptions.LimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A limit has exceeded.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class FinSpaceData.Client.exceptions.ResourceNotFoundException

One or more resources can't be found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'reason': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    One or more resources can't be found.

    • message (string) --
    • reason (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class FinSpaceData.Client.exceptions.ThrottlingException

The request was denied due to request throttling.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The request was denied due to request throttling.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class FinSpaceData.Client.exceptions.ValidationException

The input fails to satisfy the constraints specified by an AWS service.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'reason': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The input fails to satisfy the constraints specified by an AWS service.

    • message (string) --
    • reason (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class FinSpaceData.Paginator.ListChangesets
paginator = client.get_paginator('list_changesets')
paginate(**kwargs)

Creates an iterator that will paginate through responses from FinSpaceData.Client.list_changesets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    datasetId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • datasetId (string) --

    [REQUIRED]

    The unique identifier for the FinSpace Dataset to which the Changeset belongs.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'changesets': [
        {
            'changesetId': 'string',
            'changesetArn': 'string',
            'datasetId': 'string',
            'changeType': 'REPLACE'|'APPEND'|'MODIFY',
            'sourceParams': {
                'string': 'string'
            },
            'formatParams': {
                'string': 'string'
            },
            'createTime': 123,
            'status': 'PENDING'|'FAILED'|'SUCCESS'|'RUNNING'|'STOP_REQUESTED',
            'errorInfo': {
                'errorMessage': 'string',
                'errorCategory': 'VALIDATION'|'SERVICE_QUOTA_EXCEEDED'|'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'THROTTLING'|'INTERNAL_SERVICE_EXCEPTION'|'CANCELLED'|'USER_RECOVERABLE'
            },
            'activeUntilTimestamp': 123,
            'activeFromTimestamp': 123,
            'updatesChangesetId': 'string',
            'updatedByChangesetId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) -- Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria.

    • changesets (list) --

      List of Changesets found.

      • (dict) --

        A Changeset is unit of data in a Dataset.

        • changesetId (string) --

          The unique identifier for a Changeset.

        • changesetArn (string) --

          The ARN identifier of the Changeset.

        • datasetId (string) --

          The unique identifier for the FinSpace Dataset in which the Changeset is created.

        • changeType (string) --

          Type that indicates how a Changeset is applied to a Dataset.

          • REPLACE – Changeset is considered as a replacement to all prior loaded Changesets.
          • APPEND – Changeset is considered as an addition to the end of all prior loaded Changesets.
          • MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.
        • sourceParams (dict) --

          Options that define the location of the data being ingested.

          • (string) --
            • (string) --
        • formatParams (dict) --

          Options that define the structure of the source file(s).

          • (string) --
            • (string) --
        • createTime (integer) --

          The timestamp at which the Changeset 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.

        • status (string) --

          Status of the Changeset ingestion.

          • PENDING – Changeset is pending creation.
          • FAILED – Changeset creation has failed.
          • SUCCESS – Changeset creation has succeeded.
          • RUNNING – Changeset creation is running.
          • STOP_REQUESTED – User requested Changeset creation to stop.
        • errorInfo (dict) --

          The structure with error messages.

          • 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.
        • activeUntilTimestamp (integer) --

          Time until which the Changeset is active. 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.

        • activeFromTimestamp (integer) --

          Beginning time from which the Changeset is active. 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.

        • updatesChangesetId (string) --

          The unique identifier of the Changeset that is updated.

        • updatedByChangesetId (string) --

          The unique identifier of the updated Changeset.

    • NextToken (string) --

      A token to resume pagination.

class FinSpaceData.Paginator.ListDataViews
paginator = client.get_paginator('list_data_views')
paginate(**kwargs)

Creates an iterator that will paginate through responses from FinSpaceData.Client.list_data_views().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    datasetId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • datasetId (string) --

    [REQUIRED]

    The unique identifier of the Dataset for which to retrieve Dataviews.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • dataViews (list) --

      A list of Dataviews.

      • (dict) --

        Structure for the summary of a Dataview.

        • dataViewId (string) --

          The unique identifier for the Dataview.

        • dataViewArn (string) --

          The ARN identifier of the Dataview.

        • datasetId (string) --

          Th unique identifier for the Dataview Dataset.

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

        • partitionColumns (list) --

          Ordered set of column names used to partition data.

          • (string) -- 1 - 255 character String
        • sortColumns (list) --

          Columns to be used for sorting the data.

          • (string) -- 1 - 255 character 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.
        • errorInfo (dict) --

          The structure with error messages.

          • 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.
        • destinationTypeProperties (dict) --

          Information about the Dataview destination.

          • 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) --
        • autoUpdate (boolean) --

          The flag to indicate Dataview should be updated automatically.

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

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

    • NextToken (string) --

      A token to resume pagination.

class FinSpaceData.Paginator.ListDatasets
paginator = client.get_paginator('list_datasets')
paginate(**kwargs)

Creates an iterator that will paginate through responses from FinSpaceData.Client.list_datasets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

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 to resume pagination.

class FinSpaceData.Paginator.ListPermissionGroups
paginator = client.get_paginator('list_permission_groups')
paginate(**kwargs)

Creates an iterator that will paginate through responses from FinSpaceData.Client.list_permission_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'permissionGroups': [
        {
            'permissionGroupId': 'string',
            'name': 'string',
            'description': 'string',
            'applicationPermissions': [
                'CreateDataset'|'ManageClusters'|'ManageUsersAndGroups'|'ManageAttributeSets'|'ViewAuditData'|'AccessNotebooks'|'GetTemporaryCredentials',
            ],
            'createTime': 123,
            'lastModifiedTime': 123,
            'membershipStatus': 'ADDITION_IN_PROGRESS'|'ADDITION_SUCCESS'|'REMOVAL_IN_PROGRESS'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • permissionGroups (list) --

      A list of all the permission groups.

      • (dict) --

        The structure for a permission group.

        • permissionGroupId (string) --

          The unique identifier for the permission group.

        • name (string) --

          The name of the permission group.

        • description (string) --

          A brief description for the permission group.

        • applicationPermissions (list) --

          Indicates the permissions that are granted to a specific group for accessing the FinSpace application.

          Warning

          When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.

          • CreateDataset – Group members can create new datasets.
          • ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
          • ManageUsersAndGroups – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.
          • ManageAttributeSets – Group members can manage attribute sets.
          • ViewAuditData – Group members can view audit data.
          • AccessNotebooks – Group members will have access to FinSpace notebooks.
          • GetTemporaryCredentials – Group members can get temporary API credentials.
          • (string) --
        • createTime (integer) --

          The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.

        • lastModifiedTime (integer) --

          Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.

        • membershipStatus (string) --

          Indicates the status of the user account within a permission group.

          • ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
          • ADDITION_SUCCESS – The user account is successfully added to the permission group.
          • REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
    • NextToken (string) --

      A token to resume pagination.

class FinSpaceData.Paginator.ListUsers
paginator = client.get_paginator('list_users')
paginate(**kwargs)

Creates an iterator that will paginate through responses from FinSpaceData.Client.list_users().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'users': [
        {
            'userId': 'string',
            'status': 'CREATING'|'ENABLED'|'DISABLED',
            'firstName': 'string',
            'lastName': 'string',
            'emailAddress': 'string',
            'type': 'SUPER_USER'|'APP_USER',
            'apiAccess': 'ENABLED'|'DISABLED',
            'apiAccessPrincipalArn': 'string',
            'createTime': 123,
            'lastEnabledTime': 123,
            'lastDisabledTime': 123,
            'lastModifiedTime': 123,
            'lastLoginTime': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • users (list) --

      A list of all the user accounts.

      • (dict) --

        The details of the user account.

        • userId (string) --

          The unique identifier for the user.

        • status (string) --

          The current status of the user account.

          • CREATING – The user account creation is in progress.
          • ENABLED – The user account is created and is currently active.
          • DISABLED – The user account is currently inactive.
        • firstName (string) --

          The first name of the user.

        • lastName (string) --

          The last name of the user.

        • emailAddress (string) --

          The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.

        • type (string) --

          Indicates the type of user.

          • SUPER_USER – A user with permission to all the functionality and data in FinSpace.
          • APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
        • apiAccess (string) --

          Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

          • ENABLED – The user has permissions to use the APIs.
          • DISABLED – The user does not have permissions to use any APIs.
        • apiAccessPrincipalArn (string) --

          The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

        • createTime (integer) --

          The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.

        • lastEnabledTime (integer) --

          Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.

        • lastDisabledTime (integer) --

          Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.

        • lastModifiedTime (integer) --

          Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.

        • lastLoginTime (integer) --

          Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.

    • NextToken (string) --

      A token to resume pagination.