AWS SDK for C++  1.9.126
AWS SDK for C++
Public Types | Public Member Functions | List of all members
Aws::ForecastService::ForecastServiceClient Class Reference

#include <ForecastServiceClient.h>

+ Inheritance diagram for Aws::ForecastService::ForecastServiceClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS
 
- Public Types inherited from Aws::Client::AWSJsonClient
typedef AWSClient BASECLASS
 

Public Member Functions

 ForecastServiceClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 ForecastServiceClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 ForecastServiceClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~ForecastServiceClient ()
 
virtual Model::CreateDatasetOutcome CreateDataset (const Model::CreateDatasetRequest &request) const
 
virtual Model::CreateDatasetOutcomeCallable CreateDatasetCallable (const Model::CreateDatasetRequest &request) const
 
virtual void CreateDatasetAsync (const Model::CreateDatasetRequest &request, const CreateDatasetResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateDatasetGroupOutcome CreateDatasetGroup (const Model::CreateDatasetGroupRequest &request) const
 
virtual Model::CreateDatasetGroupOutcomeCallable CreateDatasetGroupCallable (const Model::CreateDatasetGroupRequest &request) const
 
virtual void CreateDatasetGroupAsync (const Model::CreateDatasetGroupRequest &request, const CreateDatasetGroupResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateDatasetImportJobOutcome CreateDatasetImportJob (const Model::CreateDatasetImportJobRequest &request) const
 
virtual Model::CreateDatasetImportJobOutcomeCallable CreateDatasetImportJobCallable (const Model::CreateDatasetImportJobRequest &request) const
 
virtual void CreateDatasetImportJobAsync (const Model::CreateDatasetImportJobRequest &request, const CreateDatasetImportJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateForecastOutcome CreateForecast (const Model::CreateForecastRequest &request) const
 
virtual Model::CreateForecastOutcomeCallable CreateForecastCallable (const Model::CreateForecastRequest &request) const
 
virtual void CreateForecastAsync (const Model::CreateForecastRequest &request, const CreateForecastResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateForecastExportJobOutcome CreateForecastExportJob (const Model::CreateForecastExportJobRequest &request) const
 
virtual Model::CreateForecastExportJobOutcomeCallable CreateForecastExportJobCallable (const Model::CreateForecastExportJobRequest &request) const
 
virtual void CreateForecastExportJobAsync (const Model::CreateForecastExportJobRequest &request, const CreateForecastExportJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreatePredictorOutcome CreatePredictor (const Model::CreatePredictorRequest &request) const
 
virtual Model::CreatePredictorOutcomeCallable CreatePredictorCallable (const Model::CreatePredictorRequest &request) const
 
virtual void CreatePredictorAsync (const Model::CreatePredictorRequest &request, const CreatePredictorResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreatePredictorBacktestExportJobOutcome CreatePredictorBacktestExportJob (const Model::CreatePredictorBacktestExportJobRequest &request) const
 
virtual Model::CreatePredictorBacktestExportJobOutcomeCallable CreatePredictorBacktestExportJobCallable (const Model::CreatePredictorBacktestExportJobRequest &request) const
 
virtual void CreatePredictorBacktestExportJobAsync (const Model::CreatePredictorBacktestExportJobRequest &request, const CreatePredictorBacktestExportJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteDatasetOutcome DeleteDataset (const Model::DeleteDatasetRequest &request) const
 
virtual Model::DeleteDatasetOutcomeCallable DeleteDatasetCallable (const Model::DeleteDatasetRequest &request) const
 
virtual void DeleteDatasetAsync (const Model::DeleteDatasetRequest &request, const DeleteDatasetResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteDatasetGroupOutcome DeleteDatasetGroup (const Model::DeleteDatasetGroupRequest &request) const
 
virtual Model::DeleteDatasetGroupOutcomeCallable DeleteDatasetGroupCallable (const Model::DeleteDatasetGroupRequest &request) const
 
virtual void DeleteDatasetGroupAsync (const Model::DeleteDatasetGroupRequest &request, const DeleteDatasetGroupResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteDatasetImportJobOutcome DeleteDatasetImportJob (const Model::DeleteDatasetImportJobRequest &request) const
 
virtual Model::DeleteDatasetImportJobOutcomeCallable DeleteDatasetImportJobCallable (const Model::DeleteDatasetImportJobRequest &request) const
 
virtual void DeleteDatasetImportJobAsync (const Model::DeleteDatasetImportJobRequest &request, const DeleteDatasetImportJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteForecastOutcome DeleteForecast (const Model::DeleteForecastRequest &request) const
 
virtual Model::DeleteForecastOutcomeCallable DeleteForecastCallable (const Model::DeleteForecastRequest &request) const
 
virtual void DeleteForecastAsync (const Model::DeleteForecastRequest &request, const DeleteForecastResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteForecastExportJobOutcome DeleteForecastExportJob (const Model::DeleteForecastExportJobRequest &request) const
 
virtual Model::DeleteForecastExportJobOutcomeCallable DeleteForecastExportJobCallable (const Model::DeleteForecastExportJobRequest &request) const
 
virtual void DeleteForecastExportJobAsync (const Model::DeleteForecastExportJobRequest &request, const DeleteForecastExportJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeletePredictorOutcome DeletePredictor (const Model::DeletePredictorRequest &request) const
 
virtual Model::DeletePredictorOutcomeCallable DeletePredictorCallable (const Model::DeletePredictorRequest &request) const
 
virtual void DeletePredictorAsync (const Model::DeletePredictorRequest &request, const DeletePredictorResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeletePredictorBacktestExportJobOutcome DeletePredictorBacktestExportJob (const Model::DeletePredictorBacktestExportJobRequest &request) const
 
virtual Model::DeletePredictorBacktestExportJobOutcomeCallable DeletePredictorBacktestExportJobCallable (const Model::DeletePredictorBacktestExportJobRequest &request) const
 
virtual void DeletePredictorBacktestExportJobAsync (const Model::DeletePredictorBacktestExportJobRequest &request, const DeletePredictorBacktestExportJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteResourceTreeOutcome DeleteResourceTree (const Model::DeleteResourceTreeRequest &request) const
 
virtual Model::DeleteResourceTreeOutcomeCallable DeleteResourceTreeCallable (const Model::DeleteResourceTreeRequest &request) const
 
virtual void DeleteResourceTreeAsync (const Model::DeleteResourceTreeRequest &request, const DeleteResourceTreeResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeDatasetOutcome DescribeDataset (const Model::DescribeDatasetRequest &request) const
 
virtual Model::DescribeDatasetOutcomeCallable DescribeDatasetCallable (const Model::DescribeDatasetRequest &request) const
 
virtual void DescribeDatasetAsync (const Model::DescribeDatasetRequest &request, const DescribeDatasetResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeDatasetGroupOutcome DescribeDatasetGroup (const Model::DescribeDatasetGroupRequest &request) const
 
virtual Model::DescribeDatasetGroupOutcomeCallable DescribeDatasetGroupCallable (const Model::DescribeDatasetGroupRequest &request) const
 
virtual void DescribeDatasetGroupAsync (const Model::DescribeDatasetGroupRequest &request, const DescribeDatasetGroupResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeDatasetImportJobOutcome DescribeDatasetImportJob (const Model::DescribeDatasetImportJobRequest &request) const
 
virtual Model::DescribeDatasetImportJobOutcomeCallable DescribeDatasetImportJobCallable (const Model::DescribeDatasetImportJobRequest &request) const
 
virtual void DescribeDatasetImportJobAsync (const Model::DescribeDatasetImportJobRequest &request, const DescribeDatasetImportJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeForecastOutcome DescribeForecast (const Model::DescribeForecastRequest &request) const
 
virtual Model::DescribeForecastOutcomeCallable DescribeForecastCallable (const Model::DescribeForecastRequest &request) const
 
virtual void DescribeForecastAsync (const Model::DescribeForecastRequest &request, const DescribeForecastResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeForecastExportJobOutcome DescribeForecastExportJob (const Model::DescribeForecastExportJobRequest &request) const
 
virtual Model::DescribeForecastExportJobOutcomeCallable DescribeForecastExportJobCallable (const Model::DescribeForecastExportJobRequest &request) const
 
virtual void DescribeForecastExportJobAsync (const Model::DescribeForecastExportJobRequest &request, const DescribeForecastExportJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribePredictorOutcome DescribePredictor (const Model::DescribePredictorRequest &request) const
 
virtual Model::DescribePredictorOutcomeCallable DescribePredictorCallable (const Model::DescribePredictorRequest &request) const
 
virtual void DescribePredictorAsync (const Model::DescribePredictorRequest &request, const DescribePredictorResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribePredictorBacktestExportJobOutcome DescribePredictorBacktestExportJob (const Model::DescribePredictorBacktestExportJobRequest &request) const
 
virtual Model::DescribePredictorBacktestExportJobOutcomeCallable DescribePredictorBacktestExportJobCallable (const Model::DescribePredictorBacktestExportJobRequest &request) const
 
virtual void DescribePredictorBacktestExportJobAsync (const Model::DescribePredictorBacktestExportJobRequest &request, const DescribePredictorBacktestExportJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetAccuracyMetricsOutcome GetAccuracyMetrics (const Model::GetAccuracyMetricsRequest &request) const
 
virtual Model::GetAccuracyMetricsOutcomeCallable GetAccuracyMetricsCallable (const Model::GetAccuracyMetricsRequest &request) const
 
virtual void GetAccuracyMetricsAsync (const Model::GetAccuracyMetricsRequest &request, const GetAccuracyMetricsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListDatasetGroupsOutcome ListDatasetGroups (const Model::ListDatasetGroupsRequest &request) const
 
virtual Model::ListDatasetGroupsOutcomeCallable ListDatasetGroupsCallable (const Model::ListDatasetGroupsRequest &request) const
 
virtual void ListDatasetGroupsAsync (const Model::ListDatasetGroupsRequest &request, const ListDatasetGroupsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListDatasetImportJobsOutcome ListDatasetImportJobs (const Model::ListDatasetImportJobsRequest &request) const
 
virtual Model::ListDatasetImportJobsOutcomeCallable ListDatasetImportJobsCallable (const Model::ListDatasetImportJobsRequest &request) const
 
virtual void ListDatasetImportJobsAsync (const Model::ListDatasetImportJobsRequest &request, const ListDatasetImportJobsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListDatasetsOutcome ListDatasets (const Model::ListDatasetsRequest &request) const
 
virtual Model::ListDatasetsOutcomeCallable ListDatasetsCallable (const Model::ListDatasetsRequest &request) const
 
virtual void ListDatasetsAsync (const Model::ListDatasetsRequest &request, const ListDatasetsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListForecastExportJobsOutcome ListForecastExportJobs (const Model::ListForecastExportJobsRequest &request) const
 
virtual Model::ListForecastExportJobsOutcomeCallable ListForecastExportJobsCallable (const Model::ListForecastExportJobsRequest &request) const
 
virtual void ListForecastExportJobsAsync (const Model::ListForecastExportJobsRequest &request, const ListForecastExportJobsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListForecastsOutcome ListForecasts (const Model::ListForecastsRequest &request) const
 
virtual Model::ListForecastsOutcomeCallable ListForecastsCallable (const Model::ListForecastsRequest &request) const
 
virtual void ListForecastsAsync (const Model::ListForecastsRequest &request, const ListForecastsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListPredictorBacktestExportJobsOutcome ListPredictorBacktestExportJobs (const Model::ListPredictorBacktestExportJobsRequest &request) const
 
virtual Model::ListPredictorBacktestExportJobsOutcomeCallable ListPredictorBacktestExportJobsCallable (const Model::ListPredictorBacktestExportJobsRequest &request) const
 
virtual void ListPredictorBacktestExportJobsAsync (const Model::ListPredictorBacktestExportJobsRequest &request, const ListPredictorBacktestExportJobsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListPredictorsOutcome ListPredictors (const Model::ListPredictorsRequest &request) const
 
virtual Model::ListPredictorsOutcomeCallable ListPredictorsCallable (const Model::ListPredictorsRequest &request) const
 
virtual void ListPredictorsAsync (const Model::ListPredictorsRequest &request, const ListPredictorsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListTagsForResourceOutcome ListTagsForResource (const Model::ListTagsForResourceRequest &request) const
 
virtual Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable (const Model::ListTagsForResourceRequest &request) const
 
virtual void ListTagsForResourceAsync (const Model::ListTagsForResourceRequest &request, const ListTagsForResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::StopResourceOutcome StopResource (const Model::StopResourceRequest &request) const
 
virtual Model::StopResourceOutcomeCallable StopResourceCallable (const Model::StopResourceRequest &request) const
 
virtual void StopResourceAsync (const Model::StopResourceRequest &request, const StopResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::TagResourceOutcome TagResource (const Model::TagResourceRequest &request) const
 
virtual Model::TagResourceOutcomeCallable TagResourceCallable (const Model::TagResourceRequest &request) const
 
virtual void TagResourceAsync (const Model::TagResourceRequest &request, const TagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UntagResourceOutcome UntagResource (const Model::UntagResourceRequest &request) const
 
virtual Model::UntagResourceOutcomeCallable UntagResourceCallable (const Model::UntagResourceRequest &request) const
 
virtual void UntagResourceAsync (const Model::UntagResourceRequest &request, const UntagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateDatasetGroupOutcome UpdateDatasetGroup (const Model::UpdateDatasetGroupRequest &request) const
 
virtual Model::UpdateDatasetGroupOutcomeCallable UpdateDatasetGroupCallable (const Model::UpdateDatasetGroupRequest &request) const
 
virtual void UpdateDatasetGroupAsync (const Model::UpdateDatasetGroupRequest &request, const UpdateDatasetGroupResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void OverrideEndpoint (const Aws::String &endpoint)
 
- Public Member Functions inherited from Aws::Client::AWSJsonClient
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSJsonClient ()=default
 
- Public Member Functions inherited from Aws::Client::AWSClient
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSClient ()
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
void DisableRequestProcessing ()
 
void EnableRequestProcessing ()
 
virtual const char * GetServiceClientName () const
 
virtual void SetServiceClientName (const Aws::String &name)
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Client::AWSJsonClient
virtual AWSError< CoreErrorsBuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeEventStreamRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Member Functions inherited from Aws::Client::AWSClient
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
virtual void BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const
 
const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const
 
Aws::Client::AWSAuthSignerGetSignerByName (const char *name) const
 
std::shared_ptr< Aws::Http::HttpRequestBuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const
 
std::shared_ptr< Aws::Http::HttpResponseMakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Attributes inherited from Aws::Client::AWSClient
Aws::String m_region
 

Detailed Description

Provides APIs for creating and managing Amazon Forecast resources.

Definition at line 230 of file ForecastServiceClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 233 of file ForecastServiceClient.h.

Constructor & Destructor Documentation

◆ ForecastServiceClient() [1/3]

Aws::ForecastService::ForecastServiceClient::ForecastServiceClient ( const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration())

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ ForecastServiceClient() [2/3]

Aws::ForecastService::ForecastServiceClient::ForecastServiceClient ( const Aws::Auth::AWSCredentials credentials,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ ForecastServiceClient() [3/3]

Aws::ForecastService::ForecastServiceClient::ForecastServiceClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

◆ ~ForecastServiceClient()

virtual Aws::ForecastService::ForecastServiceClient::~ForecastServiceClient ( )
virtual

Member Function Documentation

◆ CreateDataset()

virtual Model::CreateDatasetOutcome Aws::ForecastService::ForecastServiceClient::CreateDataset ( const Model::CreateDatasetRequest request) const
virtual

Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:

  • DataFrequency - How frequently your historical time-series data is collected.

  • Domain and DatasetType - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields.

  • Schema - A schema specifies the fields in the dataset, including the field name and data type.

After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see howitworks-datasets-groups.

To get a list of all your datasets, use the ListDatasets operation.

For example Forecast datasets, see the Amazon Forecast Sample GitHub repository.

The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset operation to get the status.

See Also:

AWS API Reference

◆ CreateDatasetAsync()

virtual void Aws::ForecastService::ForecastServiceClient::CreateDatasetAsync ( const Model::CreateDatasetRequest request,
const CreateDatasetResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:

  • DataFrequency - How frequently your historical time-series data is collected.

  • Domain and DatasetType - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields.

  • Schema - A schema specifies the fields in the dataset, including the field name and data type.

After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see howitworks-datasets-groups.

To get a list of all your datasets, use the ListDatasets operation.

For example Forecast datasets, see the Amazon Forecast Sample GitHub repository.

The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset operation to get the status.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateDatasetCallable()

virtual Model::CreateDatasetOutcomeCallable Aws::ForecastService::ForecastServiceClient::CreateDatasetCallable ( const Model::CreateDatasetRequest request) const
virtual

Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:

  • DataFrequency - How frequently your historical time-series data is collected.

  • Domain and DatasetType - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields.

  • Schema - A schema specifies the fields in the dataset, including the field name and data type.

After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see howitworks-datasets-groups.

To get a list of all your datasets, use the ListDatasets operation.

For example Forecast datasets, see the Amazon Forecast Sample GitHub repository.

The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset operation to get the status.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ CreateDatasetGroup()

virtual Model::CreateDatasetGroupOutcome Aws::ForecastService::ForecastServiceClient::CreateDatasetGroup ( const Model::CreateDatasetGroupRequest request) const
virtual

Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.

After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see howitworks-datasets-groups.

To get a list of all your datasets groups, use the ListDatasetGroups operation.

The Status of a dataset group must be ACTIVE before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.

See Also:

AWS API Reference

◆ CreateDatasetGroupAsync()

virtual void Aws::ForecastService::ForecastServiceClient::CreateDatasetGroupAsync ( const Model::CreateDatasetGroupRequest request,
const CreateDatasetGroupResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.

After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see howitworks-datasets-groups.

To get a list of all your datasets groups, use the ListDatasetGroups operation.

The Status of a dataset group must be ACTIVE before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateDatasetGroupCallable()

virtual Model::CreateDatasetGroupOutcomeCallable Aws::ForecastService::ForecastServiceClient::CreateDatasetGroupCallable ( const Model::CreateDatasetGroupRequest request) const
virtual

Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.

After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see howitworks-datasets-groups.

To get a list of all your datasets groups, use the ListDatasetGroups operation.

The Status of a dataset group must be ACTIVE before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ CreateDatasetImportJob()

virtual Model::CreateDatasetImportJobOutcome Aws::ForecastService::ForecastServiceClient::CreateDatasetImportJob ( const Model::CreateDatasetImportJobRequest request) const
virtual

Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to.

You must specify a DataSource object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal AWS system. For more information, see aws-forecast-iam-roles.

The training data must be in CSV format. The delimiter must be a comma (,).

You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files.

Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import.

To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation.

See Also:

AWS API Reference

◆ CreateDatasetImportJobAsync()

virtual void Aws::ForecastService::ForecastServiceClient::CreateDatasetImportJobAsync ( const Model::CreateDatasetImportJobRequest request,
const CreateDatasetImportJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to.

You must specify a DataSource object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal AWS system. For more information, see aws-forecast-iam-roles.

The training data must be in CSV format. The delimiter must be a comma (,).

You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files.

Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import.

To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateDatasetImportJobCallable()

virtual Model::CreateDatasetImportJobOutcomeCallable Aws::ForecastService::ForecastServiceClient::CreateDatasetImportJobCallable ( const Model::CreateDatasetImportJobRequest request) const
virtual

Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to.

You must specify a DataSource object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal AWS system. For more information, see aws-forecast-iam-roles.

The training data must be in CSV format. The delimiter must be a comma (,).

You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files.

Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import.

To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ CreateForecast()

virtual Model::CreateForecastOutcome Aws::ForecastService::ForecastServiceClient::CreateForecast ( const Model::CreateForecastRequest request) const
virtual

Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.

The range of the forecast is determined by the ForecastHorizon value, which you specify in the CreatePredictor request. When you query a forecast, you can request a specific date range within the forecast.

To get a list of all your forecasts, use the ListForecasts operation.

The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor.

For more information, see howitworks-forecast.

The Status of the forecast must be ACTIVE before you can query or export the forecast. Use the DescribeForecast operation to get the status.

See Also:

AWS API Reference

◆ CreateForecastAsync()

virtual void Aws::ForecastService::ForecastServiceClient::CreateForecastAsync ( const Model::CreateForecastRequest request,
const CreateForecastResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.

The range of the forecast is determined by the ForecastHorizon value, which you specify in the CreatePredictor request. When you query a forecast, you can request a specific date range within the forecast.

To get a list of all your forecasts, use the ListForecasts operation.

The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor.

For more information, see howitworks-forecast.

The Status of the forecast must be ACTIVE before you can query or export the forecast. Use the DescribeForecast operation to get the status.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateForecastCallable()

virtual Model::CreateForecastOutcomeCallable Aws::ForecastService::ForecastServiceClient::CreateForecastCallable ( const Model::CreateForecastRequest request) const
virtual

Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.

The range of the forecast is determined by the ForecastHorizon value, which you specify in the CreatePredictor request. When you query a forecast, you can request a specific date range within the forecast.

To get a list of all your forecasts, use the ListForecasts operation.

The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor.

For more information, see howitworks-forecast.

The Status of the forecast must be ACTIVE before you can query or export the forecast. Use the DescribeForecast operation to get the status.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ CreateForecastExportJob()

virtual Model::CreateForecastExportJobOutcome Aws::ForecastService::ForecastServiceClient::CreateForecastExportJob ( const Model::CreateForecastExportJobRequest request) const
virtual

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

<ForecastExportJobName><ExportTimestamp><PartNumber>

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

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

For more information, see howitworks-forecast.

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

The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.

See Also:

AWS API Reference

◆ CreateForecastExportJobAsync()

virtual void Aws::ForecastService::ForecastServiceClient::CreateForecastExportJobAsync ( const Model::CreateForecastExportJobRequest request,
const CreateForecastExportJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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

<ForecastExportJobName><ExportTimestamp><PartNumber>

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

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

For more information, see howitworks-forecast.

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

The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateForecastExportJobCallable()

virtual Model::CreateForecastExportJobOutcomeCallable Aws::ForecastService::ForecastServiceClient::CreateForecastExportJobCallable ( const Model::CreateForecastExportJobRequest request) const
virtual

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

<ForecastExportJobName><ExportTimestamp><PartNumber>

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

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

For more information, see howitworks-forecast.

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

The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ CreatePredictor()

virtual Model::CreatePredictorOutcome Aws::ForecastService::ForecastServiceClient::CreatePredictor ( const Model::CreatePredictorRequest request) const
virtual

Creates an Amazon Forecast predictor.

In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast choose an algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters.

Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets in the specified dataset group. You can then generate a forecast using the CreateForecast operation.

To see the evaluation metrics, use the GetAccuracyMetrics operation.

You can specify a featurization configuration to fill and aggregate the data fields in the TARGET_TIME_SERIES dataset to improve model training. For more information, see FeaturizationConfig.

For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency specified when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES datasets don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.

By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by setting the ForecastTypes.

AutoML

If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the objective function, set PerformAutoML to true. The objective function is defined as the mean of the weighted losses over the forecast types. By default, these are the p10, p50, and p90 quantile losses. For more information, see EvaluationResult.

When AutoML is enabled, the following properties are disallowed:

  • AlgorithmArn

  • HPOConfig

  • PerformHPO

  • TrainingParameters

To get a list of all of your predictors, use the ListPredictors operation.

Before you can use the predictor to create a forecast, the Status of the predictor must be ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor operation.

See Also:


AWS API Reference

◆ CreatePredictorAsync()

virtual void Aws::ForecastService::ForecastServiceClient::CreatePredictorAsync ( const Model::CreatePredictorRequest request,
const CreatePredictorResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates an Amazon Forecast predictor.

In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast choose an algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters.

Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets in the specified dataset group. You can then generate a forecast using the CreateForecast operation.

To see the evaluation metrics, use the GetAccuracyMetrics operation.

You can specify a featurization configuration to fill and aggregate the data fields in the TARGET_TIME_SERIES dataset to improve model training. For more information, see FeaturizationConfig.

For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency specified when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES datasets don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.

By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by setting the ForecastTypes.

AutoML

If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the objective function, set PerformAutoML to true. The objective function is defined as the mean of the weighted losses over the forecast types. By default, these are the p10, p50, and p90 quantile losses. For more information, see EvaluationResult.

When AutoML is enabled, the following properties are disallowed:

  • AlgorithmArn

  • HPOConfig

  • PerformHPO

  • TrainingParameters

To get a list of all of your predictors, use the ListPredictors operation.

Before you can use the predictor to create a forecast, the Status of the predictor must be ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor operation.

See Also:


AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreatePredictorBacktestExportJob()

virtual Model::CreatePredictorBacktestExportJobOutcome Aws::ForecastService::ForecastServiceClient::CreatePredictorBacktestExportJob ( const Model::CreatePredictorBacktestExportJobRequest request) const
virtual

Exports backtest forecasts and accuracy metrics generated by the CreatePredictor operation. Two folders containing CSV files are exported to your specified S3 bucket.

The export file names will match the following conventions:

<ExportJobName><ExportTimestamp><PartNumber>.csv

The <ExportTimestamp> component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ).

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

The Status of the export job must be ACTIVE before you can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.

See Also:

AWS API Reference

◆ CreatePredictorBacktestExportJobAsync()

virtual void Aws::ForecastService::ForecastServiceClient::CreatePredictorBacktestExportJobAsync ( const Model::CreatePredictorBacktestExportJobRequest request,
const CreatePredictorBacktestExportJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Exports backtest forecasts and accuracy metrics generated by the CreatePredictor operation. Two folders containing CSV files are exported to your specified S3 bucket.

The export file names will match the following conventions:

<ExportJobName><ExportTimestamp><PartNumber>.csv

The <ExportTimestamp> component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ).

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

The Status of the export job must be ACTIVE before you can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreatePredictorBacktestExportJobCallable()

virtual Model::CreatePredictorBacktestExportJobOutcomeCallable Aws::ForecastService::ForecastServiceClient::CreatePredictorBacktestExportJobCallable ( const Model::CreatePredictorBacktestExportJobRequest request) const
virtual

Exports backtest forecasts and accuracy metrics generated by the CreatePredictor operation. Two folders containing CSV files are exported to your specified S3 bucket.

The export file names will match the following conventions:

<ExportJobName><ExportTimestamp><PartNumber>.csv

The <ExportTimestamp> component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ).

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

The Status of the export job must be ACTIVE before you can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ CreatePredictorCallable()

virtual Model::CreatePredictorOutcomeCallable Aws::ForecastService::ForecastServiceClient::CreatePredictorCallable ( const Model::CreatePredictorRequest request) const
virtual

Creates an Amazon Forecast predictor.

In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast choose an algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters.

Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets in the specified dataset group. You can then generate a forecast using the CreateForecast operation.

To see the evaluation metrics, use the GetAccuracyMetrics operation.

You can specify a featurization configuration to fill and aggregate the data fields in the TARGET_TIME_SERIES dataset to improve model training. For more information, see FeaturizationConfig.

For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency specified when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES datasets don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.

By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by setting the ForecastTypes.

AutoML

If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the objective function, set PerformAutoML to true. The objective function is defined as the mean of the weighted losses over the forecast types. By default, these are the p10, p50, and p90 quantile losses. For more information, see EvaluationResult.

When AutoML is enabled, the following properties are disallowed:

  • AlgorithmArn

  • HPOConfig

  • PerformHPO

  • TrainingParameters

To get a list of all of your predictors, use the ListPredictors operation.

Before you can use the predictor to create a forecast, the Status of the predictor must be ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor operation.

See Also:


AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteDataset()

virtual Model::DeleteDatasetOutcome Aws::ForecastService::ForecastServiceClient::DeleteDataset ( const Model::DeleteDatasetRequest request) const
virtual

Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use the DescribeDataset operation.

Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the operation, omitting the deleted dataset's ARN.

See Also:

AWS API Reference

◆ DeleteDatasetAsync()

virtual void Aws::ForecastService::ForecastServiceClient::DeleteDatasetAsync ( const Model::DeleteDatasetRequest request,
const DeleteDatasetResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use the DescribeDataset operation.

Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the operation, omitting the deleted dataset's ARN.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteDatasetCallable()

virtual Model::DeleteDatasetOutcomeCallable Aws::ForecastService::ForecastServiceClient::DeleteDatasetCallable ( const Model::DeleteDatasetRequest request) const
virtual

Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use the DescribeDataset operation.

Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the operation, omitting the deleted dataset's ARN.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteDatasetGroup()

virtual Model::DeleteDatasetGroupOutcome Aws::ForecastService::ForecastServiceClient::DeleteDatasetGroup ( const Model::DeleteDatasetGroupRequest request) const
virtual

Deletes a dataset group created using the CreateDatasetGroup operation. You can only delete dataset groups that have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. To get the status, use the DescribeDatasetGroup operation.

This operation deletes only the dataset group, not the datasets in the group.

See Also:

AWS API Reference

◆ DeleteDatasetGroupAsync()

virtual void Aws::ForecastService::ForecastServiceClient::DeleteDatasetGroupAsync ( const Model::DeleteDatasetGroupRequest request,
const DeleteDatasetGroupResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes a dataset group created using the CreateDatasetGroup operation. You can only delete dataset groups that have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. To get the status, use the DescribeDatasetGroup operation.

This operation deletes only the dataset group, not the datasets in the group.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteDatasetGroupCallable()

virtual Model::DeleteDatasetGroupOutcomeCallable Aws::ForecastService::ForecastServiceClient::DeleteDatasetGroupCallable ( const Model::DeleteDatasetGroupRequest request) const
virtual

Deletes a dataset group created using the CreateDatasetGroup operation. You can only delete dataset groups that have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. To get the status, use the DescribeDatasetGroup operation.

This operation deletes only the dataset group, not the datasets in the group.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteDatasetImportJob()

virtual Model::DeleteDatasetImportJobOutcome Aws::ForecastService::ForecastServiceClient::DeleteDatasetImportJob ( const Model::DeleteDatasetImportJobRequest request) const
virtual

Deletes a dataset import job created using the CreateDatasetImportJob operation. You can delete only dataset import jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeDatasetImportJob operation.

See Also:

AWS API Reference

◆ DeleteDatasetImportJobAsync()

virtual void Aws::ForecastService::ForecastServiceClient::DeleteDatasetImportJobAsync ( const Model::DeleteDatasetImportJobRequest request,
const DeleteDatasetImportJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes a dataset import job created using the CreateDatasetImportJob operation. You can delete only dataset import jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeDatasetImportJob operation.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteDatasetImportJobCallable()

virtual Model::DeleteDatasetImportJobOutcomeCallable Aws::ForecastService::ForecastServiceClient::DeleteDatasetImportJobCallable ( const Model::DeleteDatasetImportJobRequest request) const
virtual

Deletes a dataset import job created using the CreateDatasetImportJob operation. You can delete only dataset import jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeDatasetImportJob operation.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteForecast()

virtual Model::DeleteForecastOutcome Aws::ForecastService::ForecastServiceClient::DeleteForecast ( const Model::DeleteForecastRequest request) const
virtual

Deletes a forecast created using the CreateForecast operation. You can delete only forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecast operation.

You can't delete a forecast while it is being exported. After a forecast is deleted, you can no longer query the forecast.

See Also:

AWS API Reference

◆ DeleteForecastAsync()

virtual void Aws::ForecastService::ForecastServiceClient::DeleteForecastAsync ( const Model::DeleteForecastRequest request,
const DeleteForecastResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes a forecast created using the CreateForecast operation. You can delete only forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecast operation.

You can't delete a forecast while it is being exported. After a forecast is deleted, you can no longer query the forecast.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteForecastCallable()

virtual Model::DeleteForecastOutcomeCallable Aws::ForecastService::ForecastServiceClient::DeleteForecastCallable ( const Model::DeleteForecastRequest request) const
virtual

Deletes a forecast created using the CreateForecast operation. You can delete only forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecast operation.

You can't delete a forecast while it is being exported. After a forecast is deleted, you can no longer query the forecast.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteForecastExportJob()

virtual Model::DeleteForecastExportJobOutcome Aws::ForecastService::ForecastServiceClient::DeleteForecastExportJob ( const Model::DeleteForecastExportJobRequest request) const
virtual

Deletes a forecast export job created using the CreateForecastExportJob operation. You can delete only export jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecastExportJob operation.

See Also:

AWS API Reference

◆ DeleteForecastExportJobAsync()

virtual void Aws::ForecastService::ForecastServiceClient::DeleteForecastExportJobAsync ( const Model::DeleteForecastExportJobRequest request,
const DeleteForecastExportJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes a forecast export job created using the CreateForecastExportJob operation. You can delete only export jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecastExportJob operation.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteForecastExportJobCallable()

virtual Model::DeleteForecastExportJobOutcomeCallable Aws::ForecastService::ForecastServiceClient::DeleteForecastExportJobCallable ( const Model::DeleteForecastExportJobRequest request) const
virtual

Deletes a forecast export job created using the CreateForecastExportJob operation. You can delete only export jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecastExportJob operation.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeletePredictor()

virtual Model::DeletePredictorOutcome Aws::ForecastService::ForecastServiceClient::DeletePredictor ( const Model::DeletePredictorRequest request) const
virtual

Deletes a predictor created using the CreatePredictor operation. You can delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribePredictor operation.

See Also:

AWS API Reference

◆ DeletePredictorAsync()

virtual void Aws::ForecastService::ForecastServiceClient::DeletePredictorAsync ( const Model::DeletePredictorRequest request,
const DeletePredictorResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes a predictor created using the CreatePredictor operation. You can delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribePredictor operation.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeletePredictorBacktestExportJob()

virtual Model::DeletePredictorBacktestExportJobOutcome Aws::ForecastService::ForecastServiceClient::DeletePredictorBacktestExportJob ( const Model::DeletePredictorBacktestExportJobRequest request) const
virtual

Deletes a predictor backtest export job.

See Also:

AWS API Reference

◆ DeletePredictorBacktestExportJobAsync()

virtual void Aws::ForecastService::ForecastServiceClient::DeletePredictorBacktestExportJobAsync ( const Model::DeletePredictorBacktestExportJobRequest request,
const DeletePredictorBacktestExportJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes a predictor backtest export job.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeletePredictorBacktestExportJobCallable()

virtual Model::DeletePredictorBacktestExportJobOutcomeCallable Aws::ForecastService::ForecastServiceClient::DeletePredictorBacktestExportJobCallable ( const Model::DeletePredictorBacktestExportJobRequest request) const
virtual

Deletes a predictor backtest export job.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeletePredictorCallable()

virtual Model::DeletePredictorOutcomeCallable Aws::ForecastService::ForecastServiceClient::DeletePredictorCallable ( const Model::DeletePredictorRequest request) const
virtual

Deletes a predictor created using the CreatePredictor operation. You can delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribePredictor operation.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteResourceTree()

virtual Model::DeleteResourceTreeOutcome Aws::ForecastService::ForecastServiceClient::DeleteResourceTree ( const Model::DeleteResourceTreeRequest request) const
virtual

Deletes an entire resource tree. This operation will delete the parent resource and its child resources.

Child resources are resources that were created from another resource. For example, when a forecast is generated from a predictor, the forecast is the child resource and the predictor is the parent resource.

Amazon Forecast resources possess the following parent-child resource hierarchies:

  • Dataset: dataset import jobs

  • Dataset Group: predictors, predictor backtest export jobs, forecasts, forecast export jobs

  • Predictor: predictor backtest export jobs, forecasts, forecast export jobs

  • Forecast: forecast export jobs

DeleteResourceTree will only delete Amazon Forecast resources, and will not delete datasets or exported files stored in Amazon S3.

See Also:

AWS API Reference

◆ DeleteResourceTreeAsync()

virtual void Aws::ForecastService::ForecastServiceClient::DeleteResourceTreeAsync ( const Model::DeleteResourceTreeRequest request,
const DeleteResourceTreeResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes an entire resource tree. This operation will delete the parent resource and its child resources.

Child resources are resources that were created from another resource. For example, when a forecast is generated from a predictor, the forecast is the child resource and the predictor is the parent resource.

Amazon Forecast resources possess the following parent-child resource hierarchies:

  • Dataset: dataset import jobs

  • Dataset Group: predictors, predictor backtest export jobs, forecasts, forecast export jobs

  • Predictor: predictor backtest export jobs, forecasts, forecast export jobs

  • Forecast: forecast export jobs

DeleteResourceTree will only delete Amazon Forecast resources, and will not delete datasets or exported files stored in Amazon S3.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteResourceTreeCallable()

virtual Model::DeleteResourceTreeOutcomeCallable Aws::ForecastService::ForecastServiceClient::DeleteResourceTreeCallable ( const Model::DeleteResourceTreeRequest request) const
virtual

Deletes an entire resource tree. This operation will delete the parent resource and its child resources.

Child resources are resources that were created from another resource. For example, when a forecast is generated from a predictor, the forecast is the child resource and the predictor is the parent resource.

Amazon Forecast resources possess the following parent-child resource hierarchies:

  • Dataset: dataset import jobs

  • Dataset Group: predictors, predictor backtest export jobs, forecasts, forecast export jobs

  • Predictor: predictor backtest export jobs, forecasts, forecast export jobs

  • Forecast: forecast export jobs

DeleteResourceTree will only delete Amazon Forecast resources, and will not delete datasets or exported files stored in Amazon S3.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeDataset()

virtual Model::DescribeDatasetOutcome Aws::ForecastService::ForecastServiceClient::DescribeDataset ( const Model::DescribeDatasetRequest request) const
virtual

Describes an Amazon Forecast dataset created using the CreateDataset operation.

In addition to listing the parameters specified in the CreateDataset request, this operation includes the following dataset properties:

  • CreationTime

  • LastModificationTime

  • Status

See Also:

AWS API Reference

◆ DescribeDatasetAsync()

virtual void Aws::ForecastService::ForecastServiceClient::DescribeDatasetAsync ( const Model::DescribeDatasetRequest request,
const DescribeDatasetResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes an Amazon Forecast dataset created using the CreateDataset operation.

In addition to listing the parameters specified in the CreateDataset request, this operation includes the following dataset properties:

  • CreationTime

  • LastModificationTime

  • Status

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeDatasetCallable()

virtual Model::DescribeDatasetOutcomeCallable Aws::ForecastService::ForecastServiceClient::DescribeDatasetCallable ( const Model::DescribeDatasetRequest request) const
virtual

Describes an Amazon Forecast dataset created using the CreateDataset operation.

In addition to listing the parameters specified in the CreateDataset request, this operation includes the following dataset properties:

  • CreationTime

  • LastModificationTime

  • Status

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeDatasetGroup()

virtual Model::DescribeDatasetGroupOutcome Aws::ForecastService::ForecastServiceClient::DescribeDatasetGroup ( const Model::DescribeDatasetGroupRequest request) const
virtual

Describes a dataset group created using the CreateDatasetGroup operation.

In addition to listing the parameters provided in the CreateDatasetGroup request, this operation includes the following properties:

  • DatasetArns - The datasets belonging to the group.

  • CreationTime

  • LastModificationTime

  • Status

See Also:

AWS API Reference

◆ DescribeDatasetGroupAsync()

virtual void Aws::ForecastService::ForecastServiceClient::DescribeDatasetGroupAsync ( const Model::DescribeDatasetGroupRequest request,
const DescribeDatasetGroupResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes a dataset group created using the CreateDatasetGroup operation.

In addition to listing the parameters provided in the CreateDatasetGroup request, this operation includes the following properties:

  • DatasetArns - The datasets belonging to the group.

  • CreationTime

  • LastModificationTime

  • Status

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeDatasetGroupCallable()

virtual Model::DescribeDatasetGroupOutcomeCallable Aws::ForecastService::ForecastServiceClient::DescribeDatasetGroupCallable ( const Model::DescribeDatasetGroupRequest request) const
virtual

Describes a dataset group created using the CreateDatasetGroup operation.

In addition to listing the parameters provided in the CreateDatasetGroup request, this operation includes the following properties:

  • DatasetArns - The datasets belonging to the group.

  • CreationTime

  • LastModificationTime

  • Status

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeDatasetImportJob()

virtual Model::DescribeDatasetImportJobOutcome Aws::ForecastService::ForecastServiceClient::DescribeDatasetImportJob ( const Model::DescribeDatasetImportJobRequest request) const
virtual

Describes a dataset import job created using the CreateDatasetImportJob operation.

In addition to listing the parameters provided in the CreateDatasetImportJob request, this operation includes the following properties:

  • CreationTime

  • LastModificationTime

  • DataSize

  • FieldStatistics

  • Status

  • Message - If an error occurred, information about the error.

See Also:

AWS API Reference

◆ DescribeDatasetImportJobAsync()

virtual void Aws::ForecastService::ForecastServiceClient::DescribeDatasetImportJobAsync ( const Model::DescribeDatasetImportJobRequest request,
const DescribeDatasetImportJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes a dataset import job created using the CreateDatasetImportJob operation.

In addition to listing the parameters provided in the CreateDatasetImportJob request, this operation includes the following properties:

  • CreationTime

  • LastModificationTime

  • DataSize

  • FieldStatistics

  • Status

  • Message - If an error occurred, information about the error.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeDatasetImportJobCallable()

virtual Model::DescribeDatasetImportJobOutcomeCallable Aws::ForecastService::ForecastServiceClient::DescribeDatasetImportJobCallable ( const Model::DescribeDatasetImportJobRequest request) const
virtual

Describes a dataset import job created using the CreateDatasetImportJob operation.

In addition to listing the parameters provided in the CreateDatasetImportJob request, this operation includes the following properties:

  • CreationTime

  • LastModificationTime

  • DataSize

  • FieldStatistics

  • Status

  • Message - If an error occurred, information about the error.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeForecast()

virtual Model::DescribeForecastOutcome Aws::ForecastService::ForecastServiceClient::DescribeForecast ( const Model::DescribeForecastRequest request) const
virtual

Describes a forecast created using the CreateForecast operation.

In addition to listing the properties provided in the CreateForecast request, this operation lists the following properties:

  • DatasetGroupArn - The dataset group that provided the training data.

  • CreationTime

  • LastModificationTime

  • Status

  • Message - If an error occurred, information about the error.

See Also:

AWS API Reference

◆ DescribeForecastAsync()

virtual void Aws::ForecastService::ForecastServiceClient::DescribeForecastAsync ( const Model::DescribeForecastRequest request,
const DescribeForecastResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes a forecast created using the CreateForecast operation.

In addition to listing the properties provided in the CreateForecast request, this operation lists the following properties:

  • DatasetGroupArn - The dataset group that provided the training data.

  • CreationTime

  • LastModificationTime

  • Status

  • Message - If an error occurred, information about the error.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeForecastCallable()

virtual Model::DescribeForecastOutcomeCallable Aws::ForecastService::ForecastServiceClient::DescribeForecastCallable ( const Model::DescribeForecastRequest request) const
virtual

Describes a forecast created using the CreateForecast operation.

In addition to listing the properties provided in the CreateForecast request, this operation lists the following properties:

  • DatasetGroupArn - The dataset group that provided the training data.

  • CreationTime

  • LastModificationTime

  • Status

  • Message - If an error occurred, information about the error.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeForecastExportJob()

virtual Model::DescribeForecastExportJobOutcome Aws::ForecastService::ForecastServiceClient::DescribeForecastExportJob ( const Model::DescribeForecastExportJobRequest request) const
virtual

Describes a forecast export job created using the CreateForecastExportJob operation.

In addition to listing the properties provided by the user in the CreateForecastExportJob request, this operation lists the following properties:

  • CreationTime

  • LastModificationTime

  • Status

  • Message

    • If an error occurred, information about the error.

See Also:

AWS API Reference

◆ DescribeForecastExportJobAsync()

virtual void Aws::ForecastService::ForecastServiceClient::DescribeForecastExportJobAsync ( const Model::DescribeForecastExportJobRequest request,
const DescribeForecastExportJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes a forecast export job created using the CreateForecastExportJob operation.

In addition to listing the properties provided by the user in the CreateForecastExportJob request, this operation lists the following properties:

  • CreationTime

  • LastModificationTime

  • Status

  • Message

    • If an error occurred, information about the error.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeForecastExportJobCallable()

virtual Model::DescribeForecastExportJobOutcomeCallable Aws::ForecastService::ForecastServiceClient::DescribeForecastExportJobCallable ( const Model::DescribeForecastExportJobRequest request) const
virtual

Describes a forecast export job created using the CreateForecastExportJob operation.

In addition to listing the properties provided by the user in the CreateForecastExportJob request, this operation lists the following properties:

  • CreationTime

  • LastModificationTime

  • Status

  • Message

    • If an error occurred, information about the error.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribePredictor()

virtual Model::DescribePredictorOutcome Aws::ForecastService::ForecastServiceClient::DescribePredictor ( const Model::DescribePredictorRequest request) const
virtual

Describes a predictor created using the CreatePredictor operation.

In addition to listing the properties provided in the CreatePredictor request, this operation lists the following properties:

  • DatasetImportJobArns - The dataset import jobs used to import training data.

  • AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated.

  • CreationTime

  • LastModificationTime

  • Status

  • Message - If an error occurred, information about the error.

See Also:

AWS API Reference

◆ DescribePredictorAsync()

virtual void Aws::ForecastService::ForecastServiceClient::DescribePredictorAsync ( const Model::DescribePredictorRequest request,
const DescribePredictorResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes a predictor created using the CreatePredictor operation.

In addition to listing the properties provided in the CreatePredictor request, this operation lists the following properties:

  • DatasetImportJobArns - The dataset import jobs used to import training data.

  • AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated.

  • CreationTime

  • LastModificationTime

  • Status

  • Message - If an error occurred, information about the error.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribePredictorBacktestExportJob()

virtual Model::DescribePredictorBacktestExportJobOutcome Aws::ForecastService::ForecastServiceClient::DescribePredictorBacktestExportJob ( const Model::DescribePredictorBacktestExportJobRequest request) const
virtual

Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.

In addition to listing the properties provided by the user in the CreatePredictorBacktestExportJob request, this operation lists the following properties:

  • CreationTime

  • LastModificationTime

  • Status

  • Message (if an error occurred)

See Also:

AWS API Reference

◆ DescribePredictorBacktestExportJobAsync()

virtual void Aws::ForecastService::ForecastServiceClient::DescribePredictorBacktestExportJobAsync ( const Model::DescribePredictorBacktestExportJobRequest request,
const DescribePredictorBacktestExportJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.

In addition to listing the properties provided by the user in the CreatePredictorBacktestExportJob request, this operation lists the following properties:

  • CreationTime

  • LastModificationTime

  • Status

  • Message (if an error occurred)

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribePredictorBacktestExportJobCallable()

virtual Model::DescribePredictorBacktestExportJobOutcomeCallable Aws::ForecastService::ForecastServiceClient::DescribePredictorBacktestExportJobCallable ( const Model::DescribePredictorBacktestExportJobRequest request) const
virtual

Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.

In addition to listing the properties provided by the user in the CreatePredictorBacktestExportJob request, this operation lists the following properties:

  • CreationTime

  • LastModificationTime

  • Status

  • Message (if an error occurred)

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribePredictorCallable()

virtual Model::DescribePredictorOutcomeCallable Aws::ForecastService::ForecastServiceClient::DescribePredictorCallable ( const Model::DescribePredictorRequest request) const
virtual

Describes a predictor created using the CreatePredictor operation.

In addition to listing the properties provided in the CreatePredictor request, this operation lists the following properties:

  • DatasetImportJobArns - The dataset import jobs used to import training data.

  • AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated.

  • CreationTime

  • LastModificationTime

  • Status

  • Message - If an error occurred, information about the error.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetAccuracyMetrics()

virtual Model::GetAccuracyMetricsOutcome Aws::ForecastService::ForecastServiceClient::GetAccuracyMetrics ( const Model::GetAccuracyMetricsRequest request) const
virtual

Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation. Use metrics to see how well the model performed and to decide whether to use the predictor to generate a forecast. For more information, see Predictor Metrics.

This operation generates metrics for each backtest window that was evaluated. The number of backtest windows (NumberOfBacktestWindows) is specified using the EvaluationParameters object, which is optionally included in the CreatePredictor request. If NumberOfBacktestWindows isn't specified, the number defaults to one.

The parameters of the filling method determine which items contribute to the metrics. If you want all items to contribute, specify zero. If you want only those items that have complete data in the range being evaluated to contribute, specify nan. For more information, see FeaturizationMethod.

Before you can get accuracy metrics, the Status of the predictor must be ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor operation.

See Also:

AWS API Reference

◆ GetAccuracyMetricsAsync()

virtual void Aws::ForecastService::ForecastServiceClient::GetAccuracyMetricsAsync ( const Model::GetAccuracyMetricsRequest request,
const GetAccuracyMetricsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation. Use metrics to see how well the model performed and to decide whether to use the predictor to generate a forecast. For more information, see Predictor Metrics.

This operation generates metrics for each backtest window that was evaluated. The number of backtest windows (NumberOfBacktestWindows) is specified using the EvaluationParameters object, which is optionally included in the CreatePredictor request. If NumberOfBacktestWindows isn't specified, the number defaults to one.

The parameters of the filling method determine which items contribute to the metrics. If you want all items to contribute, specify zero. If you want only those items that have complete data in the range being evaluated to contribute, specify nan. For more information, see FeaturizationMethod.

Before you can get accuracy metrics, the Status of the predictor must be ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor operation.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetAccuracyMetricsCallable()

virtual Model::GetAccuracyMetricsOutcomeCallable Aws::ForecastService::ForecastServiceClient::GetAccuracyMetricsCallable ( const Model::GetAccuracyMetricsRequest request) const
virtual

Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation. Use metrics to see how well the model performed and to decide whether to use the predictor to generate a forecast. For more information, see Predictor Metrics.

This operation generates metrics for each backtest window that was evaluated. The number of backtest windows (NumberOfBacktestWindows) is specified using the EvaluationParameters object, which is optionally included in the CreatePredictor request. If NumberOfBacktestWindows isn't specified, the number defaults to one.

The parameters of the filling method determine which items contribute to the metrics. If you want all items to contribute, specify zero. If you want only those items that have complete data in the range being evaluated to contribute, specify nan. For more information, see FeaturizationMethod.

Before you can get accuracy metrics, the Status of the predictor must be ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor operation.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListDatasetGroups()

virtual Model::ListDatasetGroupsOutcome Aws::ForecastService::ForecastServiceClient::ListDatasetGroups ( const Model::ListDatasetGroupsRequest request) const
virtual

Returns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the dataset group ARN with the DescribeDatasetGroup operation.

See Also:

AWS API Reference

◆ ListDatasetGroupsAsync()

virtual void Aws::ForecastService::ForecastServiceClient::ListDatasetGroupsAsync ( const Model::ListDatasetGroupsRequest request,
const ListDatasetGroupsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the dataset group ARN with the DescribeDatasetGroup operation.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListDatasetGroupsCallable()

virtual Model::ListDatasetGroupsOutcomeCallable Aws::ForecastService::ForecastServiceClient::ListDatasetGroupsCallable ( const Model::ListDatasetGroupsRequest request) const
virtual

Returns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the dataset group ARN with the DescribeDatasetGroup operation.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListDatasetImportJobs()

virtual Model::ListDatasetImportJobsOutcome Aws::ForecastService::ForecastServiceClient::ListDatasetImportJobs ( const Model::ListDatasetImportJobsRequest request) const
virtual

Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribeDatasetImportJob operation. You can filter the list by providing an array of Filter objects.

See Also:

AWS API Reference

◆ ListDatasetImportJobsAsync()

virtual void Aws::ForecastService::ForecastServiceClient::ListDatasetImportJobsAsync ( const Model::ListDatasetImportJobsRequest request,
const ListDatasetImportJobsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribeDatasetImportJob operation. You can filter the list by providing an array of Filter objects.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListDatasetImportJobsCallable()

virtual Model::ListDatasetImportJobsOutcomeCallable Aws::ForecastService::ForecastServiceClient::ListDatasetImportJobsCallable ( const Model::ListDatasetImportJobsRequest request) const
virtual

Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribeDatasetImportJob operation. You can filter the list by providing an array of Filter objects.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListDatasets()

virtual Model::ListDatasetsOutcome Aws::ForecastService::ForecastServiceClient::ListDatasets ( const Model::ListDatasetsRequest request) const
virtual

Returns a list of datasets created using the CreateDataset operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. To retrieve the complete set of properties, use the ARN with the DescribeDataset operation.

See Also:

AWS API Reference

◆ ListDatasetsAsync()

virtual void Aws::ForecastService::ForecastServiceClient::ListDatasetsAsync ( const Model::ListDatasetsRequest request,
const ListDatasetsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of datasets created using the CreateDataset operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. To retrieve the complete set of properties, use the ARN with the DescribeDataset operation.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListDatasetsCallable()

virtual Model::ListDatasetsOutcomeCallable Aws::ForecastService::ForecastServiceClient::ListDatasetsCallable ( const Model::ListDatasetsRequest request) const
virtual

Returns a list of datasets created using the CreateDataset operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. To retrieve the complete set of properties, use the ARN with the DescribeDataset operation.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListForecastExportJobs()

virtual Model::ListForecastExportJobsOutcome Aws::ForecastService::ForecastServiceClient::ListForecastExportJobs ( const Model::ListForecastExportJobsRequest request) const
virtual

Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the DescribeForecastExportJob operation. You can filter the list using an array of Filter objects.

See Also:

AWS API Reference

◆ ListForecastExportJobsAsync()

virtual void Aws::ForecastService::ForecastServiceClient::ListForecastExportJobsAsync ( const Model::ListForecastExportJobsRequest request,
const ListForecastExportJobsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the DescribeForecastExportJob operation. You can filter the list using an array of Filter objects.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListForecastExportJobsCallable()

virtual Model::ListForecastExportJobsOutcomeCallable Aws::ForecastService::ForecastServiceClient::ListForecastExportJobsCallable ( const Model::ListForecastExportJobsRequest request) const
virtual

Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the DescribeForecastExportJob operation. You can filter the list using an array of Filter objects.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListForecasts()

virtual Model::ListForecastsOutcome Aws::ForecastService::ForecastServiceClient::ListForecasts ( const Model::ListForecastsRequest request) const
virtual

Returns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecast operation. You can filter the list using an array of Filter objects.

See Also:

AWS API Reference

◆ ListForecastsAsync()

virtual void Aws::ForecastService::ForecastServiceClient::ListForecastsAsync ( const Model::ListForecastsRequest request,
const ListForecastsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecast operation. You can filter the list using an array of Filter objects.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListForecastsCallable()

virtual Model::ListForecastsOutcomeCallable Aws::ForecastService::ForecastServiceClient::ListForecastsCallable ( const Model::ListForecastsRequest request) const
virtual

Returns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecast operation. You can filter the list using an array of Filter objects.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListPredictorBacktestExportJobs()

virtual Model::ListPredictorBacktestExportJobsOutcome Aws::ForecastService::ForecastServiceClient::ListPredictorBacktestExportJobs ( const Model::ListPredictorBacktestExportJobsRequest request) const
virtual

Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a summary for each backtest export job. You can filter the list using an array of Filter objects.

To retrieve the complete set of properties for a particular backtest export job, use the ARN with the DescribePredictorBacktestExportJob operation.

See Also:


AWS API Reference

◆ ListPredictorBacktestExportJobsAsync()

virtual void Aws::ForecastService::ForecastServiceClient::ListPredictorBacktestExportJobsAsync ( const Model::ListPredictorBacktestExportJobsRequest request,
const ListPredictorBacktestExportJobsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a summary for each backtest export job. You can filter the list using an array of Filter objects.

To retrieve the complete set of properties for a particular backtest export job, use the ARN with the DescribePredictorBacktestExportJob operation.

See Also:


AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListPredictorBacktestExportJobsCallable()

virtual Model::ListPredictorBacktestExportJobsOutcomeCallable Aws::ForecastService::ForecastServiceClient::ListPredictorBacktestExportJobsCallable ( const Model::ListPredictorBacktestExportJobsRequest request) const
virtual

Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a summary for each backtest export job. You can filter the list using an array of Filter objects.

To retrieve the complete set of properties for a particular backtest export job, use the ARN with the DescribePredictorBacktestExportJob operation.

See Also:


AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListPredictors()

virtual Model::ListPredictorsOutcome Aws::ForecastService::ForecastServiceClient::ListPredictors ( const Model::ListPredictorsRequest request) const
virtual

Returns a list of predictors created using the CreatePredictor operation. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribePredictor operation. You can filter the list using an array of Filter objects.

See Also:

AWS API Reference

◆ ListPredictorsAsync()

virtual void Aws::ForecastService::ForecastServiceClient::ListPredictorsAsync ( const Model::ListPredictorsRequest request,
const ListPredictorsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of predictors created using the CreatePredictor operation. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribePredictor operation. You can filter the list using an array of Filter objects.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListPredictorsCallable()

virtual Model::ListPredictorsOutcomeCallable Aws::ForecastService::ForecastServiceClient::ListPredictorsCallable ( const Model::ListPredictorsRequest request) const
virtual

Returns a list of predictors created using the CreatePredictor operation. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribePredictor operation. You can filter the list using an array of Filter objects.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListTagsForResource()

virtual Model::ListTagsForResourceOutcome Aws::ForecastService::ForecastServiceClient::ListTagsForResource ( const Model::ListTagsForResourceRequest request) const
virtual

Lists the tags for an Amazon Forecast resource.

See Also:

AWS API Reference

◆ ListTagsForResourceAsync()

virtual void Aws::ForecastService::ForecastServiceClient::ListTagsForResourceAsync ( const Model::ListTagsForResourceRequest request,
const ListTagsForResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Lists the tags for an Amazon Forecast resource.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListTagsForResourceCallable()

virtual Model::ListTagsForResourceOutcomeCallable Aws::ForecastService::ForecastServiceClient::ListTagsForResourceCallable ( const Model::ListTagsForResourceRequest request) const
virtual

Lists the tags for an Amazon Forecast resource.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ OverrideEndpoint()

void Aws::ForecastService::ForecastServiceClient::OverrideEndpoint ( const Aws::String endpoint)

◆ StopResource()

virtual Model::StopResourceOutcome Aws::ForecastService::ForecastServiceClient::StopResource ( const Model::StopResourceRequest request) const
virtual

Stops a resource.

The resource undergoes the following states: CREATE_STOPPING and CREATE_STOPPED. You cannot resume a resource once it has been stopped.

This operation can be applied to the following resources (and their corresponding child resources):

  • Dataset Import Job

  • Predictor Job

  • Forecast Job

  • Forecast Export Job

  • Predictor Backtest Export Job

See Also:

AWS API Reference

◆ StopResourceAsync()

virtual void Aws::ForecastService::ForecastServiceClient::StopResourceAsync ( const Model::StopResourceRequest request,
const StopResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Stops a resource.

The resource undergoes the following states: CREATE_STOPPING and CREATE_STOPPED. You cannot resume a resource once it has been stopped.

This operation can be applied to the following resources (and their corresponding child resources):

  • Dataset Import Job

  • Predictor Job

  • Forecast Job

  • Forecast Export Job

  • Predictor Backtest Export Job

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ StopResourceCallable()

virtual Model::StopResourceOutcomeCallable Aws::ForecastService::ForecastServiceClient::StopResourceCallable ( const Model::StopResourceRequest request) const
virtual

Stops a resource.

The resource undergoes the following states: CREATE_STOPPING and CREATE_STOPPED. You cannot resume a resource once it has been stopped.

This operation can be applied to the following resources (and their corresponding child resources):

  • Dataset Import Job

  • Predictor Job

  • Forecast Job

  • Forecast Export Job

  • Predictor Backtest Export Job

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ TagResource()

virtual Model::TagResourceOutcome Aws::ForecastService::ForecastServiceClient::TagResource ( const Model::TagResourceRequest request) const
virtual

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

See Also:


AWS API Reference

◆ TagResourceAsync()

virtual void Aws::ForecastService::ForecastServiceClient::TagResourceAsync ( const Model::TagResourceRequest request,
const TagResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

See Also:


AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ TagResourceCallable()

virtual Model::TagResourceOutcomeCallable Aws::ForecastService::ForecastServiceClient::TagResourceCallable ( const Model::TagResourceRequest request) const
virtual

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

See Also:


AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UntagResource()

virtual Model::UntagResourceOutcome Aws::ForecastService::ForecastServiceClient::UntagResource ( const Model::UntagResourceRequest request) const
virtual

Deletes the specified tags from a resource.

See Also:

AWS API Reference

◆ UntagResourceAsync()

virtual void Aws::ForecastService::ForecastServiceClient::UntagResourceAsync ( const Model::UntagResourceRequest request,
const UntagResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes the specified tags from a resource.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UntagResourceCallable()

virtual Model::UntagResourceOutcomeCallable Aws::ForecastService::ForecastServiceClient::UntagResourceCallable ( const Model::UntagResourceRequest request) const
virtual

Deletes the specified tags from a resource.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UpdateDatasetGroup()

virtual Model::UpdateDatasetGroupOutcome Aws::ForecastService::ForecastServiceClient::UpdateDatasetGroup ( const Model::UpdateDatasetGroupRequest request) const
virtual

Replaces the datasets in a dataset group with the specified datasets.

The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor. Use the DescribeDatasetGroup operation to get the status.

See Also:

AWS API Reference

◆ UpdateDatasetGroupAsync()

virtual void Aws::ForecastService::ForecastServiceClient::UpdateDatasetGroupAsync ( const Model::UpdateDatasetGroupRequest request,
const UpdateDatasetGroupResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Replaces the datasets in a dataset group with the specified datasets.

The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor. Use the DescribeDatasetGroup operation to get the status.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UpdateDatasetGroupCallable()

virtual Model::UpdateDatasetGroupOutcomeCallable Aws::ForecastService::ForecastServiceClient::UpdateDatasetGroupCallable ( const Model::UpdateDatasetGroupRequest request) const
virtual

Replaces the datasets in a dataset group with the specified datasets.

The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor. Use the DescribeDatasetGroup operation to get the status.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.


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