describe_analysis ¶

def describe_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,
) -> "capo_quicksight.types.describe_analysis_response.DescribeAnalysisResponse":
    """<p>Provides a summary of the metadata for an analysis.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.</p>
        analysis_id: <p>The ID of the analysis that you're describing. The ID is part of the URL of the analysis.</p>

    Raises:
        capo_quicksight.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</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.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.describe_analysis_request.DescribeAnalysisRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.describe_analysis_response.DescribeAnalysisResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_analysis

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

    def _redact_output(
        output: "capo_quicksight.types.describe_analysis_response.DescribeAnalysisResponse",
    ) -> dict[str, Any]:
        import capo_quicksight.types.describe_analysis_response

        return capo_quicksight.types.describe_analysis_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeAnalysis", redact_output=_redact_output),
    )
    input_: capo_quicksight.types.describe_analysis_request.DescribeAnalysisRequest = {
        "aws_account_id": aws_account_id,
        "analysis_id": analysis_id,
    }

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