AWS SDK for C++  1.9.108
AWS SDK for C++
Public Member Functions | List of all members
Aws::ForecastService::Model::CreateDatasetImportJobRequest Class Reference

#include <CreateDatasetImportJobRequest.h>

+ Inheritance diagram for Aws::ForecastService::Model::CreateDatasetImportJobRequest:

Public Member Functions

 CreateDatasetImportJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetDatasetImportJobName () const
 
bool DatasetImportJobNameHasBeenSet () const
 
void SetDatasetImportJobName (const Aws::String &value)
 
void SetDatasetImportJobName (Aws::String &&value)
 
void SetDatasetImportJobName (const char *value)
 
CreateDatasetImportJobRequestWithDatasetImportJobName (const Aws::String &value)
 
CreateDatasetImportJobRequestWithDatasetImportJobName (Aws::String &&value)
 
CreateDatasetImportJobRequestWithDatasetImportJobName (const char *value)
 
const Aws::StringGetDatasetArn () const
 
bool DatasetArnHasBeenSet () const
 
void SetDatasetArn (const Aws::String &value)
 
void SetDatasetArn (Aws::String &&value)
 
void SetDatasetArn (const char *value)
 
CreateDatasetImportJobRequestWithDatasetArn (const Aws::String &value)
 
CreateDatasetImportJobRequestWithDatasetArn (Aws::String &&value)
 
CreateDatasetImportJobRequestWithDatasetArn (const char *value)
 
const DataSourceGetDataSource () const
 
bool DataSourceHasBeenSet () const
 
void SetDataSource (const DataSource &value)
 
void SetDataSource (DataSource &&value)
 
CreateDatasetImportJobRequestWithDataSource (const DataSource &value)
 
CreateDatasetImportJobRequestWithDataSource (DataSource &&value)
 
const Aws::StringGetTimestampFormat () const
 
bool TimestampFormatHasBeenSet () const
 
void SetTimestampFormat (const Aws::String &value)
 
void SetTimestampFormat (Aws::String &&value)
 
void SetTimestampFormat (const char *value)
 
CreateDatasetImportJobRequestWithTimestampFormat (const Aws::String &value)
 
CreateDatasetImportJobRequestWithTimestampFormat (Aws::String &&value)
 
CreateDatasetImportJobRequestWithTimestampFormat (const char *value)
 
const Aws::StringGetTimeZone () const
 
bool TimeZoneHasBeenSet () const
 
void SetTimeZone (const Aws::String &value)
 
void SetTimeZone (Aws::String &&value)
 
void SetTimeZone (const char *value)
 
CreateDatasetImportJobRequestWithTimeZone (const Aws::String &value)
 
CreateDatasetImportJobRequestWithTimeZone (Aws::String &&value)
 
CreateDatasetImportJobRequestWithTimeZone (const char *value)
 
bool GetUseGeolocationForTimeZone () const
 
bool UseGeolocationForTimeZoneHasBeenSet () const
 
void SetUseGeolocationForTimeZone (bool value)
 
CreateDatasetImportJobRequestWithUseGeolocationForTimeZone (bool value)
 
const Aws::StringGetGeolocationFormat () const
 
bool GeolocationFormatHasBeenSet () const
 
void SetGeolocationFormat (const Aws::String &value)
 
void SetGeolocationFormat (Aws::String &&value)
 
void SetGeolocationFormat (const char *value)
 
CreateDatasetImportJobRequestWithGeolocationFormat (const Aws::String &value)
 
CreateDatasetImportJobRequestWithGeolocationFormat (Aws::String &&value)
 
