Lists all replicas for a user pool, including both primary and secondary replicas¶

Description¶

Lists all replicas for a user pool, including both primary and secondary replicas. We recommend using pagination to ensure that the operation returns quickly and successfully.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests
• Using the Amazon Cognito user pools API and user pool endpoints

Usage¶

cognitoidentityprovider_list_user_pool_replicas(UserPoolId, NextToken)

Arguments¶

• UserPoolId

[required] The ID of the user pool for which to list replicas.

• NextToken

A pagination token for retrieving the next page of results. If this parameter is omitted, the operation returns the first page of results.

Value¶

A list with the following syntax:

list(
  UserPoolReplicas = list(
    list(
      RegionName = "string",
      Status = "CREATING"|"ACTIVE"|"INACTIVE"|"DELETING",
      Role = "PRIMARY"|"SECONDARY",
      UserPoolArn = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_user_pool_replicas(
  UserPoolId = "string",
  NextToken = "string"
)