NeptuneData / Client / get_index_rebuild_status

get_index_rebuild_status

NeptuneData.Client.get_index_rebuild_status(**kwargs)

Retrieves the status of an index rebuild operation.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetIndexRebuildStatus IAM action in that cluster.

See also: AWS API Documentation

Request Syntax

response = client.get_index_rebuild_status(
    rebuildId='string'
)
Parameters:

rebuildId (string) –

[REQUIRED]

The unique identifier of the index rebuild job returned by the StartIndexRebuild operation.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'PREPARING'|'REBUILDING'|'COMPLETED'|'FAILED'|'CANCELLED'|'CANCELLING',
    'scope': 'ALL'|'QUADS'|'DICTIONARIES',
    'concurrency': 123,
    'writeBufferSize': 'LOW'|'MEDIUM'|'HIGH',
    'startTime': datetime(2015, 1, 1),
    'progressPercentage': 123,
    'estimatedEndTime': datetime(2015, 1, 1),
    'endTime': datetime(2015, 1, 1),
    'failureReason': 'string'
}

Response Structure

  • (dict) –

    • status (string) –

      The current status of the rebuild operation. See RebuildStatus for possible values: PREPARING, REBUILDING, COMPLETED, FAILED, CANCELLING or CANCELLED.

    • scope (string) –

      The scope of the rebuild operation. See Scope for possible values: ALL, QUADS, or DICTIONARIES.

    • concurrency (integer) –

      The concurrency in effect for this rebuild, as echoed from the original StartIndexRebuild request.

    • writeBufferSize (string) –

      The WriteBufferSize in effect for this rebuild, as echoed from the original StartIndexRebuild request.

    • startTime (datetime) –

      The ISO-8601 timestamp indicating when the index rebuild operation started.

    • progressPercentage (integer) –

      The percentage of the index rebuild operation that has been completed, expressed as an integer from 0 to 100.

    • estimatedEndTime (datetime) –

      The estimated ISO-8601 timestamp for when the index rebuild operation will complete. The estimate may change as the operation progresses.

    • endTime (datetime) –

      The ISO-8601 timestamp indicating when the index rebuild operation completed. This field is only present when the operation has completed (status is COMPLETED, FAILED, or CANCELLED).

    • failureReason (string) –

      The reason for the failure, if the rebuild operation failed. This field is only populated when the status is FAILED.

Exceptions