CreateDatasetImportJobRequestWithGeolocationFormat (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateDatasetImportJobRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateDatasetImportJobRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateDatasetImportJobRequestAddTags (const Tag &value)
 
CreateDatasetImportJobRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::ForecastService::ForecastServiceRequest
virtual ~ForecastServiceRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file CreateDatasetImportJobRequest.h.

Constructor & Destructor Documentation

◆ CreateDatasetImportJobRequest()

Aws::ForecastService::Model::CreateDatasetImportJobRequest::CreateDatasetImportJobRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::AddTags ( const Tag value)
inline

The optional metadata that you apply to the dataset import 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.

Definition at line 650 of file CreateDatasetImportJobRequest.h.

◆ AddTags() [2/2]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::AddTags ( Tag &&  value)
inline

The optional metadata that you apply to the dataset import 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.

Definition at line 673 of file CreateDatasetImportJobRequest.h.

◆ DatasetArnHasBeenSet()

bool Aws::ForecastService::Model::CreateDatasetImportJobRequest::DatasetArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.

Definition at line 115 of file CreateDatasetImportJobRequest.h.

◆ DatasetImportJobNameHasBeenSet()

bool Aws::ForecastService::Model::CreateDatasetImportJobRequest::DatasetImportJobNameHasBeenSet ( ) const
inline

The name for the dataset import job. We recommend including the current timestamp in the name, for example, 20190721DatasetImport. This can help you avoid getting a ResourceAlreadyExistsException exception.

Definition at line 54 of file CreateDatasetImportJobRequest.h.

◆ DataSourceHasBeenSet()

bool Aws::ForecastService::Model::CreateDatasetImportJobRequest::DataSourceHasBeenSet ( ) const
inline

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.

If encryption is used, DataSource must include an AWS Key Management Service (KMS) key and the IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match those specified in the EncryptionConfig parameter of the CreateDataset operation.

Definition at line 176 of file CreateDatasetImportJobRequest.h.

◆ GeolocationFormatHasBeenSet()

bool Aws::ForecastService::Model::CreateDatasetImportJobRequest::GeolocationFormatHasBeenSet ( ) const
inline

The format of the geolocation attribute. The geolocation attribute can be formatted in one of two ways:

  • LAT_LONG - the latitude and longitude in decimal format (Example: 47.61_-122.33).

  • CC_POSTALCODE (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).

Definition at line 434 of file CreateDatasetImportJobRequest.h.

◆ GetDatasetArn()

const Aws::String& Aws::ForecastService::Model::CreateDatasetImportJobRequest::GetDatasetArn ( ) const
inline

The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.

Definition at line 109 of file CreateDatasetImportJobRequest.h.

◆ GetDatasetImportJobName()

const Aws::String& Aws::ForecastService::Model::CreateDatasetImportJobRequest::GetDatasetImportJobName ( ) const
inline

The name for the dataset import job. We recommend including the current timestamp in the name, for example, 20190721DatasetImport. This can help you avoid getting a ResourceAlreadyExistsException exception.

Definition at line 46 of file CreateDatasetImportJobRequest.h.

◆ GetDataSource()

const DataSource& Aws::ForecastService::Model::CreateDatasetImportJobRequest::GetDataSource ( ) const
inline

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.

If encryption is used, DataSource must include an AWS Key Management Service (KMS) key and the IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match those specified in the EncryptionConfig parameter of the CreateDataset operation.

Definition at line 164 of file CreateDatasetImportJobRequest.h.

◆ GetGeolocationFormat()

const Aws::String& Aws::ForecastService::Model::CreateDatasetImportJobRequest::GetGeolocationFormat ( ) const
inline

The format of the geolocation attribute. The geolocation attribute can be formatted in one of two ways:

  • LAT_LONG - the latitude and longitude in decimal format (Example: 47.61_-122.33).

  • CC_POSTALCODE (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).

Definition at line 425 of file CreateDatasetImportJobRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::ForecastService::Model::CreateDatasetImportJobRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::ForecastService::Model::CreateDatasetImportJobRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file CreateDatasetImportJobRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::ForecastService::Model::CreateDatasetImportJobRequest::GetTags ( ) const
inline

The optional metadata that you apply to the dataset import 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.

Definition at line 512 of file CreateDatasetImportJobRequest.h.

◆ GetTimestampFormat()

const Aws::String& Aws::ForecastService::Model::CreateDatasetImportJobRequest::GetTimestampFormat ( ) const
inline

The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

  • "yyyy-MM-dd"

    For the following data frequencies: Y, M, W, and D

  • "yyyy-MM-dd HH:mm:ss"

    For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".

Definition at line 236 of file CreateDatasetImportJobRequest.h.

◆ GetTimeZone()

const Aws::String& Aws::ForecastService::Model::CreateDatasetImportJobRequest::GetTimeZone ( ) const
inline

A single time zone for every item in your dataset. This option is ideal for datasets with all timestamps within a single time zone, or if all timestamps are normalized to a single time zone.

Refer to the Joda-Time API for a complete list of valid time zone names.

Definition at line 323 of file CreateDatasetImportJobRequest.h.

◆ GetUseGeolocationForTimeZone()

bool Aws::ForecastService::Model::CreateDatasetImportJobRequest::GetUseGeolocationForTimeZone ( ) const
inline

Automatically derive time zone information from the geolocation attribute. This option is ideal for datasets that contain timestamps in multiple time zones and those timestamps are expressed in local time.

Definition at line 394 of file CreateDatasetImportJobRequest.h.

◆ SerializePayload()

Aws::String Aws::ForecastService::Model::CreateDatasetImportJobRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDatasetArn() [1/3]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetDatasetArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.

Definition at line 127 of file CreateDatasetImportJobRequest.h.

◆ SetDatasetArn() [2/3]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetDatasetArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.

Definition at line 121 of file CreateDatasetImportJobRequest.h.

◆ SetDatasetArn() [3/3]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetDatasetArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.

Definition at line 133 of file CreateDatasetImportJobRequest.h.

◆ SetDatasetImportJobName() [1/3]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetDatasetImportJobName ( Aws::String &&  value)
inline

The name for the dataset import job. We recommend including the current timestamp in the name, for example, 20190721DatasetImport. This can help you avoid getting a ResourceAlreadyExistsException exception.

Definition at line 70 of file CreateDatasetImportJobRequest.h.

◆ SetDatasetImportJobName() [2/3]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetDatasetImportJobName ( const Aws::String value)
inline

The name for the dataset import job. We recommend including the current timestamp in the name, for example, 20190721DatasetImport. This can help you avoid getting a ResourceAlreadyExistsException exception.

Definition at line 62 of file CreateDatasetImportJobRequest.h.

◆ SetDatasetImportJobName() [3/3]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetDatasetImportJobName ( const char *  value)
inline

The name for the dataset import job. We recommend including the current timestamp in the name, for example, 20190721DatasetImport. This can help you avoid getting a ResourceAlreadyExistsException exception.

Definition at line 78 of file CreateDatasetImportJobRequest.h.

◆ SetDataSource() [1/2]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetDataSource ( const DataSource value)
inline

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.

If encryption is used, DataSource must include an AWS Key Management Service (KMS) key and the IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match those specified in the EncryptionConfig parameter of the CreateDataset operation.

Definition at line 188 of file CreateDatasetImportJobRequest.h.

◆ SetDataSource() [2/2]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetDataSource ( DataSource &&  value)
inline

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.

If encryption is used, DataSource must include an AWS Key Management Service (KMS) key and the IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match those specified in the EncryptionConfig parameter of the CreateDataset operation.

Definition at line 200 of file CreateDatasetImportJobRequest.h.

◆ SetGeolocationFormat() [1/3]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetGeolocationFormat ( Aws::String &&  value)
inline

The format of the geolocation attribute. The geolocation attribute can be formatted in one of two ways:

  • LAT_LONG - the latitude and longitude in decimal format (Example: 47.61_-122.33).

  • CC_POSTALCODE (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).

Definition at line 452 of file CreateDatasetImportJobRequest.h.

◆ SetGeolocationFormat() [2/3]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetGeolocationFormat ( const Aws::String value)
inline

The format of the geolocation attribute. The geolocation attribute can be formatted in one of two ways:

  • LAT_LONG - the latitude and longitude in decimal format (Example: 47.61_-122.33).

  • CC_POSTALCODE (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).

Definition at line 443 of file CreateDatasetImportJobRequest.h.

◆ SetGeolocationFormat() [3/3]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetGeolocationFormat ( const char *  value)
inline

The format of the geolocation attribute. The geolocation attribute can be formatted in one of two ways:

  • LAT_LONG - the latitude and longitude in decimal format (Example: 47.61_-122.33).

  • CC_POSTALCODE (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).

Definition at line 461 of file CreateDatasetImportJobRequest.h.

◆ SetTags() [1/2]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

The optional metadata that you apply to the dataset import 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.

Definition at line 581 of file CreateDatasetImportJobRequest.h.

◆ SetTags() [2/2]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

The optional metadata that you apply to the dataset import 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.

Definition at line 558 of file CreateDatasetImportJobRequest.h.

◆ SetTimestampFormat() [1/3]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetTimestampFormat ( Aws::String &&  value)
inline

The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

  • "yyyy-MM-dd"

    For the following data frequencies: Y, M, W, and D

  • "yyyy-MM-dd HH:mm:ss"

    For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".

Definition at line 269 of file CreateDatasetImportJobRequest.h.

◆ SetTimestampFormat() [2/3]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetTimestampFormat ( const Aws::String value)
inline

The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

  • "yyyy-MM-dd"

    For the following data frequencies: Y, M, W, and D

  • "yyyy-MM-dd HH:mm:ss"

    For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".

Definition at line 258 of file CreateDatasetImportJobRequest.h.

◆ SetTimestampFormat() [3/3]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetTimestampFormat ( const char *  value)
inline

The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

  • "yyyy-MM-dd"

    For the following data frequencies: Y, M, W, and D

  • "yyyy-MM-dd HH:mm:ss"

    For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".

Definition at line 280 of file CreateDatasetImportJobRequest.h.

◆ SetTimeZone() [1/3]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetTimeZone ( Aws::String &&  value)
inline

A single time zone for every item in your dataset. This option is ideal for datasets with all timestamps within a single time zone, or if all timestamps are normalized to a single time zone.

Refer to the Joda-Time API for a complete list of valid time zone names.

Definition at line 350 of file CreateDatasetImportJobRequest.h.

◆ SetTimeZone() [2/3]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetTimeZone ( const Aws::String value)
inline

A single time zone for every item in your dataset. This option is ideal for datasets with all timestamps within a single time zone, or if all timestamps are normalized to a single time zone.

Refer to the Joda-Time API for a complete list of valid time zone names.

Definition at line 341 of file CreateDatasetImportJobRequest.h.

◆ SetTimeZone() [3/3]

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetTimeZone ( const char *  value)
inline

A single time zone for every item in your dataset. This option is ideal for datasets with all timestamps within a single time zone, or if all timestamps are normalized to a single time zone.

Refer to the Joda-Time API for a complete list of valid time zone names.

Definition at line 359 of file CreateDatasetImportJobRequest.h.

◆ SetUseGeolocationForTimeZone()

void Aws::ForecastService::Model::CreateDatasetImportJobRequest::SetUseGeolocationForTimeZone ( bool  value)
inline

Automatically derive time zone information from the geolocation attribute. This option is ideal for datasets that contain timestamps in multiple time zones and those timestamps are expressed in local time.

Definition at line 408 of file CreateDatasetImportJobRequest.h.

◆ TagsHasBeenSet()

bool Aws::ForecastService::Model::CreateDatasetImportJobRequest::TagsHasBeenSet ( ) const
inline

The optional metadata that you apply to the dataset import 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.

Definition at line 535 of file CreateDatasetImportJobRequest.h.

◆ TimestampFormatHasBeenSet()

bool Aws::ForecastService::Model::CreateDatasetImportJobRequest::TimestampFormatHasBeenSet ( ) const
inline

The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

  • "yyyy-MM-dd"

    For the following data frequencies: Y, M, W, and D

  • "yyyy-MM-dd HH:mm:ss"

    For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".

Definition at line 247 of file CreateDatasetImportJobRequest.h.

◆ TimeZoneHasBeenSet()

bool Aws::ForecastService::Model::CreateDatasetImportJobRequest::TimeZoneHasBeenSet ( ) const
inline

A single time zone for every item in your dataset. This option is ideal for datasets with all timestamps within a single time zone, or if all timestamps are normalized to a single time zone.

Refer to the Joda-Time API for a complete list of valid time zone names.

Definition at line 332 of file CreateDatasetImportJobRequest.h.

◆ UseGeolocationForTimeZoneHasBeenSet()

bool Aws::ForecastService::Model::CreateDatasetImportJobRequest::UseGeolocationForTimeZoneHasBeenSet ( ) const
inline

Automatically derive time zone information from the geolocation attribute. This option is ideal for datasets that contain timestamps in multiple time zones and those timestamps are expressed in local time.

Definition at line 401 of file CreateDatasetImportJobRequest.h.

◆ WithDatasetArn() [1/3]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithDatasetArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.

Definition at line 145 of file CreateDatasetImportJobRequest.h.

◆ WithDatasetArn() [2/3]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithDatasetArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.

Definition at line 139 of file CreateDatasetImportJobRequest.h.

◆ WithDatasetArn() [3/3]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithDatasetArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.

Definition at line 151 of file CreateDatasetImportJobRequest.h.

◆ WithDatasetImportJobName() [1/3]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithDatasetImportJobName ( Aws::String &&  value)
inline

The name for the dataset import job. We recommend including the current timestamp in the name, for example, 20190721DatasetImport. This can help you avoid getting a ResourceAlreadyExistsException exception.

Definition at line 94 of file CreateDatasetImportJobRequest.h.

◆ WithDatasetImportJobName() [2/3]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithDatasetImportJobName ( const Aws::String value)
inline

The name for the dataset import job. We recommend including the current timestamp in the name, for example, 20190721DatasetImport. This can help you avoid getting a ResourceAlreadyExistsException exception.

Definition at line 86 of file CreateDatasetImportJobRequest.h.

◆ WithDatasetImportJobName() [3/3]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithDatasetImportJobName ( const char *  value)
inline

The name for the dataset import job. We recommend including the current timestamp in the name, for example, 20190721DatasetImport. This can help you avoid getting a ResourceAlreadyExistsException exception.

Definition at line 102 of file CreateDatasetImportJobRequest.h.

◆ WithDataSource() [1/2]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithDataSource ( const DataSource value)
inline

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.

If encryption is used, DataSource must include an AWS Key Management Service (KMS) key and the IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match those specified in the EncryptionConfig parameter of the CreateDataset operation.

Definition at line 212 of file CreateDatasetImportJobRequest.h.

◆ WithDataSource() [2/2]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithDataSource ( DataSource &&  value)
inline

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.

If encryption is used, DataSource must include an AWS Key Management Service (KMS) key and the IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match those specified in the EncryptionConfig parameter of the CreateDataset operation.

Definition at line 224 of file CreateDatasetImportJobRequest.h.

◆ WithGeolocationFormat() [1/3]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithGeolocationFormat ( Aws::String &&  value)
inline

The format of the geolocation attribute. The geolocation attribute can be formatted in one of two ways:

  • LAT_LONG - the latitude and longitude in decimal format (Example: 47.61_-122.33).

  • CC_POSTALCODE (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).

Definition at line 479 of file CreateDatasetImportJobRequest.h.

◆ WithGeolocationFormat() [2/3]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithGeolocationFormat ( const Aws::String value)
inline

The format of the geolocation attribute. The geolocation attribute can be formatted in one of two ways:

  • LAT_LONG - the latitude and longitude in decimal format (Example: 47.61_-122.33).

  • CC_POSTALCODE (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).

Definition at line 470 of file CreateDatasetImportJobRequest.h.

◆ WithGeolocationFormat() [3/3]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithGeolocationFormat ( const char *  value)
inline

The format of the geolocation attribute. The geolocation attribute can be formatted in one of two ways:

  • LAT_LONG - the latitude and longitude in decimal format (Example: 47.61_-122.33).

  • CC_POSTALCODE (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).

Definition at line 488 of file CreateDatasetImportJobRequest.h.

◆ WithTags() [1/2]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

The optional metadata that you apply to the dataset import 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.

Definition at line 627 of file CreateDatasetImportJobRequest.h.

◆ WithTags() [2/2]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

The optional metadata that you apply to the dataset import 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.

Definition at line 604 of file CreateDatasetImportJobRequest.h.

◆ WithTimestampFormat() [1/3]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithTimestampFormat ( Aws::String &&  value)
inline

The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

  • "yyyy-MM-dd"

    For the following data frequencies: Y, M, W, and D

  • "yyyy-MM-dd HH:mm:ss"

    For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".

Definition at line 302 of file CreateDatasetImportJobRequest.h.

◆ WithTimestampFormat() [2/3]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithTimestampFormat ( const Aws::String value)
inline

The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

  • "yyyy-MM-dd"

    For the following data frequencies: Y, M, W, and D

  • "yyyy-MM-dd HH:mm:ss"

    For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".

Definition at line 291 of file CreateDatasetImportJobRequest.h.

◆ WithTimestampFormat() [3/3]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithTimestampFormat ( const char *  value)
inline

The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

  • "yyyy-MM-dd"

    For the following data frequencies: Y, M, W, and D

  • "yyyy-MM-dd HH:mm:ss"

    For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".

Definition at line 313 of file CreateDatasetImportJobRequest.h.

◆ WithTimeZone() [1/3]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithTimeZone ( Aws::String &&  value)
inline

A single time zone for every item in your dataset. This option is ideal for datasets with all timestamps within a single time zone, or if all timestamps are normalized to a single time zone.

Refer to the Joda-Time API for a complete list of valid time zone names.

Definition at line 377 of file CreateDatasetImportJobRequest.h.

◆ WithTimeZone() [2/3]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithTimeZone ( const Aws::String value)
inline

A single time zone for every item in your dataset. This option is ideal for datasets with all timestamps within a single time zone, or if all timestamps are normalized to a single time zone.

Refer to the Joda-Time API for a complete list of valid time zone names.

Definition at line 368 of file CreateDatasetImportJobRequest.h.

◆ WithTimeZone() [3/3]

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithTimeZone ( const char *  value)
inline

A single time zone for every item in your dataset. This option is ideal for datasets with all timestamps within a single time zone, or if all timestamps are normalized to a single time zone.

Refer to the Joda-Time API for a complete list of valid time zone names.

Definition at line 386 of file CreateDatasetImportJobRequest.h.

◆ WithUseGeolocationForTimeZone()

CreateDatasetImportJobRequest& Aws::ForecastService::Model::CreateDatasetImportJobRequest::WithUseGeolocationForTimeZone ( bool  value)
inline

Automatically derive time zone information from the geolocation attribute. This option is ideal for datasets that contain timestamps in multiple time zones and those timestamps are expressed in local time.

Definition at line 415 of file CreateDatasetImportJobRequest.h.


The documentation for this class was generated from the following file: