:doc:`QuickSight <../../quicksight>` / Client / restore_analysis

****************
restore_analysis
****************



.. py:method:: QuickSight.Client.restore_analysis(**kwargs)

  

  Restores an analysis.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RestoreAnalysis>`_  


  **Request Syntax**
  ::

    response = client.restore_analysis(
        AwsAccountId='string',
        AnalysisId='string',
        RestoreToFolders=True|False
    )
    
  :type AwsAccountId: string
  :param AwsAccountId: **[REQUIRED]** 

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

    

  
  :type AnalysisId: string
  :param AnalysisId: **[REQUIRED]** 

    The ID of the analysis that you're restoring.

    

  
  :type RestoreToFolders: boolean
  :param 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``.

    

  
  
  :rtype: 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**
  
  *   :py:class:`QuickSight.Client.exceptions.ThrottlingException`

  
  *   :py:class:`QuickSight.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`QuickSight.Client.exceptions.ConflictException`

  
  *   :py:class:`QuickSight.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`QuickSight.Client.exceptions.UnsupportedUserEditionException`

  
  *   :py:class:`QuickSight.Client.exceptions.LimitExceededException`

  
  *   :py:class:`QuickSight.Client.exceptions.PreconditionNotMetException`

  
  *   :py:class:`QuickSight.Client.exceptions.InternalFailureException`

  