QuickSight / Client / restore_analysis

restore_analysis#

QuickSight.Client.restore_analysis(**kwargs)#

Restores an analysis.

See also: AWS API Documentation

Request Syntax

response = client.restore_analysis(
    AwsAccountId='string',
    AnalysisId='string',
    RestoreToFolders=True|False
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the analysis.

  • AnalysisId (string) –

    [REQUIRED]

    The ID of the analysis that you’re restoring.

  • RestoreToFolders (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 123,
    'Arn': 'string',
    'AnalysisId': 'string',
    'RequestId': 'string',
    'RestorationFailedFolderArns': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • Status (integer) –

      The HTTP status of the request.

    • Arn (string) –

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

    • AnalysisId (string) –

      The ID of the analysis that you’re restoring.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • RestorationFailedFolderArns (list) –

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

      • (string) –

Exceptions