You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ForecastService::Types::CreateForecastExportJobRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ForecastService::Types::CreateForecastExportJobRequest
- Defined in:
- (unknown)
Overview
When passing CreateForecastExportJobRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
forecast_export_job_name: "Name", # required
forecast_arn: "Arn", # required
destination: { # required
s3_config: { # required
path: "S3Path", # required
role_arn: "Arn", # required
kms_key_arn: "KMSKeyArn",
},
},
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
}
Instance Attribute Summary collapse
-
#destination ⇒ Types::DataDestination
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.
-
#forecast_arn ⇒ String
The Amazon Resource Name (ARN) of the forecast that you want to export.
-
#forecast_export_job_name ⇒ String
The name for the forecast export job.
-
#tags ⇒ Array<Types::Tag>
The optional metadata that you apply to the forecast export job to help you categorize and organize them.
Instance Attribute Details
#destination ⇒ Types::DataDestination
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.
#forecast_arn ⇒ String
The Amazon Resource Name (ARN) of the forecast that you want to export.
#forecast_export_job_name ⇒ String
The name for the forecast export job.
#tags ⇒ Array<Types::Tag>
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 hasaws
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 ofaws
do not count against your tags per resource limit.