create_forecast_export_job async ¶

async def create_forecast_export_job(
    self,
    forecast_export_job_name: "capo_forecast.types.name.Name",
    forecast_arn: "capo_forecast.types.arn.Arn",
    destination: "capo_forecast.types.data_destination.DataDestination",
    *,
    config_overrides: Optional[AsyncforecastClientConfig] = None,
    tags: Optional["capo_forecast.types.tags.Tags"] = None,
    format: Optional["capo_forecast.types.format.Format"] = None,
) -> "capo_forecast.types.create_forecast_export_job_response.CreateForecastExportJobResponse":
    """<p>Exports a forecast created by the <a>CreateForecast</a> operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:</p> <p><ForecastExportJobName>_<ExportTimestamp>_<PartNumber></p> <p>where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).</p> <p>You must specify a <a>DataDestination</a> object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see <a>aws-forecast-iam-roles</a>.</p> <p>For more information, see <a>howitworks-forecast</a>.</p> <p>To get a list of all your forecast export jobs, use the <a>ListForecastExportJobs</a> operation.</p> <note> <p>The <code>Status</code> of the forecast export job must be <code>ACTIVE</code> before you can access the forecast in your Amazon S3 bucket. To get the status, use the <a>DescribeForecastExportJob</a> operation.</p> </note>

    Args:
        forecast_export_job_name: <p>The name for the forecast export job.</p>
        forecast_arn: <p>The Amazon Resource Name (ARN) of the forecast that you want to export.</p>
        destination: <p>The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.</p> <p>If encryption is used, <code>Destination</code> must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.</p>
        tags: <p>The optional metadata that you apply to the forecast export job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do not count against your tags per resource limit.</p> </li> </ul>
        format: <p>The format of the exported data, CSV or PARQUET. The default value is CSV.</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.limit_exceeded_exception.LimitExceededException: <p>The limit on the number of resources per account has been exceeded.</p>
        capo_forecast.errors.resource_already_exists_exception.ResourceAlreadyExistsException: <p>There is already a resource with this name. Try again with a different name.</p>
        capo_forecast.errors.resource_in_use_exception.ResourceInUseException: <p>The specified resource is in use.</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.create_forecast_export_job_request.CreateForecastExportJobRequest]",
    ) -> AsyncOperationResponse[
        "capo_forecast.types.create_forecast_export_job_response.CreateForecastExportJobResponse"
    ]:
        import capo_forecast._operations.amazon_forecast.create_forecast_export_job

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

    def _redact_input(
        input_: "capo_forecast.types.create_forecast_export_job_request.CreateForecastExportJobRequest",
    ) -> dict[str, Any]:
        import capo_forecast.types.create_forecast_export_job_request

        return (
            capo_forecast.types.create_forecast_export_job_request.redact_sensitive(
                input_
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateForecastExportJob", redact_input=_redact_input),
    )
    input_: capo_forecast.types.create_forecast_export_job_request.CreateForecastExportJobRequest = {
        "forecast_export_job_name": forecast_export_job_name,
        "forecast_arn": forecast_arn,
        "destination": destination,
    }
    if tags is not None:
        input_["tags"] = tags
    if format is not None:
        input_["format"] = format

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