list_schema_extensions

DirectoryService.Client.list_schema_extensions(**kwargs)

Lists all schema extensions applied to a Microsoft AD Directory.

See also: AWS API Documentation

Request Syntax

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

Parameters

• DirectoryId (string) --

  [REQUIRED]

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

• NextToken (string) -- The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions . Pass null if this is the first call.
• Limit (integer) -- The maximum number of items to return.

Return type

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.

Exceptions

• DirectoryService.Client.exceptions.InvalidNextTokenException
• DirectoryService.Client.exceptions.EntityDoesNotExistException
• DirectoryService.Client.exceptions.ClientException
• DirectoryService.Client.exceptions.ServiceException