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

DescribePointInTimeRecovery

Returns details about a point-in-time recovery of a user pool, including its status and the point in time that it restores the user pool to. After Amazon Cognito generates the recovery preview, the response also includes the number of entities that the recovery creates, updates, and deletes. Review the preview before you apply the recovery with a StartPointInTimeRecovery request or discard it with a CancelPointInTimeRecovery request.

Note

Amazon Cognito evaluates AWS 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.

Request Syntax

{ "RestoreId": "string", "UserPoolId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

RestoreId

The ID of the recovery that you want to describe. Amazon Cognito returns this ID in the response to an InitiatePointInTimeRecovery request.

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: Yes

UserPoolId

The ID of the user pool that contains the recovery that you want to describe.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: [\w-]+_[0-9a-zA-Z]+

Required: Yes

Response Syntax

{ "Restoration": { "RestoreId": "string", "RestorePreview": [ { "CreateCount": number, "DeleteCount": number, "Entity": "string", "UpdateCount": number } ], "RestoreStatus": "string", "RestoreTimestamp": number, "TriggerTimestamp": number } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Restoration

The details of the requested recovery, including its status, the point in time that it restores the user pool to, and the recovery preview.

Type: RestorationType object

Errors

For information about the errors that are common to all actions, see Common Error Types.

FeatureUnavailableInTierException

This exception is thrown when a feature that you attempted to use or configure isn't included in your user pool's current feature plan. This can occur when:

  • You configure a feature that your feature plan doesn't support.

  • You make a request that uses a feature that requires a higher feature plan.

To resolve this issue, upgrade your user pool to a feature plan that includes the feature.

HTTP Status Code: 400

InternalErrorException

This exception is thrown when Amazon Cognito encounters an internal error.

message

The message returned when Amazon Cognito throws an internal error exception.

HTTP Status Code: 500

InvalidParameterException

This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

message

The message returned when the Amazon Cognito service throws an invalid parameter exception.

reasonCode

The reason code of the exception.

HTTP Status Code: 400

NotAuthorizedException

This exception is thrown when a user isn't authorized.

message

The message returned when the Amazon Cognito service returns a not authorized exception.

HTTP Status Code: 400

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.

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when the Amazon Cognito service can't find the requested resource.

message

The message returned when the Amazon Cognito service returns a resource not found exception.

HTTP Status Code: 400

TooManyRequestsException

This exception is thrown when the user has made too many requests for a given operation.

message

The message returned when the Amazon Cognito service returns a too many requests exception.

HTTP Status Code: 400

Examples

Example

The following example request describes a point-in-time recovery after Amazon Cognito generated the recovery preview. If you apply this recovery, Amazon Cognito re-creates 12 users that were deleted after the recovery point, reverts 40 users to their state at the recovery point, and deletes 3 users that were created after the recovery point. The preview also shows the changes that the recovery makes to groups, user MFA settings, and passkeys.

Sample Request

POST HTTP/1.1 Host: cognito-idp.us-west-2.amazonaws.com X-Amz-Date: 20230613T200059Z Accept-Encoding: gzip, deflate, br X-Amz-Target: AWSCognitoIdentityProviderService.DescribePointInTimeRecovery User-Agent: <UserAgentString> Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature> Content-Length: <PayloadSizeBytes> { "RestoreId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "UserPoolId": "us-east-1_EXAMPLE" }

Sample Response

HTTP/1.1 200 OK Date: Tue, 13 Jun 2023 20:00:59 GMT Content-Type: application/x-amz-json-1.0 Content-Length: <PayloadSizeBytes> x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111 Connection: keep-alive { "Restoration": { "RestoreId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "RestorePreview": [ { "CreateCount": 12, "DeleteCount": 3, "Entity": "Users", "UpdateCount": 40 }, { "CreateCount": 1, "DeleteCount": 0, "Entity": "Groups", "UpdateCount": 2 }, { "CreateCount": 10, "DeleteCount": 2, "Entity": "User MFAs", "UpdateCount": 5 }, { "CreateCount": 4, "DeleteCount": 1, "Entity": "Passkeys", "UpdateCount": 0 } ], "RestoreStatus": "PREVIEW_GENERATED", "RestoreTimestamp": 1791374400, "TriggerTimestamp": 1791473400 } }

See Also

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