NeptuneData / Client / cancel_index_rebuild

cancel_index_rebuild

NeptuneData.Client.cancel_index_rebuild(**kwargs)

Cancels an in-progress 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:CancelIndexRebuild IAM action in that cluster.

See also: AWS API Documentation

Request Syntax

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

rebuildId (string) –

[REQUIRED]

The unique identifier of the index rebuild job to cancel.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'PREPARING'|'REBUILDING'|'COMPLETED'|'FAILED'|'CANCELLED'|'CANCELLING',
    'concurrency': 123,
    'writeBufferSize': 'LOW'|'MEDIUM'|'HIGH'
}

Response Structure

  • (dict) –

    • status (string) –

      The status of the cancellation request.

    • concurrency (integer) –

      The concurrency of the rebuild being cancelled, echoed from the original StartIndexRebuild request.

    • writeBufferSize (string) –

      The WriteBufferSize of the rebuild being cancelled, echoed from the original StartIndexRebuild request.

Exceptions