finspace / Client / get_kx_changeset

get_kx_changeset

finspace.Client.get_kx_changeset(**kwargs)

Returns information about a kdb changeset.

See also: AWS API Documentation

Request Syntax

response = client.get_kx_changeset(
    environmentId='string',
    databaseName='string',
    changesetId='string'
)

Parameters:

• environmentId (string) –

  [REQUIRED]

  A unique identifier for the kdb environment.

• databaseName (string) –

  [REQUIRED]

  The name of the kdb database.

• changesetId (string) –

  [REQUIRED]

  A unique identifier of the changeset for which you want to retrieve data.

Return type:

dict

Returns:

Response Syntax

{
    'changesetId': 'string',
    'databaseName': 'string',
    'environmentId': 'string',
    'changeRequests': [
        {
            'changeType': 'PUT'|'DELETE',
            's3Path': 'string',
            'dbPath': 'string'
        },
    ],
    'createdTimestamp': datetime(2015, 1, 1),
    'activeFromTimestamp': datetime(2015, 1, 1),
    'lastModifiedTimestamp': datetime(2015, 1, 1),
    'status': 'PENDING'|'PROCESSING'|'FAILED'|'COMPLETED',
    'errorInfo': {
        'errorMessage': 'string',
        'errorType': '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'
    }
}

Response Structure

• (dict) –

  • changesetId (string) –

    A unique identifier for the changeset.

  • databaseName (string) –

    The name of the kdb database.

  • environmentId (string) –

    A unique identifier for the kdb environment.

  • changeRequests (list) –

    A list of change request objects that are run in order.

    • (dict) –

      A list of change request objects.

      • changeType (string) –

        Defines the type of change request. A changeType can have the following values:

        • PUT – Adds or updates files in a database.

        • DELETE – Deletes files in a database.

      • s3Path (string) –

        Defines the S3 path of the source file that is required to add or update files in a database.

      • dbPath (string) –

        Defines the path within the database directory.

  • createdTimestamp (datetime) –

    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.

  • activeFromTimestamp (datetime) –

    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.

  • lastModifiedTimestamp (datetime) –

    The timestamp at which the changeset was updated 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 creation process.

    • Pending – Changeset creation is pending.

    • Processing – Changeset creation is running.

    • Failed – Changeset creation has failed.

    • Complete – Changeset creation has succeeded.

  • errorInfo (dict) –

    Provides details in the event of a failed flow, including the error type and the related error message.

    • errorMessage (string) –

      Specifies the error message that appears if a flow fails.

    • errorType (string) –

      Specifies the type of error.

Exceptions

• finspace.Client.exceptions.InternalServerException

• finspace.Client.exceptions.ValidationException

• finspace.Client.exceptions.ThrottlingException

• finspace.Client.exceptions.AccessDeniedException

• finspace.Client.exceptions.ResourceNotFoundException