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

#include <CreateDatasetRequest.h>

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

Public Member Functions

 CreateDatasetRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetDatasetName () const
 
bool DatasetNameHasBeenSet () const
 
void SetDatasetName (const Aws::String &value)
 
void SetDatasetName (Aws::String &&value)
 
void SetDatasetName (const char *value)
 
CreateDatasetRequestWithDatasetName (const Aws::String &value)
 
CreateDatasetRequestWithDatasetName (Aws::String &&value)
 
CreateDatasetRequestWithDatasetName (const char *value)
 
const DomainGetDomain () const
 
bool DomainHasBeenSet () const
 
void SetDomain (const Domain &value)
 
void SetDomain (Domain &&value)
 
CreateDatasetRequestWithDomain (const Domain &value)
 
CreateDatasetRequestWithDomain (Domain &&value)
 
const DatasetTypeGetDatasetType () const
 
bool DatasetTypeHasBeenSet () const
 
void SetDatasetType (const DatasetType &value)
 
void SetDatasetType (DatasetType &&value)
 
CreateDatasetRequestWithDatasetType (const DatasetType &value)
 
CreateDatasetRequestWithDatasetType (DatasetType &&value)
 
const Aws::StringGetDataFrequency () const
 
bool DataFrequencyHasBeenSet () const
 
void SetDataFrequency (const Aws::String &value)
 
void SetDataFrequency (Aws::String &&value)
 
void SetDataFrequency (const char *value)
 
CreateDatasetRequestWithDataFrequency (const Aws::String &value)
 
CreateDatasetRequestWithDataFrequency (Aws::String &&value)
 
CreateDatasetRequestWithDataFrequency (const char *value)
 
const SchemaGetSchema () const
 
bool SchemaHasBeenSet () const
 
void SetSchema (const Schema &value)
 
void SetSchema (Schema &&value)
 
CreateDatasetRequestWithSchema (const Schema &value)
 
CreateDatasetRequestWithSchema (Schema &&value)
 
const EncryptionConfigGetEncryptionConfig () const
 
bool EncryptionConfigHasBeenSet () const
 
void SetEncryptionConfig (const EncryptionConfig &value)
 
void SetEncryptionConfig (EncryptionConfig &&value)
 
CreateDatasetRequestWithEncryptionConfig (const EncryptionConfig &value)
 
