describe_what_if_analysis `async` ¶

describe_what_if_analysis(
    what_if_analysis_arn: Arn,
    *,
    config_overrides: Optional[AsyncforecastClientConfig] = None,
) -> DescribeWhatIfAnalysisResponse

Describes the what-if analysis created using the CreateWhatIfAnalysis operation.

In addition to listing the properties provided in the CreateWhatIfAnalysis request, this operation lists the following properties:

CreationTime
LastModificationTime
Message - If an error occurred, information about the error.
Status

Parameters:

what_if_analysis_arn (Arn) –

The Amazon Resource Name (ARN) of the what-if analysis that you are interested in.

Raises:

InvalidInputException –

We can't process the request because it includes an invalid value or a value that exceeds the valid range.
ResourceNotFoundException –

We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_forecast/_services/async_forecast.py

async def describe_what_if_analysis(
    self,
    what_if_analysis_arn: "capo_forecast.types.arn.Arn",
    *,
    config_overrides: Optional[AsyncforecastClientConfig] = None,
) -> "capo_forecast.types.describe_what_if_analysis_response.DescribeWhatIfAnalysisResponse":
    """<p>Describes the what-if analysis created using the <a>CreateWhatIfAnalysis</a> operation.</p> <p>In addition to listing the properties provided in the <code>CreateWhatIfAnalysis</code> request, this operation lists the following properties:</p> <ul> <li> <p> <code>CreationTime</code> </p> </li> <li> <p> <code>LastModificationTime</code> </p> </li> <li> <p> <code>Message</code> - If an error occurred, information about the error.</p> </li> <li> <p> <code>Status</code> </p> </li> </ul>

    Args:
        what_if_analysis_arn: <p>The Amazon Resource Name (ARN) of the what-if analysis that you are interested in.</p>

    Raises:
        capo_forecast.errors.invalid_input_exception.InvalidInputException: <p>We can't process the request because it includes an invalid value or a value that exceeds the valid range.</p>
        capo_forecast.errors.resource_not_found_exception.ResourceNotFoundException: <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.</p>
        capo_forecast.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_forecast.types.describe_what_if_analysis_request.DescribeWhatIfAnalysisRequest]",
    ) -> AsyncOperationResponse[
        "capo_forecast.types.describe_what_if_analysis_response.DescribeWhatIfAnalysisResponse"
    ]:
        import capo_forecast._operations.amazon_forecast.describe_what_if_analysis

        (
            output,
            http_response,
        ) = await capo_forecast._operations.amazon_forecast.describe_what_if_analysis.async_describe_what_if_analysis(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeWhatIfAnalysis")
    )
    input_: capo_forecast.types.describe_what_if_analysis_request.DescribeWhatIfAnalysisRequest = {
        "what_if_analysis_arn": what_if_analysis_arn
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_what_if_analysis async ¶

describe_what_if_analysis `async` ¶