FinSpaceData / Paginator / ListChangesets

ListChangesets

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.