CreateDatasetRequestWithEncryptionConfig (EncryptionConfig &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateDatasetRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateDatasetRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateDatasetRequestAddTags (const Tag &value)
 
CreateDatasetRequestAddTags (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 27 of file CreateDatasetRequest.h.

Constructor & Destructor Documentation

◆ CreateDatasetRequest()

Aws::ForecastService::Model::CreateDatasetRequest::CreateDatasetRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

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

The optional metadata that you apply to the dataset 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 524 of file CreateDatasetRequest.h.

◆ AddTags() [2/2]

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

The optional metadata that you apply to the dataset 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 547 of file CreateDatasetRequest.h.

◆ DataFrequencyHasBeenSet()

bool Aws::ForecastService::Model::CreateDatasetRequest::DataFrequencyHasBeenSet ( ) const
inline

The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min" indicates every 15 minutes.

Definition at line 216 of file CreateDatasetRequest.h.

◆ DatasetNameHasBeenSet()

bool Aws::ForecastService::Model::CreateDatasetRequest::DatasetNameHasBeenSet ( ) const
inline

A name for the dataset.

Definition at line 51 of file CreateDatasetRequest.h.

◆ DatasetTypeHasBeenSet()

bool Aws::ForecastService::Model::CreateDatasetRequest::DatasetTypeHasBeenSet ( ) const
inline

The dataset type. Valid values depend on the chosen Domain.

Definition at line 177 of file CreateDatasetRequest.h.

◆ DomainHasBeenSet()

bool Aws::ForecastService::Model::CreateDatasetRequest::DomainHasBeenSet ( ) const
inline

The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

Definition at line 110 of file CreateDatasetRequest.h.

◆ EncryptionConfigHasBeenSet()

bool Aws::ForecastService::Model::CreateDatasetRequest::EncryptionConfigHasBeenSet ( ) const
inline

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

Definition at line 338 of file CreateDatasetRequest.h.

◆ GetDataFrequency()

const Aws::String& Aws::ForecastService::Model::CreateDatasetRequest::GetDataFrequency ( ) const
inline

The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min" indicates every 15 minutes.

Definition at line 207 of file CreateDatasetRequest.h.

◆ GetDatasetName()

const Aws::String& Aws::ForecastService::Model::CreateDatasetRequest::GetDatasetName ( ) const
inline

A name for the dataset.

Definition at line 46 of file CreateDatasetRequest.h.

◆ GetDatasetType()

const DatasetType& Aws::ForecastService::Model::CreateDatasetRequest::GetDatasetType ( ) const
inline

The dataset type. Valid values depend on the chosen Domain.

Definition at line 172 of file CreateDatasetRequest.h.

◆ GetDomain()

const Domain& Aws::ForecastService::Model::CreateDatasetRequest::GetDomain ( ) const
inline

The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

Definition at line 96 of file CreateDatasetRequest.h.

◆ GetEncryptionConfig()

const EncryptionConfig& Aws::ForecastService::Model::CreateDatasetRequest::GetEncryptionConfig ( ) const
inline

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

Definition at line 332 of file CreateDatasetRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetSchema()

const Schema& Aws::ForecastService::Model::CreateDatasetRequest::GetSchema ( ) const
inline

The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types.

Definition at line 280 of file CreateDatasetRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CreateDatasetRequest.h.

◆ GetTags()

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

The optional metadata that you apply to the dataset 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 386 of file CreateDatasetRequest.h.

◆ SchemaHasBeenSet()

bool Aws::ForecastService::Model::CreateDatasetRequest::SchemaHasBeenSet ( ) const
inline

The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types.

Definition at line 289 of file CreateDatasetRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDataFrequency() [1/3]

void Aws::ForecastService::Model::CreateDatasetRequest::SetDataFrequency ( Aws::String &&  value)
inline

The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min" indicates every 15 minutes.

Definition at line 234 of file CreateDatasetRequest.h.

◆ SetDataFrequency() [2/3]

void Aws::ForecastService::Model::CreateDatasetRequest::SetDataFrequency ( const Aws::String value)
inline

The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min" indicates every 15 minutes.

Definition at line 225 of file CreateDatasetRequest.h.

◆ SetDataFrequency() [3/3]

void Aws::ForecastService::Model::CreateDatasetRequest::SetDataFrequency ( const char *  value)
inline

The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min" indicates every 15 minutes.

Definition at line 243 of file CreateDatasetRequest.h.

◆ SetDatasetName() [1/3]

void Aws::ForecastService::Model::CreateDatasetRequest::SetDatasetName ( Aws::String &&  value)
inline

A name for the dataset.

Definition at line 61 of file CreateDatasetRequest.h.

◆ SetDatasetName() [2/3]

void Aws::ForecastService::Model::CreateDatasetRequest::SetDatasetName ( const Aws::String value)
inline

A name for the dataset.

Definition at line 56 of file CreateDatasetRequest.h.

◆ SetDatasetName() [3/3]

void Aws::ForecastService::Model::CreateDatasetRequest::SetDatasetName ( const char *  value)
inline

A name for the dataset.

Definition at line 66 of file CreateDatasetRequest.h.

◆ SetDatasetType() [1/2]

void Aws::ForecastService::Model::CreateDatasetRequest::SetDatasetType ( const DatasetType value)
inline

The dataset type. Valid values depend on the chosen Domain.

Definition at line 182 of file CreateDatasetRequest.h.

◆ SetDatasetType() [2/2]

void Aws::ForecastService::Model::CreateDatasetRequest::SetDatasetType ( DatasetType &&  value)
inline

The dataset type. Valid values depend on the chosen Domain.

Definition at line 187 of file CreateDatasetRequest.h.

◆ SetDomain() [1/2]

void Aws::ForecastService::Model::CreateDatasetRequest::SetDomain ( const Domain value)
inline

The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

Definition at line 124 of file CreateDatasetRequest.h.

◆ SetDomain() [2/2]

void Aws::ForecastService::Model::CreateDatasetRequest::SetDomain ( Domain &&  value)
inline

The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

Definition at line 138 of file CreateDatasetRequest.h.

◆ SetEncryptionConfig() [1/2]

void Aws::ForecastService::Model::CreateDatasetRequest::SetEncryptionConfig ( const EncryptionConfig value)
inline

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

Definition at line 344 of file CreateDatasetRequest.h.

◆ SetEncryptionConfig() [2/2]

void Aws::ForecastService::Model::CreateDatasetRequest::SetEncryptionConfig ( EncryptionConfig &&  value)
inline

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

Definition at line 350 of file CreateDatasetRequest.h.

◆ SetSchema() [1/2]

void Aws::ForecastService::Model::CreateDatasetRequest::SetSchema ( const Schema value)
inline

The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types.

Definition at line 298 of file CreateDatasetRequest.h.

◆ SetSchema() [2/2]

void Aws::ForecastService::Model::CreateDatasetRequest::SetSchema ( Schema &&  value)
inline

The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types.

Definition at line 307 of file CreateDatasetRequest.h.

◆ SetTags() [1/2]

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

The optional metadata that you apply to the dataset 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 455 of file CreateDatasetRequest.h.

◆ SetTags() [2/2]

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

The optional metadata that you apply to the dataset 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 432 of file CreateDatasetRequest.h.

◆ TagsHasBeenSet()

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

The optional metadata that you apply to the dataset 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 409 of file CreateDatasetRequest.h.

◆ WithDataFrequency() [1/3]

CreateDatasetRequest& Aws::ForecastService::Model::CreateDatasetRequest::WithDataFrequency ( Aws::String &&  value)
inline

The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min" indicates every 15 minutes.

Definition at line 261 of file CreateDatasetRequest.h.

◆ WithDataFrequency() [2/3]

CreateDatasetRequest& Aws::ForecastService::Model::CreateDatasetRequest::WithDataFrequency ( const Aws::String value)
inline

The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min" indicates every 15 minutes.

Definition at line 252 of file CreateDatasetRequest.h.

◆ WithDataFrequency() [3/3]

CreateDatasetRequest& Aws::ForecastService::Model::CreateDatasetRequest::WithDataFrequency ( const char *  value)
inline

The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min" indicates every 15 minutes.

Definition at line 270 of file CreateDatasetRequest.h.

◆ WithDatasetName() [1/3]

CreateDatasetRequest& Aws::ForecastService::Model::CreateDatasetRequest::WithDatasetName ( Aws::String &&  value)
inline

A name for the dataset.

Definition at line 76 of file CreateDatasetRequest.h.

◆ WithDatasetName() [2/3]

CreateDatasetRequest& Aws::ForecastService::Model::CreateDatasetRequest::WithDatasetName ( const Aws::String value)
inline

A name for the dataset.

Definition at line 71 of file CreateDatasetRequest.h.

◆ WithDatasetName() [3/3]

CreateDatasetRequest& Aws::ForecastService::Model::CreateDatasetRequest::WithDatasetName ( const char *  value)
inline

A name for the dataset.

Definition at line 81 of file CreateDatasetRequest.h.

◆ WithDatasetType() [1/2]

CreateDatasetRequest& Aws::ForecastService::Model::CreateDatasetRequest::WithDatasetType ( const DatasetType value)
inline

The dataset type. Valid values depend on the chosen Domain.

Definition at line 192 of file CreateDatasetRequest.h.

◆ WithDatasetType() [2/2]

CreateDatasetRequest& Aws::ForecastService::Model::CreateDatasetRequest::WithDatasetType ( DatasetType &&  value)
inline

The dataset type. Valid values depend on the chosen Domain.

Definition at line 197 of file CreateDatasetRequest.h.

◆ WithDomain() [1/2]

CreateDatasetRequest& Aws::ForecastService::Model::CreateDatasetRequest::WithDomain ( const Domain value)
inline

The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

Definition at line 152 of file CreateDatasetRequest.h.

◆ WithDomain() [2/2]

CreateDatasetRequest& Aws::ForecastService::Model::CreateDatasetRequest::WithDomain ( Domain &&  value)
inline

The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

Definition at line 166 of file CreateDatasetRequest.h.

◆ WithEncryptionConfig() [1/2]

CreateDatasetRequest& Aws::ForecastService::Model::CreateDatasetRequest::WithEncryptionConfig ( const EncryptionConfig value)
inline

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

Definition at line 356 of file CreateDatasetRequest.h.

◆ WithEncryptionConfig() [2/2]

CreateDatasetRequest& Aws::ForecastService::Model::CreateDatasetRequest::WithEncryptionConfig ( EncryptionConfig &&  value)
inline

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

Definition at line 362 of file CreateDatasetRequest.h.

◆ WithSchema() [1/2]

CreateDatasetRequest& Aws::ForecastService::Model::CreateDatasetRequest::WithSchema ( const Schema value)
inline

The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types.

Definition at line 316 of file CreateDatasetRequest.h.

◆ WithSchema() [2/2]

CreateDatasetRequest& Aws::ForecastService::Model::CreateDatasetRequest::WithSchema ( Schema &&  value)
inline

The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types.

Definition at line 325 of file CreateDatasetRequest.h.

◆ WithTags() [1/2]

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

The optional metadata that you apply to the dataset 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 501 of file CreateDatasetRequest.h.

◆ WithTags() [2/2]

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

The optional metadata that you apply to the dataset 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 478 of file CreateDatasetRequest.h.


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