OpenSearchService / Client / upgrade_domain

upgrade_domain

OpenSearchService.Client.upgrade_domain(**kwargs)

Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

See also: AWS API Documentation

Request Syntax

response = client.upgrade_domain(
    DomainName='string',
    TargetVersion='string',
    PerformCheckOnly=True|False,
    AdvancedOptions={
        'string': 'string'
    },
    DeploymentStrategyOptions={
        'DeploymentStrategy': 'ClonedBlueGreen',
        'ClonedBlueGreenOptions': {
            'RetentionOptions': {
                'RetentionInHours': 123,
                'RetentionAction': 'RollbackToPrimaryCluster'|'DeletePrimaryCluster'
            }
        }
    }
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    Name of the OpenSearch Service domain that you want to upgrade.

  • TargetVersion (string) –

    [REQUIRED]

    OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.

  • PerformCheckOnly (boolean) – When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

  • AdvancedOptions (dict) –

    Only supports the override_main_response_version parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.

    • (string) –

      • (string) –

  • DeploymentStrategyOptions (dict) –

    Overrides the deployment strategy for this upgrade. To run a cloned blue/green upgrade, set DeploymentStrategy to ClonedBlueGreen.

    • DeploymentStrategy (string) – [REQUIRED]

      The deployment strategy to use for this operation. The only valid value is ClonedBlueGreen, which creates a cloned cluster on the target version next to the primary cluster so that you can validate it and shift traffic to it before you cut over.

    • ClonedBlueGreenOptions (dict) –

      Options that apply when DeploymentStrategy is ClonedBlueGreen.

      • RetentionOptions (dict) –

        How long to keep the cluster that you cut over from after cutover completes. When you start the upgrade, only RetentionInHours is accepted.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: RetentionInHours, RetentionAction.

        • RetentionInHours (integer) –

          The number of hours to keep the cluster that you cut over from. The retention period starts when cutover completes. The minimum is 1 hour. In an UpdateClone response after cutover completes, this value is the number of hours remaining in the retention period, rounded up.

        • RetentionAction (string) –

          Ends the retention period now. Valid only after cutover completes.

Return type:

dict

Returns:

Response Syntax

{
    'UpgradeId': 'string',
    'DomainName': 'string',
    'TargetVersion': 'string',
    'PerformCheckOnly': True|False,
    'AdvancedOptions': {
        'string': 'string'
    },
    'DeploymentStrategyOptions': {
        'DeploymentStrategy': 'ClonedBlueGreen',
        'ClonedBlueGreenOptions': {
            'RetentionOptions': {
                'RetentionInHours': 123,
                'RetentionAction': 'RollbackToPrimaryCluster'|'DeletePrimaryCluster'
            }
        }
    },
    'ChangeProgressDetails': {
        'ChangeId': 'string',
        'Message': 'string',
        'ConfigChangeStatus': 'Pending'|'Initializing'|'Validating'|'ValidationFailed'|'ApplyingChanges'|'Completed'|'PendingUserInput'|'Cancelled',
        'InitiatedBy': 'CUSTOMER'|'SERVICE',
        'StartTime': datetime(2015, 1, 1),
        'LastUpdatedTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    Container for the response returned by UpgradeDomain operation.

    • UpgradeId (string) –

      The unique identifier of the domain upgrade.

    • DomainName (string) –

      The name of the domain that was upgraded.

    • TargetVersion (string) –

      OpenSearch or Elasticsearch version that the domain was upgraded to.

    • PerformCheckOnly (boolean) –

      When true, indicates that an upgrade eligibility check was performed.

    • AdvancedOptions (dict) –

      The advanced options configuration for the domain.

      • (string) –

        • (string) –

    • DeploymentStrategyOptions (dict) –

      The deployment strategy override used for the upgrade.

      • DeploymentStrategy (string) –

        The deployment strategy to use for this operation. The only valid value is ClonedBlueGreen, which creates a cloned cluster on the target version next to the primary cluster so that you can validate it and shift traffic to it before you cut over.

      • ClonedBlueGreenOptions (dict) –

        Options that apply when DeploymentStrategy is ClonedBlueGreen.

        • RetentionOptions (dict) –

          How long to keep the cluster that you cut over from after cutover completes. When you start the upgrade, only RetentionInHours is accepted.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: RetentionInHours, RetentionAction. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • RetentionInHours (integer) –

            The number of hours to keep the cluster that you cut over from. The retention period starts when cutover completes. The minimum is 1 hour. In an UpdateClone response after cutover completes, this value is the number of hours remaining in the retention period, rounded up.

          • RetentionAction (string) –

            Ends the retention period now. Valid only after cutover completes.

    • ChangeProgressDetails (dict) –

      Container for information about a configuration change happening on a domain.

      • ChangeId (string) –

        The ID of the configuration change.

      • Message (string) –

        A message corresponding to the status of the configuration change.

      • ConfigChangeStatus (string) –

        The current status of the configuration change.

      • InitiatedBy (string) –

        The IAM principal who initiated the configuration change.

      • StartTime (datetime) –

        The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

      • LastUpdatedTime (datetime) –

        The last time that the configuration change was updated.

Exceptions