FinSpace Public API

2021/05/03 - FinSpace Public API - 3 new api methods

Changes  This is the initial SDK release for the management APIs for Amazon FinSpace. Amazon FinSpace is a data management and analytics service for the financial services industry (FSI).

GetProgrammaticAccessCredentials (new) Link ¶

Request programmatic credentials to use with Habanero SDK.

See also: AWS API Documentation

Request Syntax

client.get_programmatic_access_credentials(
    durationInMinutes=123,
    environmentId='string'
)
type durationInMinutes:

integer

param durationInMinutes:

The time duration in which the credentials remain valid.

type environmentId:

string

param environmentId:

[REQUIRED]

The habanero environment identifier.

rtype:

dict

returns:

Response Syntax

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

Response Structure

  • (dict) --

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

GetWorkingLocation (new) Link ¶

A temporary Amazon S3 location to copy your files from a source location to stage or use as a scratch space in Habanero notebook.

See also: AWS API Documentation

Request Syntax

client.get_working_location(
    locationType='INGESTION'|'SAGEMAKER'
)
type locationType:

string

param locationType:

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.

rtype:

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.

CreateChangeset (new) Link ¶

Creates a new changeset in a FinSpace dataset.

See also: AWS API Documentation

Request Syntax

client.create_changeset(
    datasetId='string',
    changeType='REPLACE'|'APPEND'|'MODIFY',
    sourceType='S3',
    sourceParams={
        'string': 'string'
    },
    formatType='CSV'|'JSON'|'PARQUET'|'XML',
    formatParams={
        'string': 'string'
    },
    tags={
        'string': 'string'
    }
)
type datasetId:

string

param datasetId:

[REQUIRED]

The unique identifier for the FinSpace dataset in which the changeset will be created.

type changeType:

string

param changeType:

[REQUIRED]

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.

type sourceType:

string

param sourceType:

[REQUIRED]

Type of the data source from which the files to create the changeset will be sourced.

  • S3 - Amazon S3.

type sourceParams:

dict

param sourceParams:

[REQUIRED]

Source path from which the files to create the changeset will be sourced.

  • (string) --

    • (string) --

type formatType:

string

param formatType:

Format type of the input files being loaded into the changeset.

type formatParams:

dict

param formatParams:

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

  • (string) --

    • (string) --

type tags:

dict

param tags:

Metadata tags to apply to this changeset.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'changeset': {
        'id': 'string',
        'changesetArn': 'string',
        'datasetId': 'string',
        'changeType': 'REPLACE'|'APPEND'|'MODIFY',
        'sourceType': 'S3',
        'sourceParams': {
            'string': 'string'
        },
        'formatType': 'CSV'|'JSON'|'PARQUET'|'XML',
        'formatParams': {
            'string': 'string'
        },
        'createTimestamp': datetime(2015, 1, 1),
        'status': 'PENDING'|'FAILED'|'SUCCESS'|'RUNNING'|'STOP_REQUESTED',
        'errorInfo': {
            'errorMessage': 'string',
            'errorCategory': 'The_inputs_to_this_request_are_invalid'|'Service_limits_have_been_exceeded'|'Missing_required_permission_to_perform_this_request'|'One_or_more_inputs_to_this_request_were_not_found'|'The_system_temporarily_lacks_sufficient_resources_to_process_the_request'|'An_internal_error_has_occurred'|'Cancelled'|'A_user_recoverable_error_has_occurred'
        },
        'changesetLabels': {
            'string': 'string'
        },
        'updatesChangesetId': 'string',
        'updatedByChangesetId': 'string'
    }
}

Response Structure

  • (dict) --

    • changeset (dict) --

      Returns the changeset details.

      • id (string) --

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

        Change type 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.

      • sourceType (string) --

        Type of the data source from which the files to create the changeset are sourced.

        • S3 - Amazon S3.

      • sourceParams (dict) --

        Source path from which the files to create the changeset are sourced.

        • (string) --

          • (string) --

      • formatType (string) --

        Format type of the input files loaded into the changeset.

      • formatParams (dict) --

        Structure of the source file(s).

        • (string) --

          • (string) --

      • createTimestamp (datetime) --

        The timestamp at which the changeset was created in FinSpace.

      • 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 - A user recoverable error has occurred.

      • changesetLabels (dict) --

        Tags associated with the changeset.

        • (string) --

          • (string) --

      • updatesChangesetId (string) --

        Unique identifier of the changeset that is updated.

      • updatedByChangesetId (string) --

        Unique identifier of the changeset that is updated a changeset.