:doc:`ElasticsearchService <../../es>` / Client / cancel_domain_config_change

***************************
cancel_domain_config_change
***************************



.. py:method:: ElasticsearchService.Client.cancel_domain_config_change(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/es-2015-01-01/CancelDomainConfigChange>`_  


  **Request Syntax**
  ::

    response = client.cancel_domain_config_change(
        DomainName='string',
        DryRun=True|False
    )
    
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

    Name of the OpenSearch Service domain configuration request to cancel.

    

  
  :type DryRun: boolean
  :param DryRun: 

    When set to **True**, returns the list of change IDs and properties that will be cancelled without actually cancelling the change.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

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

    

    - *(dict) --* 

      Contains the details of the cancelled domain config change.

      
      

      - **DryRun** *(boolean) --* 

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

        
      

      - **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.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`ElasticsearchService.Client.exceptions.BaseException`

  
  *   :py:class:`ElasticsearchService.Client.exceptions.InternalException`

  
  *   :py:class:`ElasticsearchService.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`ElasticsearchService.Client.exceptions.ValidationException`

  
  *   :py:class:`ElasticsearchService.Client.exceptions.DisabledOperationException`

  