get_changeset

FinSpaceData.Client.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

• FinSpaceData.Client.exceptions.ResourceNotFoundException
• FinSpaceData.Client.exceptions.InternalServerException
• FinSpaceData.Client.exceptions.ValidationException
• FinSpaceData.Client.exceptions.ThrottlingException
• FinSpaceData.Client.exceptions.AccessDeniedException
• FinSpaceData.Client.exceptions.ConflictException