createForecastExportJob method

Future<CreateForecastExportJobResponse> createForecastExportJob({ required DataDestination destination, required String forecastArn, required String forecastExportJobName, List<Tag>? tags, })

Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:

<ForecastExportJobName><ExportTimestamp><PartNumber>

where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

For more information, see howitworks-forecast.

To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.

May throw InvalidInputException. May throw ResourceAlreadyExistsException. May throw ResourceNotFoundException. May throw ResourceInUseException. May throw LimitExceededException.

Parameter destination : The location where you want to save the forecast and an AWS 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.

If encryption is used, Destination must include an AWS Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

Parameter forecastArn : The Amazon Resource Name (ARN) of the forecast that you want to export.

Parameter forecastExportJobName : The name for the forecast export job.

Parameter tags : 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.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50.
• For each resource, each tag key must be unique, and each tag key can have only one value.
• Maximum key length - 128 Unicode characters in UTF-8.
• Maximum value length - 256 Unicode characters in UTF-8.
• 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: + - = . _ : / @.
• Tag keys and values are case sensitive.
• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws 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 aws do not count against your tags per resource limit.

Implementation

Future<CreateForecastExportJobResponse> createForecastExportJob({
  required DataDestination destination,
  required String forecastArn,
  required String forecastExportJobName,
  List<Tag>? tags,
}) async {
  ArgumentError.checkNotNull(destination, 'destination');
  ArgumentError.checkNotNull(forecastArn, 'forecastArn');
  _s.validateStringLength(
    'forecastArn',
    forecastArn,
    0,
    256,
    isRequired: true,
  );
  ArgumentError.checkNotNull(forecastExportJobName, 'forecastExportJobName');
  _s.validateStringLength(
    'forecastExportJobName',
    forecastExportJobName,
    1,
    63,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonForecast.CreateForecastExportJob'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Destination': destination,
      'ForecastArn': forecastArn,
      'ForecastExportJobName': forecastExportJobName,
      if (tags != null) 'Tags': tags,
    },
  );

  return CreateForecastExportJobResponse.fromJson(jsonResponse.body);
}