Container for the parameters to the ListUserPoolReplicas operation. 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
In this article ▶
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
Amazon.CognitoIdentityProvider.Model.ListUserPoolReplicasRequest
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
Syntax
public class ListUserPoolReplicasRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The ListUserPoolReplicasRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListUserPoolReplicasRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
NextToken | System.String |
Gets and sets the property NextToken. A pagination token for retrieving the next page of results. If this parameter is omitted, the operation returns the first page of results. |
|
|
UserPoolId | System.String |
Gets and sets the property UserPoolId. The ID of the user pool for which to list replicas. |
Examples
The following example lists the replicas of a user pool that has a replica in the ap-south-1 Region.
Example list the replicas of a user pool
var client = new AmazonCognitoIdentityProviderClient();
var response = client.ListUserPoolReplicas(new ListUserPoolReplicasRequest
{
UserPoolId = "eu-north-1_abcd12345"
});
List<UserPoolReplicaType> userPoolReplicas = response.UserPoolReplicas;
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer