BackupSearch / Client / stop_search_job

stop_search_job

BackupSearch.Client.stop_search_job(**kwargs)

This operations ends a search job.

Only a search job with a status of RUNNING can be stopped.

See also: AWS API Documentation

Request Syntax

response = client.stop_search_job(
    SearchJobIdentifier='string'
)
Parameters:

SearchJobIdentifier (string) –

[REQUIRED]

The unique string that specifies the search job.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • BackupSearch.Client.exceptions.ResourceNotFoundException

  • BackupSearch.Client.exceptions.ThrottlingException

  • BackupSearch.Client.exceptions.AccessDeniedException

  • BackupSearch.Client.exceptions.ValidationException

  • BackupSearch.Client.exceptions.InternalServerException

  • BackupSearch.Client.exceptions.ConflictException