AmazonCognitoIdentityProviderClient.UpdateUserPoolReplica Method (UpdateUserPoolReplicaRequest)

Updates replica-specific settings for a user pool replica. You can modify the status to activate or deactivate the replica. This request can be made in both primary and secondary regions of the user pool.

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

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to UpdateUserPoolReplicaAsync.

Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

public virtual UpdateUserPoolReplicaResponse UpdateUserPoolReplica(
         UpdateUserPoolReplicaRequest request
)

Parameters

request: Type: Amazon.CognitoIdentityProvider.Model.UpdateUserPoolReplicaRequest

Container for the necessary parameters to execute the UpdateUserPoolReplica service method.

Return Value

Type: UpdateUserPoolReplicaResponse

The response from the UpdateUserPoolReplica service method, as returned by CognitoIdentityProvider.

Exceptions

Exception	Condition
InternalErrorException	This exception is thrown when Amazon Cognito encounters an internal error.
InvalidParameterException	This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException	This exception is thrown when a user isn't authorized.
OperationNotEnabledException	This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.
ResourceNotFoundException	This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException	This exception is thrown when the user has made too many requests for a given operation.

Examples

The following example sets the status of a user pool replica in the us-east-1 Region to ACTIVE.

Example update a user pool replica


var client = new AmazonCognitoIdentityProviderClient();
var response = client.UpdateUserPoolReplica(new UpdateUserPoolReplicaRequest 
{
    RegionName = "us-east-1",
    Status = "ACTIVE",
    UserPoolId = "ap-south-1_abcd12345"
});

UserPoolReplicaType userPoolReplica = response.UserPoolReplica;

Version Information

.NET Framework:
Supported in: 4.7.2 and newer

AmazonCognitoIdentityProviderClient.UpdateUserPoolReplica (UpdateUserPoolReplicaRequest)

Method