DirectoryService / Client / start_schema_extension

start_schema_extension#

DirectoryService.Client.start_schema_extension(**kwargs)#

Applies a schema extension to a Microsoft AD directory.

See also: AWS API Documentation

Request Syntax

response = client.start_schema_extension(
    DirectoryId='string',
    CreateSnapshotBeforeSchemaExtension=True|False,
    LdifContent='string',
    Description='string'
)
Parameters:

  • DirectoryId (string) –

    [REQUIRED]

    The identifier of the directory for which the schema extension will be applied to.

  • CreateSnapshotBeforeSchemaExtension (boolean) –

    [REQUIRED]

    If true, creates a snapshot of the directory before applying the schema extension.

  • LdifContent (string) –

    [REQUIRED]

    The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with n. See the example request below for more details. The file size can be no larger than 1MB.

  • Description (string) –

    [REQUIRED]

    A description of the schema extension.

Return type:

dict

Returns:

Response Syntax

{
    'SchemaExtensionId': 'string'
}

Response Structure

  • (dict) –

    • SchemaExtensionId (string) –

      The identifier of the schema extension that will be applied.

Exceptions

  • DirectoryService.Client.exceptions.DirectoryUnavailableException

  • DirectoryService.Client.exceptions.EntityDoesNotExistException

  • DirectoryService.Client.exceptions.InvalidParameterException

  • DirectoryService.Client.exceptions.SnapshotLimitExceededException

  • DirectoryService.Client.exceptions.ClientException

  • DirectoryService.Client.exceptions.ServiceException