OpenSearchService / Client / cancel_service_software_update



Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain’s UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.

See also: AWS API Documentation

Request Syntax

response = client.cancel_service_software_update(

DomainName (string) –


Name of the OpenSearch Service domain that you want to cancel the service software update on.

Return type:



Response Syntax

    'ServiceSoftwareOptions': {
        'CurrentVersion': 'string',
        'NewVersion': 'string',
        'UpdateAvailable': True|False,
        'Cancellable': True|False,
        'Description': 'string',
        'AutomatedUpdateDate': datetime(2015, 1, 1),
        'OptionalDeployment': True|False

Response Structure

  • (dict) –

    Container for the response to a CancelServiceSoftwareUpdate operation. Contains the status of the update.

    • ServiceSoftwareOptions (dict) –

      Container for the state of your domain relative to the latest service software.

      • CurrentVersion (string) –

        The current service software version present on the domain.

      • NewVersion (string) –

        The new service software version, if one is available.

      • UpdateAvailable (boolean) –

        True if you’re able to update your service software version. False if you can’t update your service software version.

      • Cancellable (boolean) –

        True if you’re able to cancel your service software version update. False if you can’t cancel your service software update.

      • UpdateStatus (string) –

        The status of your service software update.

      • Description (string) –

        A description of the service software update status.

      • AutomatedUpdateDate (datetime) –

        The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

      • OptionalDeployment (boolean) –

        True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.