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

#include <CreateForecastExportJobRequest.h>

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

Public Member Functions

 CreateForecastExportJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetForecastExportJobName () const
 
bool ForecastExportJobNameHasBeenSet () const
 
void SetForecastExportJobName (const Aws::String &value)
 
void SetForecastExportJobName (Aws::String &&value)
 
void SetForecastExportJobName (const char *value)
 
CreateForecastExportJobRequestWithForecastExportJobName (const Aws::String &value)
 
CreateForecastExportJobRequestWithForecastExportJobName (Aws::String &&value)
 
CreateForecastExportJobRequestWithForecastExportJobName (const char *value)
 
const Aws::StringGetForecastArn () const
 
bool ForecastArnHasBeenSet () const
 
void SetForecastArn (const Aws::String &value)
 
void SetForecastArn (Aws::String &&value)
 
void SetForecastArn (const char *value)
 
CreateForecastExportJobRequestWithForecastArn (const Aws::String &value)
 
CreateForecastExportJobRequestWithForecastArn (Aws::String &&value)
 
CreateForecastExportJobRequestWithForecastArn (const char *value)
 
const DataDestinationGetDestination () const
 
bool DestinationHasBeenSet () const
 
void SetDestination (const DataDestination &value)
 
void SetDestination (DataDestination &&value)
 
CreateForecastExportJobRequestWithDestination (const DataDestination &value)
 
