update_user_pool_replica async ¶

async def update_user_pool_replica(
    self,
    user_pool_id: "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType",
    region_name: "capo_cognito_identity_provider.types.region_name_type.RegionNameType",
    status: "capo_cognito_identity_provider.types.update_replica_status_type.UpdateReplicaStatusType",
    *,
    config_overrides: Optional[AsyncCognitoIdentityProviderClientConfig] = None,
) -> "capo_cognito_identity_provider.types.update_user_pool_replica_response.UpdateUserPoolReplicaResponse":
    """<p>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.</p> <note> <p>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.</p> <p class="title"> <b>Learn more</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a> </p> </li> </ul> </note>

    Args:
        user_pool_id: <p>The ID of the user pool that contains the replica to update.</p>
        region_name: <p>The Amazon Web Services Region of the replica to update.</p>
        status: <p>The status to set for the replica. Valid values are ACTIVE and INACTIVE.</p>

    Raises:
        capo_cognito_identity_provider.errors.internal_error_exception.InternalErrorException: <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
        capo_cognito_identity_provider.errors.invalid_parameter_exception.InvalidParameterException: <p>This exception is thrown when the Amazon Cognito service encounters an invalid parameter.</p>
        capo_cognito_identity_provider.errors.not_authorized_exception.NotAuthorizedException: <p>This exception is thrown when a user isn't authorized.</p>
        capo_cognito_identity_provider.errors.operation_not_enabled_exception.OperationNotEnabledException: <p>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.</p>
        capo_cognito_identity_provider.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when the Amazon Cognito service can't find the requested resource.</p>
        capo_cognito_identity_provider.errors.too_many_requests_exception.TooManyRequestsException: <p>This exception is thrown when the user has made too many requests for a given operation.</p>
        capo_cognito_identity_provider.errors.UnknownServiceError: The service returned an error code this client does not model.

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

        >>> await client.update_user_pool_replica(user_pool_id='ap-south-1_abcd12345', region_name='us-east-1', status='ACTIVE')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cognito_identity_provider.types.update_user_pool_replica_request.UpdateUserPoolReplicaRequest]",
    ) -> AsyncOperationResponse[
        "capo_cognito_identity_provider.types.update_user_pool_replica_response.UpdateUserPoolReplicaResponse"
    ]:
        import capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.update_user_pool_replica

        (
            output,
            http_response,
        ) = await capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.update_user_pool_replica.async_update_user_pool_replica(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateUserPoolReplica")
    )
    input_: capo_cognito_identity_provider.types.update_user_pool_replica_request.UpdateUserPoolReplicaRequest = {
        "user_pool_id": user_pool_id,
        "region_name": region_name,
        "status": status,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output