finspace / Client / list_kx_changesets

list_kx_changesets#

finspace.Client.list_kx_changesets(**kwargs)#

Returns a list of all the changesets for a database.

See also: AWS API Documentation

Request Syntax

response = client.list_kx_changesets(
    environmentId='string',
    databaseName='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • environmentId (string) –

    [REQUIRED]

    A unique identifier for the kdb environment.

  • databaseName (string) –

    [REQUIRED]

    The name of the kdb database.

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

  • maxResults (integer) – The maximum number of results to return in this request.

Return type:

dict

Returns:

Response Syntax

{
    'kxChangesets': [
        {
            'changesetId': 'string',
            'createdTimestamp': datetime(2015, 1, 1),
            'activeFromTimestamp': datetime(2015, 1, 1),
            'lastModifiedTimestamp': datetime(2015, 1, 1),
            'status': 'PENDING'|'PROCESSING'|'FAILED'|'COMPLETED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • kxChangesets (list) –

      A list of changesets for a database.

      • (dict) –

        Details of changeset.

        • changesetId (string) –

          A unique identifier for the changeset.

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

        • status (string) –

          Status of the changeset.

          • Pending – Changeset creation is pending.

          • Processing – Changeset creation is running.

          • Failed – Changeset creation has failed.

          • Complete – Changeset creation has succeeded.

    • nextToken (string) –

      A token that indicates where a results page should begin.

Exceptions

  • finspace.Client.exceptions.InternalServerException

  • finspace.Client.exceptions.ValidationException

  • finspace.Client.exceptions.ThrottlingException

  • finspace.Client.exceptions.AccessDeniedException

  • finspace.Client.exceptions.ResourceNotFoundException