DirectoryService / Client / describe_regions

describe_regions#

DirectoryService.Client.describe_regions(**kwargs)#

Provides information about the Regions that are configured for multi-Region replication.

See also: AWS API Documentation

Request Syntax

response = client.describe_regions(
    DirectoryId='string',
    RegionName='string',
    NextToken='string'
)
Parameters:

  • DirectoryId (string) –

    [REQUIRED]

    The identifier of the directory.

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

  • NextToken (string) – The DescribeRegionsResult.NextToken value from a previous call to DescribeRegions. Pass null if this is the first call.

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'|'Updating',
            'VpcSettings': {
                'VpcId': 'string',
                'SubnetIds': [
                    'string',
                ]
            },
            'DesiredNumberOfDomainControllers': 123,
            'LaunchTime': datetime(2015, 1, 1),
            'StatusLastUpdatedDateTime': datetime(2015, 1, 1),
            'LastUpdatedDateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

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.

    • NextToken (string) –

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

Exceptions