# Migration

class elasticsearch.client.MigrationClient

  To use this client, access `client.migration` from an `Elasticsearch` client. For example:

      from elasticsearch import Elasticsearch

      # Create the client instance
      client = Elasticsearch(...)
      # Use the migration client
      client.migration.<method>(...)

  deprecations(*, index=None, error_trace=None, filter_path=None, human=None, pretty=None)

    Get deprecation information.

    Returns information about deprecated features which are in use in the cluster. The reported features include cluster, node, and index level settings that will be removed or changed in the next major version. You must address the reported issues before upgrading to the next major version. However, no action is required when upgrading within the current major version. Deprecated features remain fully supported and will continue to work in the current version, and when upgrading to a newer minor or patch release in the same major version. Use this API to review your usage of these features and migrate away from them at your own pace, before upgrading to a new major version.

    > info This API is designed for indirect use by the Upgrade Assistant. We recommend learning about deprecated features using the Upgrade Assistant rather than calling this API directly.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-deprecations

    Parameters:

      - index (str | None) – Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_feature_upgrade_status(*, error_trace=None, filter_path=None, human=None, pretty=None)

    Get feature migration information.

    Version upgrades sometimes require changes to how features store configuration information and data in system indices. Check which features need to be migrated and the status of any migrations that are in progress.

    TIP: This API is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-get-feature-upgrade-status

    Parameters:

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  post_feature_upgrade(*, error_trace=None, filter_path=None, human=None, pretty=None)

    Start the feature migration.

    Version upgrades sometimes require changes to how features store configuration information and data in system indices. This API starts the automatic migration process.

    Some functionality might be temporarily unavailable during the migration process.

    TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-get-feature-upgrade-status

    Parameters:

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]