Describe Regions

directoryservice_describe_regions

R Documentation

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

Description

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

Usage

directoryservice_describe_regions(DirectoryId, RegionName, NextToken)

Arguments

DirectoryId

[required] The identifier of the directory.

RegionName

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

NextToken

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

Value

A list with the following syntax:

list(
  RegionsDescription = list(
    list(
      DirectoryId = "string",
      RegionName = "string",
      RegionType = "Primary"|"Additional",
      Status = "Requested"|"Creating"|"Created"|"Active"|"Inoperable"|"Impaired"|"Restoring"|"RestoreFailed"|"Deleting"|"Deleted"|"Failed",
      VpcSettings = list(
        VpcId = "string",
        SubnetIds = list(
          "string"
        )
      ),
      DesiredNumberOfDomainControllers = 123,
      LaunchTime = as.POSIXct(
        "2015-01-01"
      ),
      StatusLastUpdatedDateTime = as.POSIXct(
        "2015-01-01"
      ),
      LastUpdatedDateTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_regions(
  DirectoryId = "string",
  RegionName = "string",
  NextToken = "string"
)