describe_forecast ¶

describe_forecast(
    forecast_arn: Arn, *, config_overrides: Optional[forecastClientConfig] = None
) -> DescribeForecastResponse

Describes a forecast created using the CreateForecast operation.

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

DatasetGroupArn - The dataset group that provided the training data.
CreationTime
LastModificationTime
Status
Message - If an error occurred, information about the error.

Parameters:

forecast_arn (Arn) –

The Amazon Resource Name (ARN) of the forecast.

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/forecast.py

def describe_forecast(
    self,
    forecast_arn: "capo_forecast.types.arn.Arn",
    *,
    config_overrides: Optional[forecastClientConfig] = None,
) -> "capo_forecast.types.describe_forecast_response.DescribeForecastResponse":
    """<p>Describes a forecast created using the <a>CreateForecast</a> operation.</p> <p>In addition to listing the properties provided in the <code>CreateForecast</code> request, this operation lists the following properties:</p> <ul> <li> <p> <code>DatasetGroupArn</code> - The dataset group that provided the training data.</p> </li> <li> <p> <code>CreationTime</code> </p> </li> <li> <p> <code>LastModificationTime</code> </p> </li> <li> <p> <code>Status</code> </p> </li> <li> <p> <code>Message</code> - If an error occurred, information about the error.</p> </li> </ul>

    Args:
        forecast_arn: <p>The Amazon Resource Name (ARN) of the forecast.</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.
    """

    def _handler(
        req: "OperationRequest[capo_forecast.types.describe_forecast_request.DescribeForecastRequest]",
    ) -> OperationResponse[
        "capo_forecast.types.describe_forecast_response.DescribeForecastResponse"
    ]:
        import capo_forecast._operations.amazon_forecast.describe_forecast

        output, http_response = (
            capo_forecast._operations.amazon_forecast.describe_forecast.describe_forecast(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeForecast")
    )
    input_: capo_forecast.types.describe_forecast_request.DescribeForecastRequest = {
        "forecast_arn": forecast_arn
    }

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