OpenSearchService / Client / cancel_domain_config_change

cancel_domain_config_change#

OpenSearchService.Client.cancel_domain_config_change(**kwargs)#

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

See also: AWS API Documentation

Request Syntax

response = client.cancel_domain_config_change(
    DomainName='string',
    DryRun=True|False
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

  • DryRun (boolean) – When set to True, returns the list of change IDs and properties that will be cancelled without actually cancelling the change.

Return type:

dict

Returns:

Response Syntax

{
    'CancelledChangeIds': [
        'string',
    ],
    'CancelledChangeProperties': [
        {
            'PropertyName': 'string',
            'CancelledValue': 'string',
            'ActiveValue': 'string'
        },
    ],
    'DryRun': True|False
}

Response Structure

  • (dict) –

    • CancelledChangeIds (list) –

      The unique identifiers of the changes that were cancelled.

      • (string) –

    • CancelledChangeProperties (list) –

      The domain change properties that were cancelled.

      • (dict) –

        A property change that was cancelled for an Amazon OpenSearch Service domain.

        • PropertyName (string) –

          The name of the property whose change was cancelled.

        • CancelledValue (string) –

          The pending value of the property that was cancelled. This would have been the eventual value of the property if the chance had not been cancelled.

        • ActiveValue (string) –

          The current value of the property, after the change was cancelled.

    • DryRun (boolean) –

      Whether or not the request was a dry run. If True, the changes were not actually cancelled.

Exceptions