Describe Region

ssoadmin_describe_region

R Documentation

Retrieves details about a specific Region enabled in an IAM Identity Center instance¶

Description¶

Retrieves details about a specific Region enabled in an IAM Identity Center instance. Details include the Region name, current status (ACTIVE, ADDING, or REMOVING), the date when the Region was added, and whether it is the primary Region. The request must be made from one of the enabled Regions of the IAM Identity Center instance.

The following actions are related to describe_region:

AddRegion
remove_region
list_regions

Usage¶

ssoadmin_describe_region(InstanceArn, RegionName)

Arguments¶

InstanceArn

[required] The Amazon Resource Name (ARN) of the IAM Identity Center instance.

RegionName

[required] The name of the Amazon Web Services Region to retrieve information about. The Region name must be 1-32 characters long and follow the pattern of Amazon Web Services Region names (for example, us-east-1).

Value¶

A list with the following syntax:

list(
  RegionName = "string",
  Status = "ACTIVE"|"ADDING"|"REMOVING",
  AddedDate = as.POSIXct(
    "2015-01-01"
  ),
  IsPrimaryRegion = TRUE|FALSE
)

Request syntax¶

svc$describe_region(
  InstanceArn = "string",
  RegionName = "string"
)