OpenSearchService / Client / rollback_service_software_update

rollback_service_software_update¶

OpenSearchService.Client.rollback_service_software_update(**kwargs)¶

Rolls back a service software update for a domain to the previous version. For more information, see Service software updates in Amazon OpenSearch Service.

Request Syntax

response = client.rollback_service_software_update(
    DomainName='string'
)

Parameters:

DomainName (string) –

[REQUIRED]

The name of the domain to roll back the service software update on.

Return type:

dict

Returns:

Response Syntax

{
    'RollbackServiceSoftwareOptions': {
        'CurrentVersion': 'string',
        'NewVersion': 'string',
        'RollbackAvailable': True|False,
        'Description': 'string'
    }
}

Response Structure

(dict) –

Contains details about the rolled-back service software update.
- RollbackServiceSoftwareOptions (dict) –
  
  The rollback options for the service software update.
  - CurrentVersion (string) –
    
    The current service software version on the domain.
  - NewVersion (string) –
    
    The service software version that the domain will roll back to.
  - RollbackAvailable (boolean) –
    
    Whether a service software rollback is available for the domain.
  - Description (string) –
    
    A description of the rollback status.

Exceptions

OpenSearchService.Client.exceptions.BaseException
OpenSearchService.Client.exceptions.InternalException
OpenSearchService.Client.exceptions.ResourceNotFoundException
OpenSearchService.Client.exceptions.ValidationException
OpenSearchService.Client.exceptions.DisabledOperationException