:doc:`DirectoryService <../../ds>` / Client / cancel_schema_extension

***********************
cancel_schema_extension
***********************



.. py:method:: DirectoryService.Client.cancel_schema_extension(**kwargs)

  

  Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; ``Initializing``, ``CreatingSnapshot``, and ``UpdatingSchema``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/CancelSchemaExtension>`_  


  **Request Syntax**
  ::

    response = client.cancel_schema_extension(
        DirectoryId='string',
        SchemaExtensionId='string'
    )
    
  :type DirectoryId: string
  :param DirectoryId: **[REQUIRED]** 

    The identifier of the directory whose schema extension will be canceled.

    

  
  :type SchemaExtensionId: string
  :param SchemaExtensionId: **[REQUIRED]** 

    The identifier of the schema extension that will be canceled.

    

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`DirectoryService.Client.exceptions.EntityDoesNotExistException`

  
  *   :py:class:`DirectoryService.Client.exceptions.ClientException`

  
  *   :py:class:`DirectoryService.Client.exceptions.ServiceException`

  