CreateForecastExportJobRequestWithDestination (DataDestination &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateForecastExportJobRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateForecastExportJobRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateForecastExportJobRequestAddTags (const Tag &value)
 
CreateForecastExportJobRequestAddTags (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 CreateForecastExportJobRequest.h.

Constructor & Destructor Documentation

◆ CreateForecastExportJobRequest()

Aws::ForecastService::Model::CreateForecastExportJobRequest::CreateForecastExportJobRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

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

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.

Definition at line 342 of file CreateForecastExportJobRequest.h.

◆ AddTags() [2/2]

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

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.

Definition at line 365 of file CreateForecastExportJobRequest.h.

◆ DestinationHasBeenSet()

bool Aws::ForecastService::Model::CreateForecastExportJobRequest::DestinationHasBeenSet ( ) const
inline

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.

Definition at line 140 of file CreateForecastExportJobRequest.h.

◆ ForecastArnHasBeenSet()

bool Aws::ForecastService::Model::CreateForecastExportJobRequest::ForecastArnHasBeenSet ( ) const
inline

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

Definition at line 89 of file CreateForecastExportJobRequest.h.

◆ ForecastExportJobNameHasBeenSet()

bool Aws::ForecastService::Model::CreateForecastExportJobRequest::ForecastExportJobNameHasBeenSet ( ) const
inline

The name for the forecast export job.

Definition at line 48 of file CreateForecastExportJobRequest.h.

◆ GetDestination()

const DataDestination& Aws::ForecastService::Model::CreateForecastExportJobRequest::GetDestination ( ) const
inline

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.

Definition at line 130 of file CreateForecastExportJobRequest.h.

◆ GetForecastArn()

const Aws::String& Aws::ForecastService::Model::CreateForecastExportJobRequest::GetForecastArn ( ) const
inline

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

Definition at line 84 of file CreateForecastExportJobRequest.h.

◆ GetForecastExportJobName()

const Aws::String& Aws::ForecastService::Model::CreateForecastExportJobRequest::GetForecastExportJobName ( ) const
inline

The name for the forecast export job.

Definition at line 43 of file CreateForecastExportJobRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file CreateForecastExportJobRequest.h.

◆ GetTags()

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

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.

Definition at line 204 of file CreateForecastExportJobRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDestination() [1/2]

void Aws::ForecastService::Model::CreateForecastExportJobRequest::SetDestination ( const DataDestination value)
inline

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.

Definition at line 150 of file CreateForecastExportJobRequest.h.

◆ SetDestination() [2/2]

void Aws::ForecastService::Model::CreateForecastExportJobRequest::SetDestination ( DataDestination &&  value)
inline

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.

Definition at line 160 of file CreateForecastExportJobRequest.h.

◆ SetForecastArn() [1/3]

void Aws::ForecastService::Model::CreateForecastExportJobRequest::SetForecastArn ( Aws::String &&  value)
inline

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

Definition at line 99 of file CreateForecastExportJobRequest.h.

◆ SetForecastArn() [2/3]

void Aws::ForecastService::Model::CreateForecastExportJobRequest::SetForecastArn ( const Aws::String value)
inline

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

Definition at line 94 of file CreateForecastExportJobRequest.h.

◆ SetForecastArn() [3/3]

void Aws::ForecastService::Model::CreateForecastExportJobRequest::SetForecastArn ( const char *  value)
inline

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

Definition at line 104 of file CreateForecastExportJobRequest.h.

◆ SetForecastExportJobName() [1/3]

void Aws::ForecastService::Model::CreateForecastExportJobRequest::SetForecastExportJobName ( Aws::String &&  value)
inline

The name for the forecast export job.

Definition at line 58 of file CreateForecastExportJobRequest.h.

◆ SetForecastExportJobName() [2/3]

void Aws::ForecastService::Model::CreateForecastExportJobRequest::SetForecastExportJobName ( const Aws::String value)
inline

The name for the forecast export job.

Definition at line 53 of file CreateForecastExportJobRequest.h.

◆ SetForecastExportJobName() [3/3]

void Aws::ForecastService::Model::CreateForecastExportJobRequest::SetForecastExportJobName ( const char *  value)
inline

The name for the forecast export job.

Definition at line 63 of file CreateForecastExportJobRequest.h.

◆ SetTags() [1/2]

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

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.

Definition at line 273 of file CreateForecastExportJobRequest.h.

◆ SetTags() [2/2]

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

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.

Definition at line 250 of file CreateForecastExportJobRequest.h.

◆ TagsHasBeenSet()

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

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.

Definition at line 227 of file CreateForecastExportJobRequest.h.

◆ WithDestination() [1/2]

CreateForecastExportJobRequest& Aws::ForecastService::Model::CreateForecastExportJobRequest::WithDestination ( const DataDestination value)
inline

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.

Definition at line 170 of file CreateForecastExportJobRequest.h.

◆ WithDestination() [2/2]

CreateForecastExportJobRequest& Aws::ForecastService::Model::CreateForecastExportJobRequest::WithDestination ( DataDestination &&  value)
inline

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.

Definition at line 180 of file CreateForecastExportJobRequest.h.

◆ WithForecastArn() [1/3]

CreateForecastExportJobRequest& Aws::ForecastService::Model::CreateForecastExportJobRequest::WithForecastArn ( Aws::String &&  value)
inline

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

Definition at line 114 of file CreateForecastExportJobRequest.h.

◆ WithForecastArn() [2/3]

CreateForecastExportJobRequest& Aws::ForecastService::Model::CreateForecastExportJobRequest::WithForecastArn ( const Aws::String value)
inline

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

Definition at line 109 of file CreateForecastExportJobRequest.h.

◆ WithForecastArn() [3/3]

CreateForecastExportJobRequest& Aws::ForecastService::Model::CreateForecastExportJobRequest::WithForecastArn ( const char *  value)
inline

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

Definition at line 119 of file CreateForecastExportJobRequest.h.

◆ WithForecastExportJobName() [1/3]

CreateForecastExportJobRequest& Aws::ForecastService::Model::CreateForecastExportJobRequest::WithForecastExportJobName ( Aws::String &&  value)
inline

The name for the forecast export job.

Definition at line 73 of file CreateForecastExportJobRequest.h.

◆ WithForecastExportJobName() [2/3]

CreateForecastExportJobRequest& Aws::ForecastService::Model::CreateForecastExportJobRequest::WithForecastExportJobName ( const Aws::String value)
inline

The name for the forecast export job.

Definition at line 68 of file CreateForecastExportJobRequest.h.

◆ WithForecastExportJobName() [3/3]

CreateForecastExportJobRequest& Aws::ForecastService::Model::CreateForecastExportJobRequest::WithForecastExportJobName ( const char *  value)
inline

The name for the forecast export job.

Definition at line 78 of file CreateForecastExportJobRequest.h.

◆ WithTags() [1/2]

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

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.

Definition at line 319 of file CreateForecastExportJobRequest.h.

◆ WithTags() [2/2]

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

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.

Definition at line 296 of file CreateForecastExportJobRequest.h.


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