restore_analysis ¶

def restore_analysis(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    analysis_id: "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    restore_to_folders: Optional["capo_quicksight.types.boolean.Boolean"] = None,
) -> "capo_quicksight.types.restore_analysis_response.RestoreAnalysisResponse":
    """<p>Restores an analysis.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the analysis.</p>
        analysis_id: <p>The ID of the analysis that you're restoring.</p>
        restore_to_folders: <p>A boolean value that determines if the analysis will be restored to folders that it previously resided in. A <code>True</code> value restores analysis back to all folders that it previously resided in. A <code>False</code> 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 <code>True</code>.</p>

    Raises:
        capo_quicksight.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more parameters has a value that isn't valid.</p>
        capo_quicksight.errors.limit_exceeded_exception.LimitExceededException: <p>A limit is exceeded.</p>
        capo_quicksight.errors.precondition_not_met_exception.PreconditionNotMetException: <p>One or more preconditions aren't met.</p>
        capo_quicksight.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_quicksight.errors.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.unsupported_user_edition_exception.UnsupportedUserEditionException: <p>This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.restore_analysis_request.RestoreAnalysisRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.restore_analysis_response.RestoreAnalysisResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.restore_analysis

        output, http_response = (
            capo_quicksight._operations.quick_sight_20180401.restore_analysis.restore_analysis(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RestoreAnalysis")
    )
    input_: capo_quicksight.types.restore_analysis_request.RestoreAnalysisRequest = {
        "aws_account_id": aws_account_id,
        "analysis_id": analysis_id,
    }
    if restore_to_folders is not None:
        input_["restore_to_folders"] = restore_to_folders

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output