DirectoryService / Paginator / ListSchemaExtensions

ListSchemaExtensions

class DirectoryService.Paginator.ListSchemaExtensions

paginator = client.get_paginator('list_schema_extensions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DirectoryService.Client.list_schema_extensions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DirectoryId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• DirectoryId (string) –

  [REQUIRED]

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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)
        },
    ],

}

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.