CognitoIdentityProvider / Client / update_user_pool_replica

update_user_pool_replica

CognitoIdentityProvider.Client.update_user_pool_replica(**kwargs)

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.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.update_user_pool_replica(
    UserPoolId='string',
    RegionName='string',
    Status='ACTIVE'|'INACTIVE'
)
Parameters:

  • UserPoolId (string) –

    [REQUIRED]

    The ID of the user pool that contains the replica to update.

  • RegionName (string) –

    [REQUIRED]

    The Amazon Web Services Region of the replica to update.

  • Status (string) –

    [REQUIRED]

    The status to set for the replica. Valid values are ACTIVE and INACTIVE.

Return type:

dict

Returns:

Response Syntax

{
    'UserPoolReplica': {
        'RegionName': 'string',
        'Status': 'CREATING'|'ACTIVE'|'INACTIVE'|'DELETING',
        'Role': 'PRIMARY'|'SECONDARY',
        'UserPoolArn': 'string'
    }
}

Response Structure

  • (dict) –

    • UserPoolReplica (dict) –

      Information about the updated user pool replica.

      • RegionName (string) –

        The Amazon Web Services Region where the replica is located.

      • Status (string) –

        The current status of the replica.

        CREATING

        The replica is being created.

        INACTIVE

        The replica has been created, but is not accepting requests for end-users. Administrator configuration operations are supported.

        ACTIVE

        The replica is available for both end-user and administrator operations.

        DELETING

        The replica is being deleted.

      • Role (string) –

        The role of the user pool replica that determines which API operations are enabled.

        PRIMARY

        The primary replica supports all end user and administrator operations.

        SECONDARY

        The secondary replica supports a limited set of end user and administrator operations. Generally, only administrator operations that set configurations specific to the replica, and only end-user operations that do not create or change attributes of a user are supported.

      • UserPoolArn (string) –

        The Amazon Resource Name (ARN) of the replica user pool.

Exceptions

  • CognitoIdentityProvider.Client.exceptions.InvalidParameterException

  • CognitoIdentityProvider.Client.exceptions.TooManyRequestsException

  • CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

  • CognitoIdentityProvider.Client.exceptions.OperationNotEnabledException

  • CognitoIdentityProvider.Client.exceptions.InternalErrorException

  • CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException