Exceptions & Warnings

API Errors

These errors are triggered from an HTTP response that isn’t 2XX:

class elasticsearch.ApiError(message: str, meta: elastic_transport.ApiResponseMeta, body: Any, errors: Tuple[Exception, ...] = ())
error

Backwards-compatible way to access self.message

info

Backwards-compatible way to access self.body

status_code

Backwards-compatible way to access self.meta.status

class elasticsearch.NotFoundError(message: str, meta: elastic_transport.ApiResponseMeta, body: Any, errors: Tuple[Exception, ...] = ())

Exception representing a 404 status code.

class elasticsearch.ConflictError(message: str, meta: elastic_transport.ApiResponseMeta, body: Any, errors: Tuple[Exception, ...] = ())

Exception representing a 409 status code.

elasticsearch.RequestError

alias of elasticsearch.BadRequestError

class elasticsearch.AuthenticationException(message: str, meta: elastic_transport.ApiResponseMeta, body: Any, errors: Tuple[Exception, ...] = ())

Exception representing a 401 status code.

class elasticsearch.AuthorizationException(message: str, meta: elastic_transport.ApiResponseMeta, body: Any, errors: Tuple[Exception, ...] = ())

Exception representing a 403 status code.

class elasticsearch.UnsupportedProductError(message: str, meta: elastic_transport.ApiResponseMeta, body: Any, errors: Tuple[Exception, ...] = ())

Error which is raised when the client detects it’s not connected to a supported product.

Transport and Connection Errors

These errors are triggered by an error occurring before an HTTP response arrives:

class elasticsearch.TransportError(message: Any, errors: Tuple[Exception, ...] = ())

Generic exception for the ‘elastic-transport’ package.

For the ‘errors’ attribute, errors are ordered from most recently raised (index=0) to least recently raised (index=N)

If an HTTP status code is available with the error it will be stored under ‘status’. If HTTP headers are available they are stored under ‘headers’.

class elasticsearch.SerializationError(message: Any, errors: Tuple[Exception, ...] = ())

Error that occurred during the serialization or deserialization of an HTTP message body

class elasticsearch.ConnectionError(message: Any, errors: Tuple[Exception, ...] = ())

Error raised by the HTTP connection

class elasticsearch.ConnectionTimeout(message: Any, errors: Tuple[Exception, ...] = ())

Connection timed out during an operation

elasticsearch.SSLError

alias of elastic_transport.TlsError

Warnings

class elasticsearch.ElasticsearchWarning

Warning that is raised when a deprecated option or incorrect usage is flagged via the ‘Warning’ HTTP header.