DirectoryService / Paginator / DescribeRegions

DescribeRegions

class DirectoryService.Paginator.DescribeRegions

paginator = client.get_paginator('describe_regions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• DirectoryId (string) –

  [REQUIRED]

  The identifier of the directory.

• RegionName (string) – The name of the Region. For example, us-east-1.

• 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.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'RegionsDescription': [
        {
            'DirectoryId': 'string',
            'RegionName': 'string',
            'RegionType': 'Primary'|'Additional',
            'Status': 'Requested'|'Creating'|'Created'|'Active'|'Inoperable'|'Impaired'|'Restoring'|'RestoreFailed'|'Deleting'|'Deleted'|'Failed',
            'VpcSettings': {
                'VpcId': 'string',
                'SubnetIds': [
                    'string',
                ]
            },
            'DesiredNumberOfDomainControllers': 123,
            'LaunchTime': datetime(2015, 1, 1),
            'StatusLastUpdatedDateTime': datetime(2015, 1, 1),
            'LastUpdatedDateTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • RegionsDescription (list) –

    List of Region information related to the directory for each replicated Region.

    • (dict) –

      The replicated Region information for a directory.

      • DirectoryId (string) –

        The identifier of the directory.

      • RegionName (string) –

        The name of the Region. For example, us-east-1.

      • RegionType (string) –

        Specifies whether the Region is the primary Region or an additional Region.

      • Status (string) –

        The status of the replication process for the specified Region.

      • VpcSettings (dict) –

        Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

        • VpcId (string) –

          The identifier of the VPC in which to create the directory.

        • SubnetIds (list) –

          The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. Directory Service creates a directory server and a DNS server in each of these subnets.

          • (string) –

      • DesiredNumberOfDomainControllers (integer) –

        The desired number of domain controllers in the specified Region for the specified directory.

      • LaunchTime (datetime) –

        Specifies when the Region replication began.

      • StatusLastUpdatedDateTime (datetime) –

        The date and time that the Region status was last updated.

      • LastUpdatedDateTime (datetime) –

        The date and time that the Region description was last updated.