DirectoryService / Client / cancel_schema_extension

cancel_schema_extension#

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

Request Syntax

response = client.cancel_schema_extension(
    DirectoryId='string',
    SchemaExtensionId='string'
)
Parameters:

  • DirectoryId (string) –

    [REQUIRED]

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

  • SchemaExtensionId (string) –

    [REQUIRED]

    The identifier of the schema extension that will be canceled.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • DirectoryService.Client.exceptions.EntityDoesNotExistException

  • DirectoryService.Client.exceptions.ClientException

  • DirectoryService.Client.exceptions.ServiceException