CognitoIdentityProvider / Client / list_user_pool_replicas

list_user_pool_replicas

CognitoIdentityProvider.Client.list_user_pool_replicas(**kwargs)

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.

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.list_user_pool_replicas(
    UserPoolId='string',
    NextToken='string'
)
Parameters:

  • UserPoolId (string) –

    [REQUIRED]

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

  • NextToken (string) – A pagination token for retrieving the next page of results. If this parameter is omitted, the operation returns the first page of results.

Return type:

dict

Returns:

Response Syntax

{
    'UserPoolReplicas': [
        {
            'RegionName': 'string',
            'Status': 'CREATING'|'ACTIVE'|'INACTIVE'|'DELETING',
            'Role': 'PRIMARY'|'SECONDARY',
            'UserPoolArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • UserPoolReplicas (list) –

      A list of user pool replicas, including information about their status, role, and Region.

      • (dict) –

        Contains information about a replica user pool, including Region, status, role, and ARN.

        • 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.

    • NextToken (string) –

      A pagination token for retrieving the next page of results. If this value is null, there are no more results to retrieve.

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