List Regions

ssoadmin_list_regions

R Documentation

Lists all enabled Regions of an IAM Identity Center instance, including those that are being added or removed¶

Description¶

Lists all enabled Regions of an IAM Identity Center instance, including those that are being added or removed. This operation returns Regions with ACTIVE, ADDING, or REMOVING status.

The following actions are related to list_regions:

AddRegion
remove_region
describe_region

Usage¶

ssoadmin_list_regions(InstanceArn, MaxResults, NextToken)

Arguments¶

InstanceArn

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

MaxResults

The maximum number of results to return in a single call. Default is 100.

NextToken

The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Value¶

A list with the following syntax:

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

Request syntax¶

svc$list_regions(
  InstanceArn = "string",
  MaxResults = 123,
  NextToken = "string"
)