RestorationType - Amazon Cognito User Pools
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

RestorationType

The details of a point-in-time recovery of a user pool.

This data type is a response parameter of InitiatePointInTimeRecovery, DescribePointInTimeRecovery, StartPointInTimeRecovery, and CancelPointInTimeRecovery.

Contents

RestoreId

The ID of the recovery. Use this ID in requests to describe, start, or cancel the recovery.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}$

Required: No

RestorePreview

The recovery preview. For each type of entity, the preview shows the number of entities that the recovery creates, updates, and deletes. The preview doesn't include user data. Amazon Cognito returns the preview when it's available.

Type: Array of RestorePreviewType objects

Required: No

RestoreStatus

The status of the recovery. Can be one of the following values.

PREVIEW_GENERATING

Amazon Cognito is generating the recovery preview, which might not be available immediately. Write operations in the user pool are paused.

PREVIEW_GENERATED

The recovery preview is ready for review. Write operations in the user pool are paused. Within 24 hours after you initiate the recovery, apply it with a StartPointInTimeRecovery request or discard it with a CancelPointInTimeRecovery request.

PREVIEW_CANCELLED

You canceled the recovery. Amazon Cognito resumed write operations and didn't change your user pool data.

PREVIEW_GENERATION_FAILED

Amazon Cognito couldn't generate the recovery preview. Amazon Cognito resumed write operations and didn't change your user pool data. You can initiate a new recovery.

PREVIEW_EXPIRED

You didn't start or cancel the recovery within 24 hours after you initiated it. Amazon Cognito resumed write operations and didn't change your user pool data.

RESTORING

Amazon Cognito is restoring user data in the user pool to its state at the recovery point. Write operations in the user pool are paused.

RESTORE_COMPLETED

Amazon Cognito restored your user pool to its state at the recovery point and resumed write operations.

TEMPORARY_INTERNAL_ERROR_SEE_SUPPORT_CASE

The recovery encountered an internal error. Write operations in the user pool remain paused. AWS Support contacts you through a support case to resolve the issue.

AWS_ABORTED

Amazon Cognito stopped the recovery because of an internal failure. Write operations in the user pool remain paused, and you can't cancel or retry the recovery. AWS Support contacts you through a support case to resolve the issue.

Type: String

Valid Values: PREVIEW_GENERATING | PREVIEW_GENERATED | PREVIEW_CANCELLED | PREVIEW_GENERATION_FAILED | PREVIEW_EXPIRED | RESTORING | RESTORE_COMPLETED | TEMPORARY_INTERNAL_ERROR_SEE_SUPPORT_CASE | AWS_ABORTED

Required: No

RestoreTimestamp

The point in time that the recovery restores the user pool to.

Type: Timestamp

Required: No

TriggerTimestamp

The end of the period of changes that the recovery reverts. This time is shortly after the time that you initiated the recovery. The recovery reverts changes to user data that occurred between RestoreTimestamp and TriggerTimestamp.

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: