AWS Directory Service

Applies a schema extension to a Microsoft AD directory.

Request Syntax

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

type DirectoryId:

string

param DirectoryId:

[REQUIRED]

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

type CreateSnapshotBeforeSchemaExtension:

boolean

param CreateSnapshotBeforeSchemaExtension:

[REQUIRED]

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

type LdifContent:

string

param LdifContent:

[REQUIRED]

The LDIF file represented as a string. The file size can be no larger than 1MB.

type Description:

string

param Description:

[REQUIRED]

A description of the schema extension.

rtype:

dict

returns:

Response Syntax

{
    'SchemaExtensionId': 'string'
}

Response Structure

• (dict) --

  • SchemaExtensionId (string) --

    The identifier of the schema extension that will be applied.

Lists all schema extensions applied to a Microsoft AD Directory.

Request Syntax

client.list_schema_extensions(
    DirectoryId='string',
    NextToken='string',
    Limit=123
)

type DirectoryId:

string

param DirectoryId:

[REQUIRED]

The identifier of the directory from which to retrieve the schema extension information.

type NextToken:

string

param NextToken:

The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions. Pass null if this is the first call.

type Limit:

integer

param Limit:

The maximum number of items to return.

rtype:

dict

returns:

Response Syntax

{
    'SchemaExtensionsInfo': [
        {
            'DirectoryId': 'string',
            'SchemaExtensionId': 'string',
            'Description': 'string',
            'SchemaExtensionStatus': 'Initializing'|'CreatingSnapshot'|'UpdatingSchema'|'Replicating'|'CancelInProgress'|'RollbackInProgress'|'Cancelled'|'Failed'|'Completed',
            'SchemaExtensionStatusReason': 'string',
            'StartDateTime': datetime(2015, 1, 1),
            'EndDateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • SchemaExtensionsInfo (list) --

    Information about the schema extensions applied to the directory.

    • (dict) --

      Information about a schema extension.

      • DirectoryId (string) --

        The identifier of the directory to which the schema extension is applied.

      • SchemaExtensionId (string) --

        The identifier of the schema extension.

      • Description (string) --

        A description of the schema extension.

      • SchemaExtensionStatus (string) --

        The current status of the schema extension.

      • SchemaExtensionStatusReason (string) --

        The reason for the SchemaExtensionStatus.

      • StartDateTime (datetime) --

        The date and time that the schema extension started being applied to the directory.

      • EndDateTime (datetime) --

        The date and time that the schema extension was completed.

  • NextToken (string) --

    If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListSchemaExtensions to retrieve the next set of items.

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.

Request Syntax

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) --