AWS SDK for C++  1.9.104
AWS SDK for C++
Public Types | Public Member Functions | List of all members
Aws::Personalize::PersonalizeClient Class Reference

#include <PersonalizeClient.h>

+ Inheritance diagram for Aws::Personalize::PersonalizeClient:

Public Types

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

Public Member Functions

 PersonalizeClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 PersonalizeClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 PersonalizeClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~PersonalizeClient ()
 
virtual Model::CreateBatchInferenceJobOutcome CreateBatchInferenceJob (const Model::CreateBatchInferenceJobRequest &request) const
 
virtual Model::CreateBatchInferenceJobOutcomeCallable CreateBatchInferenceJobCallable (const Model::CreateBatchInferenceJobRequest &request) const
 
virtual void CreateBatchInferenceJobAsync (const Model::CreateBatchInferenceJobRequest &request, const CreateBatchInferenceJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateCampaignOutcome CreateCampaign (const Model::CreateCampaignRequest &request) const
 
virtual Model::CreateCampaignOutcomeCallable CreateCampaignCallable (const Model::CreateCampaignRequest &request) const
 
virtual void CreateCampaignAsync (const Model::CreateCampaignRequest &request, const CreateCampaignResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
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::CreateDatasetExportJobOutcome CreateDatasetExportJob (const Model::CreateDatasetExportJobRequest &request) const
 
virtual Model::CreateDatasetExportJobOutcomeCallable CreateDatasetExportJobCallable (const Model::CreateDatasetExportJobRequest &request) const
 
virtual void CreateDatasetExportJobAsync (const Model::CreateDatasetExportJobRequest &request, const CreateDatasetExportJobResponseReceivedHandler &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::CreateEventTrackerOutcome CreateEventTracker (const Model::CreateEventTrackerRequest &request) const
 
virtual Model::CreateEventTrackerOutcomeCallable CreateEventTrackerCallable (const Model::CreateEventTrackerRequest &request) const
 
virtual void CreateEventTrackerAsync (const Model::CreateEventTrackerRequest &request, const CreateEventTrackerResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateFilterOutcome CreateFilter (const Model::CreateFilterRequest &request) const
 
virtual Model::CreateFilterOutcomeCallable CreateFilterCallable (const Model::CreateFilterRequest &request) const
 
virtual void CreateFilterAsync (const Model::CreateFilterRequest &request, const CreateFilterResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateSchemaOutcome CreateSchema (const Model::CreateSchemaRequest &request) const
 
virtual Model::CreateSchemaOutcomeCallable CreateSchemaCallable (const Model::CreateSchemaRequest &request) const
 
virtual void CreateSchemaAsync (const Model::CreateSchemaRequest &request, const CreateSchemaResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateSolutionOutcome CreateSolution (const Model::CreateSolutionRequest &request) const
 
virtual Model::CreateSolutionOutcomeCallable CreateSolutionCallable (const Model::CreateSolutionRequest &request) const
 
virtual void CreateSolutionAsync (const Model::CreateSolutionRequest &request, const CreateSolutionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateSolutionVersionOutcome CreateSolutionVersion (const Model::CreateSolutionVersionRequest &request) const
 
virtual Model::CreateSolutionVersionOutcomeCallable CreateSolutionVersionCallable (const Model::CreateSolutionVersionRequest &request) const
 
virtual void CreateSolutionVersionAsync (const Model::CreateSolutionVersionRequest &request, const CreateSolutionVersionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteCampaignOutcome DeleteCampaign (const Model::DeleteCampaignRequest &request) const
 
virtual Model::DeleteCampaignOutcomeCallable DeleteCampaignCallable (const Model::DeleteCampaignRequest &request) const
 
virtual void DeleteCampaignAsync (const Model::DeleteCampaignRequest &request, const DeleteCampaignResponseReceivedHandler &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::DeleteEventTrackerOutcome DeleteEventTracker (const Model::DeleteEventTrackerRequest &request) const
 
virtual Model::DeleteEventTrackerOutcomeCallable DeleteEventTrackerCallable (const Model::DeleteEventTrackerRequest &request) const
 
virtual void DeleteEventTrackerAsync (const Model::DeleteEventTrackerRequest &request, const DeleteEventTrackerResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteFilterOutcome DeleteFilter (const Model::DeleteFilterRequest &request) const
 
virtual Model::DeleteFilterOutcomeCallable DeleteFilterCallable (const Model::DeleteFilterRequest &request) const
 
virtual void DeleteFilterAsync (const Model::DeleteFilterRequest &request, const DeleteFilterResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteSchemaOutcome DeleteSchema (const Model::DeleteSchemaRequest &request) const
 
virtual Model::DeleteSchemaOutcomeCallable DeleteSchemaCallable (const Model::DeleteSchemaRequest &request) const
 
virtual void DeleteSchemaAsync (const Model::DeleteSchemaRequest &request, const DeleteSchemaResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteSolutionOutcome DeleteSolution (const Model::DeleteSolutionRequest &request) const
 
virtual Model::DeleteSolutionOutcomeCallable DeleteSolutionCallable (const Model::DeleteSolutionRequest &request) const
 
virtual void DeleteSolutionAsync (const Model::DeleteSolutionRequest &request, const DeleteSolutionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeAlgorithmOutcome DescribeAlgorithm (const Model::DescribeAlgorithmRequest &request) const
 
virtual Model::DescribeAlgorithmOutcomeCallable DescribeAlgorithmCallable (const Model::DescribeAlgorithmRequest &request) const
 
virtual void DescribeAlgorithmAsync (const Model::DescribeAlgorithmRequest &request, const DescribeAlgorithmResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeBatchInferenceJobOutcome DescribeBatchInferenceJob (const Model::DescribeBatchInferenceJobRequest &request) const
 
virtual Model::DescribeBatchInferenceJobOutcomeCallable DescribeBatchInferenceJobCallable (const Model::DescribeBatchInferenceJobRequest &request) const
 
virtual void DescribeBatchInferenceJobAsync (const Model::DescribeBatchInferenceJobRequest &request, const DescribeBatchInferenceJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeCampaignOutcome DescribeCampaign (const Model::DescribeCampaignRequest &request) const
 
virtual Model::DescribeCampaignOutcomeCallable DescribeCampaignCallable (const Model::DescribeCampaignRequest &request) const
 
virtual void DescribeCampaignAsync (const Model::DescribeCampaignRequest &request, const DescribeCampaignResponseReceivedHandler &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::DescribeDatasetExportJobOutcome DescribeDatasetExportJob (const Model::DescribeDatasetExportJobRequest &request) const
 
virtual Model::DescribeDatasetExportJobOutcomeCallable DescribeDatasetExportJobCallable (const Model::DescribeDatasetExportJobRequest &request) const
 
virtual void DescribeDatasetExportJobAsync (const Model::DescribeDatasetExportJobRequest &request, const DescribeDatasetExportJobResponseReceivedHandler &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::DescribeEventTrackerOutcome DescribeEventTracker (const Model::DescribeEventTrackerRequest &request) const
 
virtual Model::DescribeEventTrackerOutcomeCallable DescribeEventTrackerCallable (const Model::DescribeEventTrackerRequest &request) const
 
virtual void DescribeEventTrackerAsync (const Model::DescribeEventTrackerRequest &request, const DescribeEventTrackerResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeFeatureTransformationOutcome DescribeFeatureTransformation (const Model::DescribeFeatureTransformationRequest &request) const
 
virtual Model::DescribeFeatureTransformationOutcomeCallable DescribeFeatureTransformationCallable (const Model::DescribeFeatureTransformationRequest &request) const
 
virtual void DescribeFeatureTransformationAsync (const Model::DescribeFeatureTransformationRequest &request, const DescribeFeatureTransformationResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeFilterOutcome DescribeFilter (const Model::DescribeFilterRequest &request) const
 
virtual Model::DescribeFilterOutcomeCallable DescribeFilterCallable (const Model::DescribeFilterRequest &request) const
 
virtual void DescribeFilterAsync (const Model::DescribeFilterRequest &request, const DescribeFilterResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeRecipeOutcome DescribeRecipe (const Model::DescribeRecipeRequest &request) const
 
virtual Model::DescribeRecipeOutcomeCallable DescribeRecipeCallable (const Model::DescribeRecipeRequest &request) const
 
virtual void DescribeRecipeAsync (const Model::DescribeRecipeRequest &request, const DescribeRecipeResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeSchemaOutcome DescribeSchema (const Model::DescribeSchemaRequest &request) const
 
virtual Model::DescribeSchemaOutcomeCallable DescribeSchemaCallable (const Model::DescribeSchemaRequest &request) const
 
virtual void DescribeSchemaAsync (const Model::DescribeSchemaRequest &request, const DescribeSchemaResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeSolutionOutcome DescribeSolution (const Model::DescribeSolutionRequest &request) const
 
virtual Model::DescribeSolutionOutcomeCallable DescribeSolutionCallable (const Model::DescribeSolutionRequest &request) const
 
virtual void DescribeSolutionAsync (const Model::DescribeSolutionRequest &request, const DescribeSolutionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeSolutionVersionOutcome DescribeSolutionVersion (const Model::DescribeSolutionVersionRequest &request) const
 
virtual Model::DescribeSolutionVersionOutcomeCallable DescribeSolutionVersionCallable (const Model::DescribeSolutionVersionRequest &request) const
 
virtual void DescribeSolutionVersionAsync (const Model::DescribeSolutionVersionRequest &request, const DescribeSolutionVersionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetSolutionMetricsOutcome GetSolutionMetrics (const Model::GetSolutionMetricsRequest &request) const
 
virtual Model::GetSolutionMetricsOutcomeCallable GetSolutionMetricsCallable (const Model::GetSolutionMetricsRequest &request) const
 
virtual void GetSolutionMetricsAsync (const Model::GetSolutionMetricsRequest &request, const GetSolutionMetricsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListBatchInferenceJobsOutcome ListBatchInferenceJobs (const Model::ListBatchInferenceJobsRequest &request) const
 
virtual Model::ListBatchInferenceJobsOutcomeCallable ListBatchInferenceJobsCallable (const Model::ListBatchInferenceJobsRequest &request) const
 
virtual void ListBatchInferenceJobsAsync (const Model::ListBatchInferenceJobsRequest &request, const ListBatchInferenceJobsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListCampaignsOutcome ListCampaigns (const Model::ListCampaignsRequest &request) const
 
virtual Model::ListCampaignsOutcomeCallable ListCampaignsCallable (const Model::ListCampaignsRequest &request) const
 
virtual void ListCampaignsAsync (const Model::ListCampaignsRequest &request, const ListCampaignsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListDatasetExportJobsOutcome ListDatasetExportJobs (const Model::ListDatasetExportJobsRequest &request) const
 
virtual Model::ListDatasetExportJobsOutcomeCallable ListDatasetExportJobsCallable (const Model::ListDatasetExportJobsRequest &request) const
 
virtual void ListDatasetExportJobsAsync (const Model::ListDatasetExportJobsRequest &request, const ListDatasetExportJobsResponseReceivedHandler &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::ListEventTrackersOutcome ListEventTrackers (const Model::ListEventTrackersRequest &request) const
 
virtual Model::ListEventTrackersOutcomeCallable ListEventTrackersCallable (const Model::ListEventTrackersRequest &request) const
 
virtual void ListEventTrackersAsync (const Model::ListEventTrackersRequest &request, const ListEventTrackersResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListFiltersOutcome ListFilters (const Model::ListFiltersRequest &request) const
 
virtual Model::ListFiltersOutcomeCallable ListFiltersCallable (const Model::ListFiltersRequest &request) const
 
virtual void ListFiltersAsync (const Model::ListFiltersRequest &request, const ListFiltersResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListRecipesOutcome ListRecipes (const Model::ListRecipesRequest &request) const
 
virtual Model::ListRecipesOutcomeCallable ListRecipesCallable (const Model::ListRecipesRequest &request) const
 
virtual void ListRecipesAsync (const Model::ListRecipesRequest &request, const ListRecipesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListSchemasOutcome ListSchemas (const Model::ListSchemasRequest &request) const
 
virtual Model::ListSchemasOutcomeCallable ListSchemasCallable (const Model::ListSchemasRequest &request) const
 
virtual void ListSchemasAsync (const Model::ListSchemasRequest &request, const ListSchemasResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListSolutionVersionsOutcome ListSolutionVersions (const Model::ListSolutionVersionsRequest &request) const
 
virtual Model::ListSolutionVersionsOutcomeCallable ListSolutionVersionsCallable (const Model::ListSolutionVersionsRequest &request) const
 
virtual void ListSolutionVersionsAsync (const Model::ListSolutionVersionsRequest &request, const ListSolutionVersionsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListSolutionsOutcome ListSolutions (const Model::ListSolutionsRequest &request) const
 
virtual Model::ListSolutionsOutcomeCallable ListSolutionsCallable (const Model::ListSolutionsRequest &request) const
 
virtual void ListSolutionsAsync (const Model::ListSolutionsRequest &request, const ListSolutionsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::StopSolutionVersionCreationOutcome StopSolutionVersionCreation (const Model::StopSolutionVersionCreationRequest &request) const
 
virtual Model::StopSolutionVersionCreationOutcomeCallable StopSolutionVersionCreationCallable (const Model::StopSolutionVersionCreationRequest &request) const
 
virtual void StopSolutionVersionCreationAsync (const Model::StopSolutionVersionCreationRequest &request, const StopSolutionVersionCreationResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateCampaignOutcome UpdateCampaign (const Model::UpdateCampaignRequest &request) const
 
virtual Model::UpdateCampaignOutcomeCallable UpdateCampaignCallable (const Model::UpdateCampaignRequest &request) const
 
virtual void UpdateCampaignAsync (const Model::UpdateCampaignRequest &request, const UpdateCampaignResponseReceivedHandler &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

Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.

Definition at line 292 of file PersonalizeClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 295 of file PersonalizeClient.h.

Constructor & Destructor Documentation

◆ PersonalizeClient() [1/3]

Aws::Personalize::PersonalizeClient::PersonalizeClient ( 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.

◆ PersonalizeClient() [2/3]

Aws::Personalize::PersonalizeClient::PersonalizeClient ( 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.

◆ PersonalizeClient() [3/3]

Aws::Personalize::PersonalizeClient::PersonalizeClient ( 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

◆ ~PersonalizeClient()

virtual Aws::Personalize::PersonalizeClient::~PersonalizeClient ( )
virtual

Member Function Documentation

◆ CreateBatchInferenceJob()

virtual Model::CreateBatchInferenceJobOutcome Aws::Personalize::PersonalizeClient::CreateBatchInferenceJob ( const Model::CreateBatchInferenceJobRequest request) const
virtual

Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see recommendations-batch.

See Also:

AWS API Reference

◆ CreateBatchInferenceJobAsync()

virtual void Aws::Personalize::PersonalizeClient::CreateBatchInferenceJobAsync ( const Model::CreateBatchInferenceJobRequest request,
const CreateBatchInferenceJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see recommendations-batch.

See Also:

AWS API Reference

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

◆ CreateBatchInferenceJobCallable()

virtual Model::CreateBatchInferenceJobOutcomeCallable Aws::Personalize::PersonalizeClient::CreateBatchInferenceJobCallable ( const Model::CreateBatchInferenceJobRequest request) const
virtual

Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see recommendations-batch.

See Also:

AWS API Reference

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

◆ CreateCampaign()

virtual Model::CreateCampaignOutcome Aws::Personalize::PersonalizeClient::CreateCampaign ( const Model::CreateCampaignRequest request) const
virtual

Creates a campaign by deploying a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.

Minimum Provisioned TPS and Auto-Scaling

A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge.

If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions.

The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

Status

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the campaign status, call DescribeCampaign.

Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.

Related APIs

  • ListCampaigns

  • DescribeCampaign

  • UpdateCampaign

  • DeleteCampaign

See Also:

AWS API Reference

◆ CreateCampaignAsync()

virtual void Aws::Personalize::PersonalizeClient::CreateCampaignAsync ( const Model::CreateCampaignRequest request,
const CreateCampaignResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates a campaign by deploying a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.

Minimum Provisioned TPS and Auto-Scaling

A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge.

If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions.

The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

Status

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the campaign status, call DescribeCampaign.

Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.

Related APIs

  • ListCampaigns

  • DescribeCampaign

  • UpdateCampaign

  • DeleteCampaign

See Also:

AWS API Reference

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

◆ CreateCampaignCallable()

virtual Model::CreateCampaignOutcomeCallable Aws::Personalize::PersonalizeClient::CreateCampaignCallable ( const Model::CreateCampaignRequest request) const
virtual

Creates a campaign by deploying a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.

Minimum Provisioned TPS and Auto-Scaling

A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge.

If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions.

The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

Status

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the campaign status, call DescribeCampaign.

Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.

Related APIs

  • ListCampaigns

  • DescribeCampaign

  • UpdateCampaign

  • DeleteCampaign

See Also:

AWS API Reference

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

◆ CreateDataset()

virtual Model::CreateDatasetOutcome Aws::Personalize::PersonalizeClient::CreateDataset ( const Model::CreateDatasetRequest request) const
virtual

Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.

There are three types of datasets:

  • Interactions

  • Items

  • Users

Each dataset type has an associated schema with required field types. Only the Interactions dataset is required in order to train a model (also referred to as creating a solution).

A dataset can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the dataset, call DescribeDataset.

Related APIs

  • CreateDatasetGroup

  • ListDatasets

  • DescribeDataset

  • DeleteDataset

See Also:

AWS API Reference

◆ CreateDatasetAsync()

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

Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.

There are three types of datasets:

  • Interactions

  • Items

  • Users

Each dataset type has an associated schema with required field types. Only the Interactions dataset is required in order to train a model (also referred to as creating a solution).

A dataset can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the dataset, call DescribeDataset.

Related APIs

  • CreateDatasetGroup

  • ListDatasets

  • DescribeDataset

  • DeleteDataset

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::Personalize::PersonalizeClient::CreateDatasetCallable ( const Model::CreateDatasetRequest request) const
virtual

Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.

There are three types of datasets:

  • Interactions

  • Items

  • Users

Each dataset type has an associated schema with required field types. Only the Interactions dataset is required in order to train a model (also referred to as creating a solution).

A dataset can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the dataset, call DescribeDataset.

Related APIs

  • CreateDatasetGroup

  • ListDatasets

  • DescribeDataset

  • DeleteDataset

See Also:

AWS API Reference

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

◆ CreateDatasetExportJob()

virtual Model::CreateDatasetExportJobOutcome Aws::Personalize::PersonalizeClient::CreateDatasetExportJob ( const Model::CreateDatasetExportJobRequest request) const
virtual

Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide.

Status

A dataset export job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

See Also:

AWS API Reference

◆ CreateDatasetExportJobAsync()

virtual void Aws::Personalize::PersonalizeClient::CreateDatasetExportJobAsync ( const Model::CreateDatasetExportJobRequest request,
const CreateDatasetExportJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide.

Status

A dataset export job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

See Also:

AWS API Reference

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

◆ CreateDatasetExportJobCallable()

virtual Model::CreateDatasetExportJobOutcomeCallable Aws::Personalize::PersonalizeClient::CreateDatasetExportJobCallable ( const Model::CreateDatasetExportJobRequest request) const
virtual

Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide.

Status

A dataset export job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

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::Personalize::PersonalizeClient::CreateDatasetGroup ( const Model::CreateDatasetGroupRequest request) const
virtual

Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset:

  • Interactions

  • Items

  • Users

To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group.

A dataset group can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING

To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed.

You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group.

You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.

APIs that require a dataset group ARN in the request

  • CreateDataset

  • CreateEventTracker

  • CreateSolution

Related APIs

  • ListDatasetGroups

  • DescribeDatasetGroup

  • DeleteDatasetGroup

See Also:

AWS API Reference

◆ CreateDatasetGroupAsync()

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

Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset:

  • Interactions

  • Items

  • Users

To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group.

A dataset group can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING

To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed.

You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group.

You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.

APIs that require a dataset group ARN in the request

  • CreateDataset

  • CreateEventTracker

  • CreateSolution

Related APIs

  • ListDatasetGroups

  • DescribeDatasetGroup

  • DeleteDatasetGroup

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::Personalize::PersonalizeClient::CreateDatasetGroupCallable ( const Model::CreateDatasetGroupRequest request) const
virtual

Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset:

  • Interactions

  • Items

  • Users

To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group.

A dataset group can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING

To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed.

You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group.

You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.

APIs that require a dataset group ARN in the request

  • CreateDataset

  • CreateEventTracker

  • CreateSolution

Related APIs

  • ListDatasetGroups

  • DescribeDatasetGroup

  • DeleteDatasetGroup

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::Personalize::PersonalizeClient::CreateDatasetImportJob ( const Model::CreateDatasetImportJobRequest request) const
virtual

Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.

The dataset import job replaces any existing data in the dataset that you imported in bulk.

Status

A dataset import job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.

Related APIs

  • ListDatasetImportJobs

  • DescribeDatasetImportJob

See Also:

AWS API Reference

◆ CreateDatasetImportJobAsync()

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

Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.

The dataset import job replaces any existing data in the dataset that you imported in bulk.

Status

A dataset import job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.

Related APIs

  • ListDatasetImportJobs

  • DescribeDatasetImportJob

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::Personalize::PersonalizeClient::CreateDatasetImportJobCallable ( const Model::CreateDatasetImportJobRequest request) const
virtual

Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.

The dataset import job replaces any existing data in the dataset that you imported in bulk.

Status

A dataset import job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.

Related APIs

  • ListDatasetImportJobs

  • DescribeDatasetImportJob

See Also:

AWS API Reference

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

◆ CreateEventTracker()

virtual Model::CreateEventTrackerOutcome Aws::Personalize::PersonalizeClient::CreateEventTracker ( const Model::CreateEventTrackerRequest request) const
virtual

Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.

Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker.

When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Interactions dataset of the dataset group you specify in your event tracker.

The event tracker can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the event tracker, call DescribeEventTracker.

The event tracker must be in the ACTIVE state before using the tracking ID.

Related APIs

  • ListEventTrackers

  • DescribeEventTracker

  • DeleteEventTracker

See Also:

AWS API Reference

◆ CreateEventTrackerAsync()

virtual void Aws::Personalize::PersonalizeClient::CreateEventTrackerAsync ( const Model::CreateEventTrackerRequest request,
const CreateEventTrackerResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.

Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker.

When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Interactions dataset of the dataset group you specify in your event tracker.

The event tracker can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the event tracker, call DescribeEventTracker.

The event tracker must be in the ACTIVE state before using the tracking ID.

Related APIs

  • ListEventTrackers

  • DescribeEventTracker

  • DeleteEventTracker

See Also:

AWS API Reference

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

◆ CreateEventTrackerCallable()

virtual Model::CreateEventTrackerOutcomeCallable Aws::Personalize::PersonalizeClient::CreateEventTrackerCallable ( const Model::CreateEventTrackerRequest request) const
virtual

Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.

Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker.

When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Interactions dataset of the dataset group you specify in your event tracker.

The event tracker can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the event tracker, call DescribeEventTracker.

The event tracker must be in the ACTIVE state before using the tracking ID.

Related APIs

  • ListEventTrackers

  • DescribeEventTracker

  • DeleteEventTracker

See Also:

AWS API Reference

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

◆ CreateFilter()

virtual Model::CreateFilterOutcome Aws::Personalize::PersonalizeClient::CreateFilter ( const Model::CreateFilterRequest request) const
virtual

Creates a recommendation filter. For more information, see filter.

See Also:

AWS API Reference

◆ CreateFilterAsync()

virtual void Aws::Personalize::PersonalizeClient::CreateFilterAsync ( const Model::CreateFilterRequest request,
const CreateFilterResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates a recommendation filter. For more information, see filter.

See Also:

AWS API Reference

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

◆ CreateFilterCallable()

virtual Model::CreateFilterOutcomeCallable Aws::Personalize::PersonalizeClient::CreateFilterCallable ( const Model::CreateFilterRequest request) const
virtual

Creates a recommendation filter. For more information, see filter.

See Also:

AWS API Reference

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

◆ CreateSchema()

virtual Model::CreateSchemaOutcome Aws::Personalize::PersonalizeClient::CreateSchema ( const Model::CreateSchemaRequest request) const
virtual

Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.

Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. You specify a schema when you call CreateDataset.

Related APIs

  • ListSchemas

  • DescribeSchema

  • DeleteSchema

See Also:

AWS API Reference

◆ CreateSchemaAsync()

virtual void Aws::Personalize::PersonalizeClient::CreateSchemaAsync ( const Model::CreateSchemaRequest request,
const CreateSchemaResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.

Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. You specify a schema when you call CreateDataset.

Related APIs

  • ListSchemas

  • DescribeSchema

  • DeleteSchema

See Also:

AWS API Reference

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

◆ CreateSchemaCallable()

virtual Model::CreateSchemaOutcomeCallable Aws::Personalize::PersonalizeClient::CreateSchemaCallable ( const Model::CreateSchemaRequest request) const
virtual

Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.

Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. You specify a schema when you call CreateDataset.

Related APIs

  • ListSchemas

  • DescribeSchema

  • DeleteSchema

See Also:

AWS API Reference

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

◆ CreateSolution()

virtual Model::CreateSolutionOutcome Aws::Personalize::PersonalizeClient::CreateSolution ( const Model::CreateSolutionRequest request) const
virtual

Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every time you call CreateSolutionVersion, a new version of the solution is created.

After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.

To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you can specify performAutoML and Amazon Personalize will analyze your data and select the optimum USER_PERSONALIZATION recipe for you.

Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter optimization at this time.

Status

A solution can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion.

Related APIs

  • ListSolutions

  • CreateSolutionVersion

  • DescribeSolution

  • DeleteSolution

  • ListSolutionVersions

  • DescribeSolutionVersion

See Also:

AWS API Reference

◆ CreateSolutionAsync()

virtual void Aws::Personalize::PersonalizeClient::CreateSolutionAsync ( const Model::CreateSolutionRequest request,
const CreateSolutionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every time you call CreateSolutionVersion, a new version of the solution is created.

After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.

To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you can specify performAutoML and Amazon Personalize will analyze your data and select the optimum USER_PERSONALIZATION recipe for you.

Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter optimization at this time.

Status

A solution can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion.

Related APIs

  • ListSolutions

  • CreateSolutionVersion

  • DescribeSolution

  • DeleteSolution

  • ListSolutionVersions

  • DescribeSolutionVersion

See Also:

AWS API Reference

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

◆ CreateSolutionCallable()

virtual Model::CreateSolutionOutcomeCallable Aws::Personalize::PersonalizeClient::CreateSolutionCallable ( const Model::CreateSolutionRequest request) const
virtual

Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every time you call CreateSolutionVersion, a new version of the solution is created.

After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.

To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you can specify performAutoML and Amazon Personalize will analyze your data and select the optimum USER_PERSONALIZATION recipe for you.

Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter optimization at this time.

Status

A solution can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion.

Related APIs

  • ListSolutions

  • CreateSolutionVersion

  • DescribeSolution

  • DeleteSolution

  • ListSolutionVersions

  • DescribeSolutionVersion

See Also:

AWS API Reference

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

◆ CreateSolutionVersion()

virtual Model::CreateSolutionVersionOutcome Aws::Personalize::PersonalizeClient::CreateSolutionVersion ( const Model::CreateSolutionVersionRequest request) const
virtual

Trains or retrains an active solution. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation.

Status

A solution version can be in one of the following states:

  • CREATE PENDING

  • CREATE IN_PROGRESS

  • ACTIVE

  • CREATE FAILED

  • CREATE STOPPING

  • CREATE STOPPED

To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign.

If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Related APIs

  • ListSolutionVersions

  • DescribeSolutionVersion

  • ListSolutions

  • CreateSolution

  • DescribeSolution

  • DeleteSolution

See Also:

AWS API Reference

◆ CreateSolutionVersionAsync()

virtual void Aws::Personalize::PersonalizeClient::CreateSolutionVersionAsync ( const Model::CreateSolutionVersionRequest request,
const CreateSolutionVersionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Trains or retrains an active solution. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation.

Status

A solution version can be in one of the following states:

  • CREATE PENDING

  • CREATE IN_PROGRESS

  • ACTIVE

  • CREATE FAILED

  • CREATE STOPPING

  • CREATE STOPPED

To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign.

If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Related APIs

  • ListSolutionVersions

  • DescribeSolutionVersion

  • ListSolutions

  • CreateSolution

  • DescribeSolution

  • DeleteSolution

See Also:

AWS API Reference

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

◆ CreateSolutionVersionCallable()

virtual Model::CreateSolutionVersionOutcomeCallable Aws::Personalize::PersonalizeClient::CreateSolutionVersionCallable ( const Model::CreateSolutionVersionRequest request) const
virtual

Trains or retrains an active solution. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation.

Status

A solution version can be in one of the following states:

  • CREATE PENDING

  • CREATE IN_PROGRESS

  • ACTIVE

  • CREATE FAILED

  • CREATE STOPPING

  • CREATE STOPPED

To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign.

If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Related APIs

  • ListSolutionVersions

  • DescribeSolutionVersion

  • ListSolutions

  • CreateSolution

  • DescribeSolution

  • DeleteSolution

See Also:

AWS API Reference

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

◆ DeleteCampaign()

virtual Model::DeleteCampaignOutcome Aws::Personalize::PersonalizeClient::DeleteCampaign ( const Model::DeleteCampaignRequest request) const
virtual

Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For more information on campaigns, see CreateCampaign.

See Also:

AWS API Reference

◆ DeleteCampaignAsync()

virtual void Aws::Personalize::PersonalizeClient::DeleteCampaignAsync ( const Model::DeleteCampaignRequest request,
const DeleteCampaignResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For more information on campaigns, see CreateCampaign.

See Also:

AWS API Reference

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

◆ DeleteCampaignCallable()

virtual Model::DeleteCampaignOutcomeCallable Aws::Personalize::PersonalizeClient::DeleteCampaignCallable ( const Model::DeleteCampaignRequest request) const
virtual

Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For more information on campaigns, see CreateCampaign.

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::Personalize::PersonalizeClient::DeleteDataset ( const Model::DeleteDatasetRequest request) const
virtual

Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.

See Also:

AWS API Reference

◆ DeleteDatasetAsync()

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

Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.

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::Personalize::PersonalizeClient::DeleteDatasetCallable ( const Model::DeleteDatasetRequest request) const
virtual

Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.

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::Personalize::PersonalizeClient::DeleteDatasetGroup ( const Model::DeleteDatasetGroupRequest request) const
virtual

Deletes a dataset group. Before you delete a dataset group, you must delete the following:

  • All associated event trackers.

  • All associated solutions.

  • All datasets in the dataset group.

See Also:

AWS API Reference

◆ DeleteDatasetGroupAsync()

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

Deletes a dataset group. Before you delete a dataset group, you must delete the following:

  • All associated event trackers.

  • All associated solutions.

  • All datasets in the dataset 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::Personalize::PersonalizeClient::DeleteDatasetGroupCallable ( const Model::DeleteDatasetGroupRequest request) const
virtual

Deletes a dataset group. Before you delete a dataset group, you must delete the following:

  • All associated event trackers.

  • All associated solutions.

  • All datasets in the dataset group.

See Also:

AWS API Reference

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

◆ DeleteEventTracker()

virtual Model::DeleteEventTrackerOutcome Aws::Personalize::PersonalizeClient::DeleteEventTracker ( const Model::DeleteEventTrackerRequest request) const
virtual

Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.

See Also:

AWS API Reference

◆ DeleteEventTrackerAsync()

virtual void Aws::Personalize::PersonalizeClient::DeleteEventTrackerAsync ( const Model::DeleteEventTrackerRequest request,
const DeleteEventTrackerResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.

See Also:

AWS API Reference

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

◆ DeleteEventTrackerCallable()

virtual Model::DeleteEventTrackerOutcomeCallable Aws::Personalize::PersonalizeClient::DeleteEventTrackerCallable ( const Model::DeleteEventTrackerRequest request) const
virtual

Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.

See Also:

AWS API Reference

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

◆ DeleteFilter()

virtual Model::DeleteFilterOutcome Aws::Personalize::PersonalizeClient::DeleteFilter ( const Model::DeleteFilterRequest request) const
virtual

Deletes a filter.

See Also:

AWS API Reference

◆ DeleteFilterAsync()

virtual void Aws::Personalize::PersonalizeClient::DeleteFilterAsync ( const Model::DeleteFilterRequest request,
const DeleteFilterResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes a filter.

See Also:

AWS API Reference

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

◆ DeleteFilterCallable()

virtual Model::DeleteFilterOutcomeCallable Aws::Personalize::PersonalizeClient::DeleteFilterCallable ( const Model::DeleteFilterRequest request) const
virtual

Deletes a filter.

See Also:

AWS API Reference

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

◆ DeleteSchema()

virtual Model::DeleteSchemaOutcome Aws::Personalize::PersonalizeClient::DeleteSchema ( const Model::DeleteSchemaRequest request) const
virtual

Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.

See Also:

AWS API Reference

◆ DeleteSchemaAsync()

virtual void Aws::Personalize::PersonalizeClient::DeleteSchemaAsync ( const Model::DeleteSchemaRequest request,
const DeleteSchemaResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.

See Also:

AWS API Reference

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

◆ DeleteSchemaCallable()

virtual Model::DeleteSchemaOutcomeCallable Aws::Personalize::PersonalizeClient::DeleteSchemaCallable ( const Model::DeleteSchemaRequest request) const
virtual

Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.

See Also:

AWS API Reference

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

◆ DeleteSolution()

virtual Model::DeleteSolutionOutcome Aws::Personalize::PersonalizeClient::DeleteSolution ( const Model::DeleteSolutionRequest request) const
virtual

Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.

See Also:

AWS API Reference

◆ DeleteSolutionAsync()

virtual void Aws::Personalize::PersonalizeClient::DeleteSolutionAsync ( const Model::DeleteSolutionRequest request,
const DeleteSolutionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.

See Also:

AWS API Reference

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

◆ DeleteSolutionCallable()

virtual Model::DeleteSolutionOutcomeCallable Aws::Personalize::PersonalizeClient::DeleteSolutionCallable ( const Model::DeleteSolutionRequest request) const
virtual

Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.

See Also:

AWS API Reference

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

◆ DescribeAlgorithm()

virtual Model::DescribeAlgorithmOutcome Aws::Personalize::PersonalizeClient::DescribeAlgorithm ( const Model::DescribeAlgorithmRequest request) const
virtual

Describes the given algorithm.

See Also:

AWS API Reference

◆ DescribeAlgorithmAsync()

virtual void Aws::Personalize::PersonalizeClient::DescribeAlgorithmAsync ( const Model::DescribeAlgorithmRequest request,
const DescribeAlgorithmResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes the given algorithm.

See Also:

AWS API Reference

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

◆ DescribeAlgorithmCallable()

virtual Model::DescribeAlgorithmOutcomeCallable Aws::Personalize::PersonalizeClient::DescribeAlgorithmCallable ( const Model::DescribeAlgorithmRequest request) const
virtual

Describes the given algorithm.

See Also:

AWS API Reference

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

◆ DescribeBatchInferenceJob()

virtual Model::DescribeBatchInferenceJobOutcome Aws::Personalize::PersonalizeClient::DescribeBatchInferenceJob ( const Model::DescribeBatchInferenceJobRequest request) const
virtual

Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.

See Also:

AWS API Reference

◆ DescribeBatchInferenceJobAsync()

virtual void Aws::Personalize::PersonalizeClient::DescribeBatchInferenceJobAsync ( const Model::DescribeBatchInferenceJobRequest request,
const DescribeBatchInferenceJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.

See Also:

AWS API Reference

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

◆ DescribeBatchInferenceJobCallable()

virtual Model::DescribeBatchInferenceJobOutcomeCallable Aws::Personalize::PersonalizeClient::DescribeBatchInferenceJobCallable ( const Model::DescribeBatchInferenceJobRequest request) const
virtual

Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.

See Also:

AWS API Reference

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

◆ DescribeCampaign()

virtual Model::DescribeCampaignOutcome Aws::Personalize::PersonalizeClient::DescribeCampaign ( const Model::DescribeCampaignRequest request) const
virtual

Describes the given campaign, including its status.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

For more information on campaigns, see CreateCampaign.

See Also:

AWS API Reference

◆ DescribeCampaignAsync()

virtual void Aws::Personalize::PersonalizeClient::DescribeCampaignAsync ( const Model::DescribeCampaignRequest request,
const DescribeCampaignResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes the given campaign, including its status.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

For more information on campaigns, see CreateCampaign.

See Also:

AWS API Reference

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

◆ DescribeCampaignCallable()

virtual Model::DescribeCampaignOutcomeCallable Aws::Personalize::PersonalizeClient::DescribeCampaignCallable ( const Model::DescribeCampaignRequest request) const
virtual

Describes the given campaign, including its status.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

For more information on campaigns, see CreateCampaign.

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::Personalize::PersonalizeClient::DescribeDataset ( const Model::DescribeDatasetRequest request) const
virtual

Describes the given dataset. For more information on datasets, see CreateDataset.

See Also:

AWS API Reference

◆ DescribeDatasetAsync()

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

Describes the given dataset. For more information on datasets, see CreateDataset.

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::Personalize::PersonalizeClient::DescribeDatasetCallable ( const Model::DescribeDatasetRequest request) const
virtual

Describes the given dataset. For more information on datasets, see CreateDataset.

See Also:

AWS API Reference

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

◆ DescribeDatasetExportJob()

virtual Model::DescribeDatasetExportJobOutcome Aws::Personalize::PersonalizeClient::DescribeDatasetExportJob ( const Model::DescribeDatasetExportJobRequest request) const
virtual

Describes the dataset export job created by CreateDatasetExportJob, including the export job status.

See Also:

AWS API Reference

◆ DescribeDatasetExportJobAsync()

virtual void Aws::Personalize::PersonalizeClient::DescribeDatasetExportJobAsync ( const Model::DescribeDatasetExportJobRequest request,
const DescribeDatasetExportJobResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes the dataset export job created by CreateDatasetExportJob, including the export job status.

See Also:

AWS API Reference

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

◆ DescribeDatasetExportJobCallable()

virtual Model::DescribeDatasetExportJobOutcomeCallable Aws::Personalize::PersonalizeClient::DescribeDatasetExportJobCallable ( const Model::DescribeDatasetExportJobRequest request) const
virtual

Describes the dataset export job created by CreateDatasetExportJob, including the export job 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::Personalize::PersonalizeClient::DescribeDatasetGroup ( const Model::DescribeDatasetGroupRequest request) const
virtual

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

See Also:

AWS API Reference

◆ DescribeDatasetGroupAsync()

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

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

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::Personalize::PersonalizeClient::DescribeDatasetGroupCallable ( const Model::DescribeDatasetGroupRequest request) const
virtual

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

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::Personalize::PersonalizeClient::DescribeDatasetImportJob ( const Model::DescribeDatasetImportJobRequest request) const
virtual

Describes the dataset import job created by CreateDatasetImportJob, including the import job status.

See Also:

AWS API Reference

◆ DescribeDatasetImportJobAsync()

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

Describes the dataset import job created by CreateDatasetImportJob, including the import job status.

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::Personalize::PersonalizeClient::DescribeDatasetImportJobCallable ( const Model::DescribeDatasetImportJobRequest request) const
virtual

Describes the dataset import job created by CreateDatasetImportJob, including the import job status.

See Also:

AWS API Reference

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

◆ DescribeEventTracker()

virtual Model::DescribeEventTrackerOutcome Aws::Personalize::PersonalizeClient::DescribeEventTracker ( const Model::DescribeEventTrackerRequest request) const
virtual

Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.

See Also:

AWS API Reference

◆ DescribeEventTrackerAsync()

virtual void Aws::Personalize::PersonalizeClient::DescribeEventTrackerAsync ( const Model::DescribeEventTrackerRequest request,
const DescribeEventTrackerResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.

See Also:

AWS API Reference

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

◆ DescribeEventTrackerCallable()

virtual Model::DescribeEventTrackerOutcomeCallable Aws::Personalize::PersonalizeClient::DescribeEventTrackerCallable ( const Model::DescribeEventTrackerRequest request) const
virtual

Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.

See Also:

AWS API Reference

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

◆ DescribeFeatureTransformation()

virtual Model::DescribeFeatureTransformationOutcome Aws::Personalize::PersonalizeClient::DescribeFeatureTransformation ( const Model::DescribeFeatureTransformationRequest request) const
virtual

Describes the given feature transformation.

See Also:

AWS API Reference

◆ DescribeFeatureTransformationAsync()

virtual void Aws::Personalize::PersonalizeClient::DescribeFeatureTransformationAsync ( const Model::DescribeFeatureTransformationRequest request,
const DescribeFeatureTransformationResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes the given feature transformation.

See Also:

AWS API Reference

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

◆ DescribeFeatureTransformationCallable()

virtual Model::DescribeFeatureTransformationOutcomeCallable Aws::Personalize::PersonalizeClient::DescribeFeatureTransformationCallable ( const Model::DescribeFeatureTransformationRequest request) const
virtual

Describes the given feature transformation.

See Also:

AWS API Reference

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

◆ DescribeFilter()

virtual Model::DescribeFilterOutcome Aws::Personalize::PersonalizeClient::DescribeFilter ( const Model::DescribeFilterRequest request) const
virtual

Describes a filter's properties.

See Also:

AWS API Reference

◆ DescribeFilterAsync()

virtual void Aws::Personalize::PersonalizeClient::DescribeFilterAsync ( const Model::DescribeFilterRequest request,
const DescribeFilterResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes a filter's properties.

See Also:

AWS API Reference

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

◆ DescribeFilterCallable()

virtual Model::DescribeFilterOutcomeCallable Aws::Personalize::PersonalizeClient::DescribeFilterCallable ( const Model::DescribeFilterRequest request) const
virtual

Describes a filter's properties.

See Also:

AWS API Reference

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

◆ DescribeRecipe()

virtual Model::DescribeRecipeOutcome Aws::Personalize::PersonalizeClient::DescribeRecipe ( const Model::DescribeRecipeRequest request) const
virtual

Describes a recipe.

A recipe contains three items:

  • An algorithm that trains a model.

  • Hyperparameters that govern the training.

  • Feature transformation information for modifying the input data before training.

Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.

See Also:

AWS API Reference

◆ DescribeRecipeAsync()

virtual void Aws::Personalize::PersonalizeClient::DescribeRecipeAsync ( const Model::DescribeRecipeRequest request,
const DescribeRecipeResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes a recipe.

A recipe contains three items:

  • An algorithm that trains a model.

  • Hyperparameters that govern the training.

  • Feature transformation information for modifying the input data before training.

Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.

See Also:

AWS API Reference

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

◆ DescribeRecipeCallable()

virtual Model::DescribeRecipeOutcomeCallable Aws::Personalize::PersonalizeClient::DescribeRecipeCallable ( const Model::DescribeRecipeRequest request) const
virtual

Describes a recipe.

A recipe contains three items:

  • An algorithm that trains a model.

  • Hyperparameters that govern the training.

  • Feature transformation information for modifying the input data before training.

Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.

See Also:

AWS API Reference

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

◆ DescribeSchema()

virtual Model::DescribeSchemaOutcome Aws::Personalize::PersonalizeClient::DescribeSchema ( const Model::DescribeSchemaRequest request) const
virtual

Describes a schema. For more information on schemas, see CreateSchema.

See Also:

AWS API Reference

◆ DescribeSchemaAsync()

virtual void Aws::Personalize::PersonalizeClient::DescribeSchemaAsync ( const Model::DescribeSchemaRequest request,
const DescribeSchemaResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes a schema. For more information on schemas, see CreateSchema.

See Also:

AWS API Reference

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

◆ DescribeSchemaCallable()

virtual Model::DescribeSchemaOutcomeCallable Aws::Personalize::PersonalizeClient::DescribeSchemaCallable ( const Model::DescribeSchemaRequest request) const
virtual

Describes a schema. For more information on schemas, see CreateSchema.

See Also:

AWS API Reference

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

◆ DescribeSolution()

virtual Model::DescribeSolutionOutcome Aws::Personalize::PersonalizeClient::DescribeSolution ( const Model::DescribeSolutionRequest request) const
virtual

Describes a solution. For more information on solutions, see CreateSolution.

See Also:

AWS API Reference

◆ DescribeSolutionAsync()

virtual void Aws::Personalize::PersonalizeClient::DescribeSolutionAsync ( const Model::DescribeSolutionRequest request,
const DescribeSolutionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes a solution. For more information on solutions, see CreateSolution.

See Also:

AWS API Reference

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

◆ DescribeSolutionCallable()

virtual Model::DescribeSolutionOutcomeCallable Aws::Personalize::PersonalizeClient::DescribeSolutionCallable ( const Model::DescribeSolutionRequest request) const
virtual

Describes a solution. For more information on solutions, see CreateSolution.

See Also:

AWS API Reference

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

◆ DescribeSolutionVersion()

virtual Model::DescribeSolutionVersionOutcome Aws::Personalize::PersonalizeClient::DescribeSolutionVersion ( const Model::DescribeSolutionVersionRequest request) const
virtual

Describes a specific version of a solution. For more information on solutions, see CreateSolution.

See Also:

AWS API Reference

◆ DescribeSolutionVersionAsync()

virtual void Aws::Personalize::PersonalizeClient::DescribeSolutionVersionAsync ( const Model::DescribeSolutionVersionRequest request,
const DescribeSolutionVersionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes a specific version of a solution. For more information on solutions, see CreateSolution.

See Also:

AWS API Reference

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

◆ DescribeSolutionVersionCallable()

virtual Model::DescribeSolutionVersionOutcomeCallable Aws::Personalize::PersonalizeClient::DescribeSolutionVersionCallable ( const Model::DescribeSolutionVersionRequest request) const
virtual

Describes a specific version of a solution. For more information on solutions, see CreateSolution.

See Also:

AWS API Reference

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

◆ GetSolutionMetrics()

virtual Model::GetSolutionMetricsOutcome Aws::Personalize::PersonalizeClient::GetSolutionMetrics ( const Model::GetSolutionMetricsRequest request) const
virtual

Gets the metrics for the specified solution version.

See Also:

AWS API Reference

◆ GetSolutionMetricsAsync()

virtual void Aws::Personalize::PersonalizeClient::GetSolutionMetricsAsync ( const Model::GetSolutionMetricsRequest request,
const GetSolutionMetricsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets the metrics for the specified solution version.

See Also:

AWS API Reference

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

◆ GetSolutionMetricsCallable()

virtual Model::GetSolutionMetricsOutcomeCallable Aws::Personalize::PersonalizeClient::GetSolutionMetricsCallable ( const Model::GetSolutionMetricsRequest request) const
virtual

Gets the metrics for the specified solution version.

See Also:

AWS API Reference

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

◆ ListBatchInferenceJobs()

virtual Model::ListBatchInferenceJobsOutcome Aws::Personalize::PersonalizeClient::ListBatchInferenceJobs ( const Model::ListBatchInferenceJobsRequest request) const
virtual

Gets a list of the batch inference jobs that have been performed off of a solution version.

See Also:

AWS API Reference

◆ ListBatchInferenceJobsAsync()

virtual void Aws::Personalize::PersonalizeClient::ListBatchInferenceJobsAsync ( const Model::ListBatchInferenceJobsRequest request,
const ListBatchInferenceJobsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets a list of the batch inference jobs that have been performed off of a solution version.

See Also:

AWS API Reference

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

◆ ListBatchInferenceJobsCallable()

virtual Model::ListBatchInferenceJobsOutcomeCallable Aws::Personalize::PersonalizeClient::ListBatchInferenceJobsCallable ( const Model::ListBatchInferenceJobsRequest request) const
virtual

Gets a list of the batch inference jobs that have been performed off of a solution version.

See Also:

AWS API Reference

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

◆ ListCampaigns()

virtual Model::ListCampaignsOutcome Aws::Personalize::PersonalizeClient::ListCampaigns ( const Model::ListCampaignsRequest request) const
virtual

Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.

See Also:

AWS API Reference

◆ ListCampaignsAsync()

virtual void Aws::Personalize::PersonalizeClient::ListCampaignsAsync ( const Model::ListCampaignsRequest request,
const ListCampaignsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.

See Also:

AWS API Reference

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

◆ ListCampaignsCallable()

virtual Model::ListCampaignsOutcomeCallable Aws::Personalize::PersonalizeClient::ListCampaignsCallable ( const Model::ListCampaignsRequest request) const
virtual

Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.

See Also:

AWS API Reference

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

◆ ListDatasetExportJobs()

virtual Model::ListDatasetExportJobsOutcome Aws::Personalize::PersonalizeClient::ListDatasetExportJobs ( const Model::ListDatasetExportJobsRequest request) const
virtual

Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.

See Also:

AWS API Reference

◆ ListDatasetExportJobsAsync()

virtual void Aws::Personalize::PersonalizeClient::ListDatasetExportJobsAsync ( const Model::ListDatasetExportJobsRequest request,
const ListDatasetExportJobsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.

See Also:

AWS API Reference

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

◆ ListDatasetExportJobsCallable()

virtual Model::ListDatasetExportJobsOutcomeCallable Aws::Personalize::PersonalizeClient::ListDatasetExportJobsCallable ( const Model::ListDatasetExportJobsRequest request) const
virtual

Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.

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::Personalize::PersonalizeClient::ListDatasetGroups ( const Model::ListDatasetGroupsRequest request) const
virtual

Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.

See Also:

AWS API Reference

◆ ListDatasetGroupsAsync()

virtual void Aws::Personalize::PersonalizeClient::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. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.

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::Personalize::PersonalizeClient::ListDatasetGroupsCallable ( const Model::ListDatasetGroupsRequest request) const
virtual

Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.

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::Personalize::PersonalizeClient::ListDatasetImportJobs ( const Model::ListDatasetImportJobsRequest request) const
virtual

Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.

See Also:

AWS API Reference

◆ ListDatasetImportJobsAsync()

virtual void Aws::Personalize::PersonalizeClient::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 that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.

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::Personalize::PersonalizeClient::ListDatasetImportJobsCallable ( const Model::ListDatasetImportJobsRequest request) const
virtual

Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.

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::Personalize::PersonalizeClient::ListDatasets ( const Model::ListDatasetsRequest request) const
virtual

Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.

See Also:

AWS API Reference

◆ ListDatasetsAsync()

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

Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.

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::Personalize::PersonalizeClient::ListDatasetsCallable ( const Model::ListDatasetsRequest request) const
virtual

Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.

See Also:

AWS API Reference

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

◆ ListEventTrackers()

virtual Model::ListEventTrackersOutcome Aws::Personalize::PersonalizeClient::ListEventTrackers ( const Model::ListEventTrackersRequest request) const
virtual

Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.

See Also:

AWS API Reference

◆ ListEventTrackersAsync()

virtual void Aws::Personalize::PersonalizeClient::ListEventTrackersAsync ( const Model::ListEventTrackersRequest request,
const ListEventTrackersResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.

See Also:

AWS API Reference

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

◆ ListEventTrackersCallable()

virtual Model::ListEventTrackersOutcomeCallable Aws::Personalize::PersonalizeClient::ListEventTrackersCallable ( const Model::ListEventTrackersRequest request) const
virtual

Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.

See Also:

AWS API Reference

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

◆ ListFilters()

virtual Model::ListFiltersOutcome Aws::Personalize::PersonalizeClient::ListFilters ( const Model::ListFiltersRequest request) const
virtual

Lists all filters that belong to a given dataset group.

See Also:

AWS API Reference

◆ ListFiltersAsync()

virtual void Aws::Personalize::PersonalizeClient::ListFiltersAsync ( const Model::ListFiltersRequest request,
const ListFiltersResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Lists all filters that belong to a given dataset group.

See Also:

AWS API Reference

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

◆ ListFiltersCallable()

virtual Model::ListFiltersOutcomeCallable Aws::Personalize::PersonalizeClient::ListFiltersCallable ( const Model::ListFiltersRequest request) const
virtual

Lists all filters that belong to a given dataset group.

See Also:

AWS API Reference

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

◆ ListRecipes()

virtual Model::ListRecipesOutcome Aws::Personalize::PersonalizeClient::ListRecipes ( const Model::ListRecipesRequest request) const
virtual

Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).

See Also:

AWS API Reference

◆ ListRecipesAsync()

virtual void Aws::Personalize::PersonalizeClient::ListRecipesAsync ( const Model::ListRecipesRequest request,
const ListRecipesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).

See Also:

AWS API Reference

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

◆ ListRecipesCallable()

virtual Model::ListRecipesOutcomeCallable Aws::Personalize::PersonalizeClient::ListRecipesCallable ( const Model::ListRecipesRequest request) const
virtual

Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).

See Also:

AWS API Reference

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

◆ ListSchemas()

virtual Model::ListSchemasOutcome Aws::Personalize::PersonalizeClient::ListSchemas ( const Model::ListSchemasRequest request) const
virtual

Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.

See Also:

AWS API Reference

◆ ListSchemasAsync()

virtual void Aws::Personalize::PersonalizeClient::ListSchemasAsync ( const Model::ListSchemasRequest request,
const ListSchemasResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.

See Also:

AWS API Reference

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

◆ ListSchemasCallable()

virtual Model::ListSchemasOutcomeCallable Aws::Personalize::PersonalizeClient::ListSchemasCallable ( const Model::ListSchemasRequest request) const
virtual

Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.

See Also:

AWS API Reference

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

◆ ListSolutions()

virtual Model::ListSolutionsOutcome Aws::Personalize::PersonalizeClient::ListSolutions ( const Model::ListSolutionsRequest request) const
virtual

Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

See Also:

AWS API Reference

◆ ListSolutionsAsync()

virtual void Aws::Personalize::PersonalizeClient::ListSolutionsAsync ( const Model::ListSolutionsRequest request,
const ListSolutionsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

See Also:

AWS API Reference

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

◆ ListSolutionsCallable()

virtual Model::ListSolutionsOutcomeCallable Aws::Personalize::PersonalizeClient::ListSolutionsCallable ( const Model::ListSolutionsRequest request) const
virtual

Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

See Also:

AWS API Reference

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

◆ ListSolutionVersions()

virtual Model::ListSolutionVersionsOutcome Aws::Personalize::PersonalizeClient::ListSolutionVersions ( const Model::ListSolutionVersionsRequest request) const
virtual

Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

See Also:

AWS API Reference

◆ ListSolutionVersionsAsync()

virtual void Aws::Personalize::PersonalizeClient::ListSolutionVersionsAsync ( const Model::ListSolutionVersionsRequest request,
const ListSolutionVersionsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

See Also:

AWS API Reference

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

◆ ListSolutionVersionsCallable()

virtual Model::ListSolutionVersionsOutcomeCallable Aws::Personalize::PersonalizeClient::ListSolutionVersionsCallable ( const Model::ListSolutionVersionsRequest request) const
virtual

Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

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::Personalize::PersonalizeClient::OverrideEndpoint ( const Aws::String endpoint)

◆ StopSolutionVersionCreation()

virtual Model::StopSolutionVersionCreationOutcome Aws::Personalize::PersonalizeClient::StopSolutionVersionCreation ( const Model::StopSolutionVersionCreationRequest request) const
virtual

Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.

Depending on the current state of the solution version, the solution version state changes as follows:

  • CREATE_PENDING > CREATE_STOPPED

    or

  • CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED

You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.

See Also:

AWS API Reference

◆ StopSolutionVersionCreationAsync()

virtual void Aws::Personalize::PersonalizeClient::StopSolutionVersionCreationAsync ( const Model::StopSolutionVersionCreationRequest request,
const StopSolutionVersionCreationResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.

Depending on the current state of the solution version, the solution version state changes as follows:

  • CREATE_PENDING > CREATE_STOPPED

    or

  • CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED

You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.

See Also:

AWS API Reference

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

◆ StopSolutionVersionCreationCallable()

virtual Model::StopSolutionVersionCreationOutcomeCallable Aws::Personalize::PersonalizeClient::StopSolutionVersionCreationCallable ( const Model::StopSolutionVersionCreationRequest request) const
virtual

Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.

Depending on the current state of the solution version, the solution version state changes as follows:

  • CREATE_PENDING > CREATE_STOPPED

    or

  • CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED

You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.

See Also:

AWS API Reference

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

◆ UpdateCampaign()

virtual Model::UpdateCampaignOutcome Aws::Personalize::PersonalizeClient::UpdateCampaign ( const Model::UpdateCampaignRequest request) const
virtual

Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign API.

You must wait until the status of the updated campaign is ACTIVE before asking the campaign for recommendations.

For more information on campaigns, see CreateCampaign.

See Also:

AWS API Reference

◆ UpdateCampaignAsync()

virtual void Aws::Personalize::PersonalizeClient::UpdateCampaignAsync ( const Model::UpdateCampaignRequest request,
const UpdateCampaignResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign API.

You must wait until the status of the updated campaign is ACTIVE before asking the campaign for recommendations.

For more information on campaigns, see CreateCampaign.

See Also:

AWS API Reference

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

◆ UpdateCampaignCallable()

virtual Model::UpdateCampaignOutcomeCallable Aws::Personalize::PersonalizeClient::UpdateCampaignCallable ( const Model::UpdateCampaignRequest request) const
virtual

Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign API.

You must wait until the status of the updated campaign is ACTIVE before asking the campaign for recommendations.

For more information on campaigns, see CreateCampaign.

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: