Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

RestoreAnalysis

Restores an analysis.

Request Syntax


POST /accounts/AwsAccountId/restore/analyses/AnalysisId?restore-to-folders=RestoreToFolders HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AnalysisId

The ID of the analysis that you're restoring.

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

Pattern: [\w\-]+

Required: Yes

AwsAccountId

The ID of the AWS account that contains the analysis.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

RestoreToFolders

A boolean value that determines if the analysis will be restored to folders that it previously resided in. A True value restores analysis back to all folders that it previously resided in. A False value restores the analysis but does not restore the analysis back to all previously resided folders. Restoring a restricted analysis requires this parameter to be set to True.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "AnalysisId": "string",
   "Arn": "string",
   "RequestId": "string",
   "RestorationFailedFolderArns": [ "string" ]
}

Response Elements

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

Status: The HTTP status of the request.

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

AnalysisId

The ID of the analysis that you're restoring.

Type: String

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

Pattern: [\w\-]+

Arn

The Amazon Resource Name (ARN) of the analysis that you're restoring.

Type: String

RequestId

The AWS request ID for this operation.

Type: String

RestorationFailedFolderArns

A list of folder arns thatthe analysis failed to be restored to.

Type: Array of strings

Array Members: Maximum number of 1 item.

Errors

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

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

LimitExceededException

A limit is exceeded.

HTTP Status Code: 409

PreconditionNotMetException

One or more preconditions aren't met.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

HTTP Status Code: 429

UnsupportedUserEditionException

This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

HTTP Status Code: 403