CreateDatasetExportJobAsync(CreateDatasetExportJobRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateDatasetGroup
///
/// Creates an empty dataset group. A dataset group is a container for Amazon Personalize
/// resources. A dataset group can contain at most three datasets, one for each type of
/// dataset:
///
/// -
///
/// Interactions
///
///
-
///
/// Items
///
///
-
///
/// Users
///
///
///
/// A dataset group can be a Domain dataset group, where you specify a domain and use
/// pre-configured resources like recommenders, or a Custom dataset group, where you use
/// custom resources, such as a solution with a solution version, that you deploy with
/// a campaign. If you start with a Domain dataset group, you can still add custom resources
/// such as solutions and solution versions trained with recipes for custom use cases
/// and deployed with campaigns.
///
///
///
/// 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
///
///
Related APIs
///
///
///
/// Container for the necessary parameters to execute the CreateDatasetGroup service method.
///
/// The response from the CreateDatasetGroup service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource already exists.
///
///
/// You have exceeded the maximum number of tags you can apply to this resource.
///
/// REST API Reference for CreateDatasetGroup Operation
CreateDatasetGroupResponse CreateDatasetGroup(CreateDatasetGroupRequest request);
///
/// Creates an empty dataset group. A dataset group is a container for Amazon Personalize
/// resources. A dataset group can contain at most three datasets, one for each type of
/// dataset:
///
/// -
///
/// Interactions
///
///
-
///
/// Items
///
///
-
///
/// Users
///
///
///
/// A dataset group can be a Domain dataset group, where you specify a domain and use
/// pre-configured resources like recommenders, or a Custom dataset group, where you use
/// custom resources, such as a solution with a solution version, that you deploy with
/// a campaign. If you start with a Domain dataset group, you can still add custom resources
/// such as solutions and solution versions trained with recipes for custom use cases
/// and deployed with campaigns.
///
///
///
/// 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
///
///
Related APIs
///
///
///
/// Container for the necessary parameters to execute the CreateDatasetGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateDatasetGroup service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource already exists.
///
///
/// You have exceeded the maximum number of tags you can apply to this resource.
///
/// REST API Reference for CreateDatasetGroup Operation
Task CreateDatasetGroupAsync(CreateDatasetGroupRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateDatasetImportJob
///
/// 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.
///
///
///
/// By default, a dataset import job replaces any existing data in the dataset that you
/// imported in bulk. To add new records without replacing existing data, specify INCREMENTAL
/// for the import mode in the CreateDatasetImportJob operation.
///
///
///
/// 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
///
///
///
/// Container for the necessary parameters to execute the CreateDatasetImportJob service method.
///
/// The response from the CreateDatasetImportJob service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource already exists.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
///
/// You have exceeded the maximum number of tags you can apply to this resource.
///
/// REST API Reference for CreateDatasetImportJob Operation
CreateDatasetImportJobResponse CreateDatasetImportJob(CreateDatasetImportJobRequest request);
///
/// 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.
///
///
///
/// By default, a dataset import job replaces any existing data in the dataset that you
/// imported in bulk. To add new records without replacing existing data, specify INCREMENTAL
/// for the import mode in the CreateDatasetImportJob operation.
///
///
///
/// 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
///
///
///
/// Container for the necessary parameters to execute the CreateDatasetImportJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateDatasetImportJob service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource already exists.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
///
/// You have exceeded the maximum number of tags you can apply to this resource.
///
/// REST API Reference for CreateDatasetImportJob Operation
Task CreateDatasetImportJobAsync(CreateDatasetImportJobRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateEventTracker
///
/// 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
///
///
///
/// Container for the necessary parameters to execute the CreateEventTracker service method.
///
/// The response from the CreateEventTracker service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource already exists.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
///
/// You have exceeded the maximum number of tags you can apply to this resource.
///
/// REST API Reference for CreateEventTracker Operation
CreateEventTrackerResponse CreateEventTracker(CreateEventTrackerRequest request);
///
/// 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
///
///
///
/// Container for the necessary parameters to execute the CreateEventTracker service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateEventTracker service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource already exists.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
///
/// You have exceeded the maximum number of tags you can apply to this resource.
///
/// REST API Reference for CreateEventTracker Operation
Task CreateEventTrackerAsync(CreateEventTrackerRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateFilter
///
/// Creates a recommendation filter. For more information, see Filtering
/// recommendations and user segments.
///
/// Container for the necessary parameters to execute the CreateFilter service method.
///
/// The response from the CreateFilter service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource already exists.
///
///
/// Could not find the specified resource.
///
///
/// You have exceeded the maximum number of tags you can apply to this resource.
///
/// REST API Reference for CreateFilter Operation
CreateFilterResponse CreateFilter(CreateFilterRequest request);
///
/// Creates a recommendation filter. For more information, see Filtering
/// recommendations and user segments.
///
/// Container for the necessary parameters to execute the CreateFilter service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateFilter service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource already exists.
///
///
/// Could not find the specified resource.
///
///
/// You have exceeded the maximum number of tags you can apply to this resource.
///
/// REST API Reference for CreateFilter Operation
Task CreateFilterAsync(CreateFilterRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateMetricAttribution
///
/// Creates a metric attribution. A metric attribution creates reports on the data that
/// you import into Amazon Personalize. Depending on how you imported the data, you can
/// view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring
/// impact of recommendations.
///
/// Container for the necessary parameters to execute the CreateMetricAttribution service method.
///
/// The response from the CreateMetricAttribution service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource already exists.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for CreateMetricAttribution Operation
CreateMetricAttributionResponse CreateMetricAttribution(CreateMetricAttributionRequest request);
///
/// Creates a metric attribution. A metric attribution creates reports on the data that
/// you import into Amazon Personalize. Depending on how you imported the data, you can
/// view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring
/// impact of recommendations.
///
/// Container for the necessary parameters to execute the CreateMetricAttribution service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateMetricAttribution service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource already exists.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for CreateMetricAttribution Operation
Task CreateMetricAttributionAsync(CreateMetricAttributionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateRecommender
///
/// Creates a recommender with the recipe (a Domain dataset group use case) you specify.
/// You create recommenders for a Domain dataset group and specify the recommender's Amazon
/// Resource Name (ARN) when you make a GetRecommendations
/// request.
///
///
///
/// Minimum recommendation requests per second
///
///
///
/// A high minRecommendationRequestsPerSecond will increase your bill. We
/// recommend starting with 1 for minRecommendationRequestsPerSecond (the
/// default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond
/// as necessary.
///
///
///
/// When you create a recommender, you can configure the recommender's minimum recommendation
/// requests per second. The minimum recommendation requests per second (minRecommendationRequestsPerSecond)
/// specifies the baseline recommendation request throughput provisioned by Amazon Personalize.
/// The default minRecommendationRequestsPerSecond is 1. A recommendation
/// request is a single GetRecommendations operation. Request throughput
/// is measured in requests per second and Amazon Personalize uses your requests per second
/// to derive your requests per hour and the price of your recommender usage.
///
///
///
/// If your requests per second increases beyond minRecommendationRequestsPerSecond,
/// Amazon Personalize auto-scales the provisioned capacity up and down, but never below
/// minRecommendationRequestsPerSecond. There's a short time delay while
/// the capacity is increased that might cause loss of requests.
///
///
///
/// Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond)
/// or the actual number of requests. The actual request throughput used is calculated
/// as the average requests/second within a one-hour window. We recommend starting with
/// the default minRecommendationRequestsPerSecond, track your usage using
/// Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond
/// as necessary.
///
///
///
/// Status
///
///
///
/// A recommender can be in one of the following states:
///
/// -
///
/// CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
///
///
-
///
/// STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS
/// > ACTIVE
///
///
-
///
/// DELETE PENDING > DELETE IN_PROGRESS
///
///
///
/// To get the recommender status, call DescribeRecommender.
///
///
///
/// Wait until the status of the recommender is ACTIVE before
/// asking the recommender for recommendations.
///
/// Related APIs
///
///
///
/// Container for the necessary parameters to execute the CreateRecommender service method.
///
/// The response from the CreateRecommender service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource already exists.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
///
/// You have exceeded the maximum number of tags you can apply to this resource.
///
/// REST API Reference for CreateRecommender Operation
CreateRecommenderResponse CreateRecommender(CreateRecommenderRequest request);
///
/// Creates a recommender with the recipe (a Domain dataset group use case) you specify.
/// You create recommenders for a Domain dataset group and specify the recommender's Amazon
/// Resource Name (ARN) when you make a GetRecommendations
/// request.
///
///
///
/// Minimum recommendation requests per second
///
///
///
/// A high minRecommendationRequestsPerSecond will increase your bill. We
/// recommend starting with 1 for minRecommendationRequestsPerSecond (the
/// default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond
/// as necessary.
///
///
///
/// When you create a recommender, you can configure the recommender's minimum recommendation
/// requests per second. The minimum recommendation requests per second (minRecommendationRequestsPerSecond)
/// specifies the baseline recommendation request throughput provisioned by Amazon Personalize.
/// The default minRecommendationRequestsPerSecond is 1. A recommendation
/// request is a single GetRecommendations operation. Request throughput
/// is measured in requests per second and Amazon Personalize uses your requests per second
/// to derive your requests per hour and the price of your recommender usage.
///
///
///
/// If your requests per second increases beyond minRecommendationRequestsPerSecond,
/// Amazon Personalize auto-scales the provisioned capacity up and down, but never below
/// minRecommendationRequestsPerSecond. There's a short time delay while
/// the capacity is increased that might cause loss of requests.
///
///
///
/// Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond)
/// or the actual number of requests. The actual request throughput used is calculated
/// as the average requests/second within a one-hour window. We recommend starting with
/// the default minRecommendationRequestsPerSecond, track your usage using
/// Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond
/// as necessary.
///
///
///
/// Status
///
///
///
/// A recommender can be in one of the following states:
///
/// -
///
/// CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
///
///
-
///
/// STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS
/// > ACTIVE
///
///
-
///
/// DELETE PENDING > DELETE IN_PROGRESS
///
///
///
/// To get the recommender status, call DescribeRecommender.
///
///
///
/// Wait until the status of the recommender is ACTIVE before
/// asking the recommender for recommendations.
///
/// Related APIs
///
///
///
/// Container for the necessary parameters to execute the CreateRecommender service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateRecommender service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource already exists.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
///
/// You have exceeded the maximum number of tags you can apply to this resource.
///
/// REST API Reference for CreateRecommender Operation
Task CreateRecommenderAsync(CreateRecommenderRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateSchema
///
/// 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. If you are creating a
/// schema for a dataset in a Domain dataset group, you provide the domain of the Domain
/// dataset group. You specify a schema when you call CreateDataset.
///
/// Related APIs
///
///
///
/// Container for the necessary parameters to execute the CreateSchema service method.
///
/// The response from the CreateSchema service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource already exists.
///
/// REST API Reference for CreateSchema Operation
CreateSchemaResponse CreateSchema(CreateSchemaRequest request);
///
/// 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. If you are creating a
/// schema for a dataset in a Domain dataset group, you provide the domain of the Domain
/// dataset group. You specify a schema when you call CreateDataset.
///
/// Related APIs
///
///
///
/// Container for the necessary parameters to execute the CreateSchema service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateSchema service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource already exists.
///
/// REST API Reference for CreateSchema Operation
Task CreateSchemaAsync(CreateSchemaRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateSolution
///
/// Creates the configuration for training a model. A trained model is known as a solution
/// version. After the configuration is created, you train the model (create a solution
/// version) 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.
///
///
///
/// 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
///
///
///
/// Container for the necessary parameters to execute the CreateSolution service method.
///
/// The response from the CreateSolution service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource already exists.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
///
/// You have exceeded the maximum number of tags you can apply to this resource.
///
/// REST API Reference for CreateSolution Operation
CreateSolutionResponse CreateSolution(CreateSolutionRequest request);
///
/// Creates the configuration for training a model. A trained model is known as a solution
/// version. After the configuration is created, you train the model (create a solution
/// version) 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.
///
///
///
/// 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
///
///
///
/// Container for the necessary parameters to execute the CreateSolution service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateSolution service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource already exists.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
///
/// You have exceeded the maximum number of tags you can apply to this resource.
///
/// REST API Reference for CreateSolution Operation
Task CreateSolutionAsync(CreateSolutionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateSolutionVersion
///
/// Trains or retrains an active solution in a Custom dataset group. 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
///
///
///
/// Container for the necessary parameters to execute the CreateSolutionVersion service method.
///
/// The response from the CreateSolutionVersion service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource already exists.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
///
/// You have exceeded the maximum number of tags you can apply to this resource.
///
/// REST API Reference for CreateSolutionVersion Operation
CreateSolutionVersionResponse CreateSolutionVersion(CreateSolutionVersionRequest request);
///
/// Trains or retrains an active solution in a Custom dataset group. 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
///
///
///
/// Container for the necessary parameters to execute the CreateSolutionVersion service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateSolutionVersion service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource already exists.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
///
/// You have exceeded the maximum number of tags you can apply to this resource.
///
/// REST API Reference for CreateSolutionVersion Operation
Task CreateSolutionVersionAsync(CreateSolutionVersionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteCampaign
///
/// 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 information on creating campaigns, see CreateCampaign.
///
/// Container for the necessary parameters to execute the DeleteCampaign service method.
///
/// The response from the DeleteCampaign service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DeleteCampaign Operation
DeleteCampaignResponse DeleteCampaign(DeleteCampaignRequest request);
///
/// 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 information on creating campaigns, see CreateCampaign.
///
/// Container for the necessary parameters to execute the DeleteCampaign service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteCampaign service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DeleteCampaign Operation
Task DeleteCampaignAsync(DeleteCampaignRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteDataset
///
/// 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.
///
/// Container for the necessary parameters to execute the DeleteDataset service method.
///
/// The response from the DeleteDataset service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DeleteDataset Operation
DeleteDatasetResponse DeleteDataset(DeleteDatasetRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the DeleteDataset service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteDataset service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DeleteDataset Operation
Task DeleteDatasetAsync(DeleteDatasetRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteDatasetGroup
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the DeleteDatasetGroup service method.
///
/// The response from the DeleteDatasetGroup service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DeleteDatasetGroup Operation
DeleteDatasetGroupResponse DeleteDatasetGroup(DeleteDatasetGroupRequest request);
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the DeleteDatasetGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteDatasetGroup service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DeleteDatasetGroup Operation
Task DeleteDatasetGroupAsync(DeleteDatasetGroupRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteEventTracker
///
/// Deletes the event tracker. Does not delete the event-interactions dataset from the
/// associated dataset group. For more information on event trackers, see CreateEventTracker.
///
/// Container for the necessary parameters to execute the DeleteEventTracker service method.
///
/// The response from the DeleteEventTracker service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DeleteEventTracker Operation
DeleteEventTrackerResponse DeleteEventTracker(DeleteEventTrackerRequest request);
///
/// Deletes the event tracker. Does not delete the event-interactions dataset from the
/// associated dataset group. For more information on event trackers, see CreateEventTracker.
///
/// Container for the necessary parameters to execute the DeleteEventTracker service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteEventTracker service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DeleteEventTracker Operation
Task DeleteEventTrackerAsync(DeleteEventTrackerRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteFilter
///
/// Deletes a filter.
///
/// Container for the necessary parameters to execute the DeleteFilter service method.
///
/// The response from the DeleteFilter service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DeleteFilter Operation
DeleteFilterResponse DeleteFilter(DeleteFilterRequest request);
///
/// Deletes a filter.
///
/// Container for the necessary parameters to execute the DeleteFilter service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteFilter service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DeleteFilter Operation
Task DeleteFilterAsync(DeleteFilterRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteMetricAttribution
///
/// Deletes a metric attribution.
///
/// Container for the necessary parameters to execute the DeleteMetricAttribution service method.
///
/// The response from the DeleteMetricAttribution service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DeleteMetricAttribution Operation
DeleteMetricAttributionResponse DeleteMetricAttribution(DeleteMetricAttributionRequest request);
///
/// Deletes a metric attribution.
///
/// Container for the necessary parameters to execute the DeleteMetricAttribution service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteMetricAttribution service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DeleteMetricAttribution Operation
Task DeleteMetricAttributionAsync(DeleteMetricAttributionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteRecommender
///
/// Deactivates and removes a recommender. A deleted recommender can no longer be specified
/// in a GetRecommendations
/// request.
///
/// Container for the necessary parameters to execute the DeleteRecommender service method.
///
/// The response from the DeleteRecommender service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DeleteRecommender Operation
DeleteRecommenderResponse DeleteRecommender(DeleteRecommenderRequest request);
///
/// Deactivates and removes a recommender. A deleted recommender can no longer be specified
/// in a GetRecommendations
/// request.
///
/// Container for the necessary parameters to execute the DeleteRecommender service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteRecommender service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DeleteRecommender Operation
Task DeleteRecommenderAsync(DeleteRecommenderRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteSchema
///
/// Deletes a schema. Before deleting a schema, you must delete all datasets referencing
/// the schema. For more information on schemas, see CreateSchema.
///
/// Container for the necessary parameters to execute the DeleteSchema service method.
///
/// The response from the DeleteSchema service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DeleteSchema Operation
DeleteSchemaResponse DeleteSchema(DeleteSchemaRequest request);
///
/// Deletes a schema. Before deleting a schema, you must delete all datasets referencing
/// the schema. For more information on schemas, see CreateSchema.
///
/// Container for the necessary parameters to execute the DeleteSchema service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteSchema service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DeleteSchema Operation
Task DeleteSchemaAsync(DeleteSchemaRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteSolution
///
/// 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.
///
/// Container for the necessary parameters to execute the DeleteSolution service method.
///
/// The response from the DeleteSolution service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DeleteSolution Operation
DeleteSolutionResponse DeleteSolution(DeleteSolutionRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the DeleteSolution service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteSolution service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DeleteSolution Operation
Task DeleteSolutionAsync(DeleteSolutionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeAlgorithm
///
/// Describes the given algorithm.
///
/// Container for the necessary parameters to execute the DescribeAlgorithm service method.
///
/// The response from the DescribeAlgorithm service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeAlgorithm Operation
DescribeAlgorithmResponse DescribeAlgorithm(DescribeAlgorithmRequest request);
///
/// Describes the given algorithm.
///
/// Container for the necessary parameters to execute the DescribeAlgorithm service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeAlgorithm service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeAlgorithm Operation
Task DescribeAlgorithmAsync(DescribeAlgorithmRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeBatchInferenceJob
///
/// 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.
///
/// Container for the necessary parameters to execute the DescribeBatchInferenceJob service method.
///
/// The response from the DescribeBatchInferenceJob service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeBatchInferenceJob Operation
DescribeBatchInferenceJobResponse DescribeBatchInferenceJob(DescribeBatchInferenceJobRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the DescribeBatchInferenceJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeBatchInferenceJob service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeBatchInferenceJob Operation
Task DescribeBatchInferenceJobAsync(DescribeBatchInferenceJobRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeBatchSegmentJob
///
/// Gets the properties of a batch segment job including name, Amazon Resource Name (ARN),
/// status, input and output configurations, and the ARN of the solution version used
/// to generate segments.
///
/// Container for the necessary parameters to execute the DescribeBatchSegmentJob service method.
///
/// The response from the DescribeBatchSegmentJob service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeBatchSegmentJob Operation
DescribeBatchSegmentJobResponse DescribeBatchSegmentJob(DescribeBatchSegmentJobRequest request);
///
/// Gets the properties of a batch segment job including name, Amazon Resource Name (ARN),
/// status, input and output configurations, and the ARN of the solution version used
/// to generate segments.
///
/// Container for the necessary parameters to execute the DescribeBatchSegmentJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeBatchSegmentJob service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeBatchSegmentJob Operation
Task DescribeBatchSegmentJobAsync(DescribeBatchSegmentJobRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeCampaign
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DescribeCampaign service method.
///
/// The response from the DescribeCampaign service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeCampaign Operation
DescribeCampaignResponse DescribeCampaign(DescribeCampaignRequest request);
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DescribeCampaign service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeCampaign service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeCampaign Operation
Task DescribeCampaignAsync(DescribeCampaignRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeDataset
///
/// Describes the given dataset. For more information on datasets, see CreateDataset.
///
/// Container for the necessary parameters to execute the DescribeDataset service method.
///
/// The response from the DescribeDataset service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeDataset Operation
DescribeDatasetResponse DescribeDataset(DescribeDatasetRequest request);
///
/// Describes the given dataset. For more information on datasets, see CreateDataset.
///
/// Container for the necessary parameters to execute the DescribeDataset service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeDataset service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeDataset Operation
Task DescribeDatasetAsync(DescribeDatasetRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeDatasetExportJob
///
/// Describes the dataset export job created by CreateDatasetExportJob,
/// including the export job status.
///
/// Container for the necessary parameters to execute the DescribeDatasetExportJob service method.
///
/// The response from the DescribeDatasetExportJob service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeDatasetExportJob Operation
DescribeDatasetExportJobResponse DescribeDatasetExportJob(DescribeDatasetExportJobRequest request);
///
/// Describes the dataset export job created by CreateDatasetExportJob,
/// including the export job status.
///
/// Container for the necessary parameters to execute the DescribeDatasetExportJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeDatasetExportJob service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeDatasetExportJob Operation
Task DescribeDatasetExportJobAsync(DescribeDatasetExportJobRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeDatasetGroup
///
/// Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
///
/// Container for the necessary parameters to execute the DescribeDatasetGroup service method.
///
/// The response from the DescribeDatasetGroup service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeDatasetGroup Operation
DescribeDatasetGroupResponse DescribeDatasetGroup(DescribeDatasetGroupRequest request);
///
/// Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
///
/// Container for the necessary parameters to execute the DescribeDatasetGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeDatasetGroup service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeDatasetGroup Operation
Task DescribeDatasetGroupAsync(DescribeDatasetGroupRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeDatasetImportJob
///
/// Describes the dataset import job created by CreateDatasetImportJob,
/// including the import job status.
///
/// Container for the necessary parameters to execute the DescribeDatasetImportJob service method.
///
/// The response from the DescribeDatasetImportJob service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeDatasetImportJob Operation
DescribeDatasetImportJobResponse DescribeDatasetImportJob(DescribeDatasetImportJobRequest request);
///
/// Describes the dataset import job created by CreateDatasetImportJob,
/// including the import job status.
///
/// Container for the necessary parameters to execute the DescribeDatasetImportJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeDatasetImportJob service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeDatasetImportJob Operation
Task DescribeDatasetImportJobAsync(DescribeDatasetImportJobRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeEventTracker
///
/// Describes an event tracker. The response includes the trackingId and
/// status of the event tracker. For more information on event trackers,
/// see CreateEventTracker.
///
/// Container for the necessary parameters to execute the DescribeEventTracker service method.
///
/// The response from the DescribeEventTracker service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeEventTracker Operation
DescribeEventTrackerResponse DescribeEventTracker(DescribeEventTrackerRequest request);
///
/// Describes an event tracker. The response includes the trackingId and
/// status of the event tracker. For more information on event trackers,
/// see CreateEventTracker.
///
/// Container for the necessary parameters to execute the DescribeEventTracker service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeEventTracker service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeEventTracker Operation
Task DescribeEventTrackerAsync(DescribeEventTrackerRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeFeatureTransformation
///
/// Describes the given feature transformation.
///
/// Container for the necessary parameters to execute the DescribeFeatureTransformation service method.
///
/// The response from the DescribeFeatureTransformation service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeFeatureTransformation Operation
DescribeFeatureTransformationResponse DescribeFeatureTransformation(DescribeFeatureTransformationRequest request);
///
/// Describes the given feature transformation.
///
/// Container for the necessary parameters to execute the DescribeFeatureTransformation service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeFeatureTransformation service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeFeatureTransformation Operation
Task DescribeFeatureTransformationAsync(DescribeFeatureTransformationRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeFilter
///
/// Describes a filter's properties.
///
/// Container for the necessary parameters to execute the DescribeFilter service method.
///
/// The response from the DescribeFilter service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeFilter Operation
DescribeFilterResponse DescribeFilter(DescribeFilterRequest request);
///
/// Describes a filter's properties.
///
/// Container for the necessary parameters to execute the DescribeFilter service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeFilter service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeFilter Operation
Task DescribeFilterAsync(DescribeFilterRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeMetricAttribution
///
/// Describes a metric attribution.
///
/// Container for the necessary parameters to execute the DescribeMetricAttribution service method.
///
/// The response from the DescribeMetricAttribution service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeMetricAttribution Operation
DescribeMetricAttributionResponse DescribeMetricAttribution(DescribeMetricAttributionRequest request);
///
/// Describes a metric attribution.
///
/// Container for the necessary parameters to execute the DescribeMetricAttribution service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeMetricAttribution service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeMetricAttribution Operation
Task DescribeMetricAttributionAsync(DescribeMetricAttributionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeRecipe
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DescribeRecipe service method.
///
/// The response from the DescribeRecipe service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeRecipe Operation
DescribeRecipeResponse DescribeRecipe(DescribeRecipeRequest request);
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DescribeRecipe service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeRecipe service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeRecipe Operation
Task DescribeRecipeAsync(DescribeRecipeRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeRecommender
///
/// Describes the given recommender, including its status.
///
///
///
/// A recommender can be in one of the following states:
///
/// -
///
/// CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
///
///
-
///
/// STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS
/// > ACTIVE
///
///
-
///
/// DELETE PENDING > DELETE IN_PROGRESS
///
///
///
/// When the status is CREATE FAILED, the response includes
/// the failureReason key, which describes why.
///
///
///
/// The modelMetrics key is null when the recommender is being created or
/// deleted.
///
///
///
/// For more information on recommenders, see CreateRecommender.
///
///
/// Container for the necessary parameters to execute the DescribeRecommender service method.
///
/// The response from the DescribeRecommender service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeRecommender Operation
DescribeRecommenderResponse DescribeRecommender(DescribeRecommenderRequest request);
///
/// Describes the given recommender, including its status.
///
///
///
/// A recommender can be in one of the following states:
///
/// -
///
/// CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
///
///
-
///
/// STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS
/// > ACTIVE
///
///
-
///
/// DELETE PENDING > DELETE IN_PROGRESS
///
///
///
/// When the status is CREATE FAILED, the response includes
/// the failureReason key, which describes why.
///
///
///
/// The modelMetrics key is null when the recommender is being created or
/// deleted.
///
///
///
/// For more information on recommenders, see CreateRecommender.
///
///
/// Container for the necessary parameters to execute the DescribeRecommender service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeRecommender service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeRecommender Operation
Task DescribeRecommenderAsync(DescribeRecommenderRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeSchema
///
/// Describes a schema. For more information on schemas, see CreateSchema.
///
/// Container for the necessary parameters to execute the DescribeSchema service method.
///
/// The response from the DescribeSchema service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeSchema Operation
DescribeSchemaResponse DescribeSchema(DescribeSchemaRequest request);
///
/// Describes a schema. For more information on schemas, see CreateSchema.
///
/// Container for the necessary parameters to execute the DescribeSchema service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeSchema service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeSchema Operation
Task DescribeSchemaAsync(DescribeSchemaRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeSolution
///
/// Describes a solution. For more information on solutions, see CreateSolution.
///
/// Container for the necessary parameters to execute the DescribeSolution service method.
///
/// The response from the DescribeSolution service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeSolution Operation
DescribeSolutionResponse DescribeSolution(DescribeSolutionRequest request);
///
/// Describes a solution. For more information on solutions, see CreateSolution.
///
/// Container for the necessary parameters to execute the DescribeSolution service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeSolution service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeSolution Operation
Task DescribeSolutionAsync(DescribeSolutionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeSolutionVersion
///
/// Describes a specific version of a solution. For more information on solutions, see
/// CreateSolution
///
/// Container for the necessary parameters to execute the DescribeSolutionVersion service method.
///
/// The response from the DescribeSolutionVersion service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeSolutionVersion Operation
DescribeSolutionVersionResponse DescribeSolutionVersion(DescribeSolutionVersionRequest request);
///
/// Describes a specific version of a solution. For more information on solutions, see
/// CreateSolution
///
/// Container for the necessary parameters to execute the DescribeSolutionVersion service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeSolutionVersion service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for DescribeSolutionVersion Operation
Task DescribeSolutionVersionAsync(DescribeSolutionVersionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetSolutionMetrics
///
/// Gets the metrics for the specified solution version.
///
/// Container for the necessary parameters to execute the GetSolutionMetrics service method.
///
/// The response from the GetSolutionMetrics service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for GetSolutionMetrics Operation
GetSolutionMetricsResponse GetSolutionMetrics(GetSolutionMetricsRequest request);
///
/// Gets the metrics for the specified solution version.
///
/// Container for the necessary parameters to execute the GetSolutionMetrics service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetSolutionMetrics service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for GetSolutionMetrics Operation
Task GetSolutionMetricsAsync(GetSolutionMetricsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListBatchInferenceJobs
///
/// Gets a list of the batch inference jobs that have been performed off of a solution
/// version.
///
/// Container for the necessary parameters to execute the ListBatchInferenceJobs service method.
///
/// The response from the ListBatchInferenceJobs service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListBatchInferenceJobs Operation
ListBatchInferenceJobsResponse ListBatchInferenceJobs(ListBatchInferenceJobsRequest request);
///
/// Gets a list of the batch inference jobs that have been performed off of a solution
/// version.
///
/// Container for the necessary parameters to execute the ListBatchInferenceJobs service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListBatchInferenceJobs service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListBatchInferenceJobs Operation
Task ListBatchInferenceJobsAsync(ListBatchInferenceJobsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListBatchSegmentJobs
///
/// Gets a list of the batch segment jobs that have been performed off of a solution version
/// that you specify.
///
/// Container for the necessary parameters to execute the ListBatchSegmentJobs service method.
///
/// The response from the ListBatchSegmentJobs service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListBatchSegmentJobs Operation
ListBatchSegmentJobsResponse ListBatchSegmentJobs(ListBatchSegmentJobsRequest request);
///
/// Gets a list of the batch segment jobs that have been performed off of a solution version
/// that you specify.
///
/// Container for the necessary parameters to execute the ListBatchSegmentJobs service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListBatchSegmentJobs service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListBatchSegmentJobs Operation
Task ListBatchSegmentJobsAsync(ListBatchSegmentJobsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListCampaigns
///
/// 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.
///
/// Container for the necessary parameters to execute the ListCampaigns service method.
///
/// The response from the ListCampaigns service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListCampaigns Operation
ListCampaignsResponse ListCampaigns(ListCampaignsRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the ListCampaigns service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListCampaigns service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListCampaigns Operation
Task ListCampaignsAsync(ListCampaignsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListDatasetExportJobs
///
/// 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.
///
/// Container for the necessary parameters to execute the ListDatasetExportJobs service method.
///
/// The response from the ListDatasetExportJobs service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListDatasetExportJobs Operation
ListDatasetExportJobsResponse ListDatasetExportJobs(ListDatasetExportJobsRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the ListDatasetExportJobs service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListDatasetExportJobs service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListDatasetExportJobs Operation
Task ListDatasetExportJobsAsync(ListDatasetExportJobsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListDatasetGroups
///
/// 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.
///
/// Container for the necessary parameters to execute the ListDatasetGroups service method.
///
/// The response from the ListDatasetGroups service method, as returned by Personalize.
///
/// The token is not valid.
///
/// REST API Reference for ListDatasetGroups Operation
ListDatasetGroupsResponse ListDatasetGroups(ListDatasetGroupsRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the ListDatasetGroups service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListDatasetGroups service method, as returned by Personalize.
///
/// The token is not valid.
///
/// REST API Reference for ListDatasetGroups Operation
Task ListDatasetGroupsAsync(ListDatasetGroupsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListDatasetImportJobs
///
/// 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.
///
/// Container for the necessary parameters to execute the ListDatasetImportJobs service method.
///
/// The response from the ListDatasetImportJobs service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListDatasetImportJobs Operation
ListDatasetImportJobsResponse ListDatasetImportJobs(ListDatasetImportJobsRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the ListDatasetImportJobs service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListDatasetImportJobs service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListDatasetImportJobs Operation
Task ListDatasetImportJobsAsync(ListDatasetImportJobsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListDatasets
///
/// 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.
///
/// Container for the necessary parameters to execute the ListDatasets service method.
///
/// The response from the ListDatasets service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListDatasets Operation
ListDatasetsResponse ListDatasets(ListDatasetsRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the ListDatasets service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListDatasets service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListDatasets Operation
Task ListDatasetsAsync(ListDatasetsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListEventTrackers
///
/// 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.
///
/// Container for the necessary parameters to execute the ListEventTrackers service method.
///
/// The response from the ListEventTrackers service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListEventTrackers Operation
ListEventTrackersResponse ListEventTrackers(ListEventTrackersRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the ListEventTrackers service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListEventTrackers service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListEventTrackers Operation
Task ListEventTrackersAsync(ListEventTrackersRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListFilters
///
/// Lists all filters that belong to a given dataset group.
///
/// Container for the necessary parameters to execute the ListFilters service method.
///
/// The response from the ListFilters service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListFilters Operation
ListFiltersResponse ListFilters(ListFiltersRequest request);
///
/// Lists all filters that belong to a given dataset group.
///
/// Container for the necessary parameters to execute the ListFilters service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListFilters service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListFilters Operation
Task ListFiltersAsync(ListFiltersRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListMetricAttributionMetrics
///
/// Lists the metrics for the metric attribution.
///
/// Container for the necessary parameters to execute the ListMetricAttributionMetrics service method.
///
/// The response from the ListMetricAttributionMetrics service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListMetricAttributionMetrics Operation
ListMetricAttributionMetricsResponse ListMetricAttributionMetrics(ListMetricAttributionMetricsRequest request);
///
/// Lists the metrics for the metric attribution.
///
/// Container for the necessary parameters to execute the ListMetricAttributionMetrics service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListMetricAttributionMetrics service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListMetricAttributionMetrics Operation
Task ListMetricAttributionMetricsAsync(ListMetricAttributionMetricsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListMetricAttributions
///
/// Lists metric attributions.
///
/// Container for the necessary parameters to execute the ListMetricAttributions service method.
///
/// The response from the ListMetricAttributions service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListMetricAttributions Operation
ListMetricAttributionsResponse ListMetricAttributions(ListMetricAttributionsRequest request);
///
/// Lists metric attributions.
///
/// Container for the necessary parameters to execute the ListMetricAttributions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListMetricAttributions service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListMetricAttributions Operation
Task ListMetricAttributionsAsync(ListMetricAttributionsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListRecipes
///
/// Returns a list of available recipes. The response provides the properties for each
/// recipe, including the recipe's Amazon Resource Name (ARN).
///
/// Container for the necessary parameters to execute the ListRecipes service method.
///
/// The response from the ListRecipes service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListRecipes Operation
ListRecipesResponse ListRecipes(ListRecipesRequest request);
///
/// Returns a list of available recipes. The response provides the properties for each
/// recipe, including the recipe's Amazon Resource Name (ARN).
///
/// Container for the necessary parameters to execute the ListRecipes service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListRecipes service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListRecipes Operation
Task ListRecipesAsync(ListRecipesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListRecommenders
///
/// Returns a list of recommenders in a given Domain dataset group. When a Domain dataset
/// group is not specified, all the recommenders associated with the account are listed.
/// The response provides the properties for each recommender, including the Amazon Resource
/// Name (ARN). For more information on recommenders, see CreateRecommender.
///
/// Container for the necessary parameters to execute the ListRecommenders service method.
///
/// The response from the ListRecommenders service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListRecommenders Operation
ListRecommendersResponse ListRecommenders(ListRecommendersRequest request);
///
/// Returns a list of recommenders in a given Domain dataset group. When a Domain dataset
/// group is not specified, all the recommenders associated with the account are listed.
/// The response provides the properties for each recommender, including the Amazon Resource
/// Name (ARN). For more information on recommenders, see CreateRecommender.
///
/// Container for the necessary parameters to execute the ListRecommenders service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListRecommenders service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListRecommenders Operation
Task ListRecommendersAsync(ListRecommendersRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListSchemas
///
/// 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.
///
/// Container for the necessary parameters to execute the ListSchemas service method.
///
/// The response from the ListSchemas service method, as returned by Personalize.
///
/// The token is not valid.
///
/// REST API Reference for ListSchemas Operation
ListSchemasResponse ListSchemas(ListSchemasRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the ListSchemas service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListSchemas service method, as returned by Personalize.
///
/// The token is not valid.
///
/// REST API Reference for ListSchemas Operation
Task ListSchemasAsync(ListSchemasRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListSolutions
///
/// 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.
///
/// Container for the necessary parameters to execute the ListSolutions service method.
///
/// The response from the ListSolutions service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListSolutions Operation
ListSolutionsResponse ListSolutions(ListSolutionsRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the ListSolutions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListSolutions service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
/// REST API Reference for ListSolutions Operation
Task ListSolutionsAsync(ListSolutionsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListSolutionVersions
///
/// 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).
///
/// Container for the necessary parameters to execute the ListSolutionVersions service method.
///
/// The response from the ListSolutionVersions service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for ListSolutionVersions Operation
ListSolutionVersionsResponse ListSolutionVersions(ListSolutionVersionsRequest request);
///
/// 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).
///
/// Container for the necessary parameters to execute the ListSolutionVersions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListSolutionVersions service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The token is not valid.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for ListSolutionVersions Operation
Task ListSolutionVersionsAsync(ListSolutionVersionsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTagsForResource
///
/// Get a list of tags
/// attached to a resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request);
///
/// Get a list of tags
/// attached to a resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for ListTagsForResource Operation
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StartRecommender
///
/// Starts a recommender that is INACTIVE. Starting a recommender does not create any
/// new models, but resumes billing and automatic retraining for the recommender.
///
/// Container for the necessary parameters to execute the StartRecommender service method.
///
/// The response from the StartRecommender service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for StartRecommender Operation
StartRecommenderResponse StartRecommender(StartRecommenderRequest request);
///
/// Starts a recommender that is INACTIVE. Starting a recommender does not create any
/// new models, but resumes billing and automatic retraining for the recommender.
///
/// Container for the necessary parameters to execute the StartRecommender service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StartRecommender service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for StartRecommender Operation
Task StartRecommenderAsync(StartRecommenderRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StopRecommender
///
/// Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic
/// retraining for the recommender.
///
/// Container for the necessary parameters to execute the StopRecommender service method.
///
/// The response from the StopRecommender service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for StopRecommender Operation
StopRecommenderResponse StopRecommender(StopRecommenderRequest request);
///
/// Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic
/// retraining for the recommender.
///
/// Container for the necessary parameters to execute the StopRecommender service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StopRecommender service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for StopRecommender Operation
Task StopRecommenderAsync(StopRecommenderRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StopSolutionVersionCreation
///
/// 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.
///
///
/// Container for the necessary parameters to execute the StopSolutionVersionCreation service method.
///
/// The response from the StopSolutionVersionCreation service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for StopSolutionVersionCreation Operation
StopSolutionVersionCreationResponse StopSolutionVersionCreation(StopSolutionVersionCreationRequest request);
///
/// 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.
///
///
/// Container for the necessary parameters to execute the StopSolutionVersionCreation service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StopSolutionVersionCreation service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for StopSolutionVersionCreation Operation
Task StopSolutionVersionCreationAsync(StopSolutionVersionCreationRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagResource
///
/// Add a list of tags to a resource.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
///
/// You have exceeded the maximum number of tags you can apply to this resource.
///
/// REST API Reference for TagResource Operation
TagResourceResponse TagResource(TagResourceRequest request);
///
/// Add a list of tags to a resource.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The limit on the number of requests per second has been exceeded.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
///
/// You have exceeded the maximum number of tags you can apply to this resource.
///
/// REST API Reference for TagResource Operation
Task TagResourceAsync(TagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagResource
///
/// Remove tags
/// that are attached to a resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
///
/// The request contains more tag keys than can be associated with a resource (50 tag
/// keys per resource).
///
/// REST API Reference for UntagResource Operation
UntagResourceResponse UntagResource(UntagResourceRequest request);
///
/// Remove tags
/// that are attached to a resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
///
/// The request contains more tag keys than can be associated with a resource (50 tag
/// keys per resource).
///
/// REST API Reference for UntagResource Operation
Task UntagResourceAsync(UntagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateCampaign
///
/// 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
/// operation.
///
///
///
/// You can still get recommendations from a campaign while an update is in progress.
/// The campaign will use the previous solution version and campaign configuration to
/// generate recommendations until the latest campaign update status is Active.
///
///
///
///
/// For more information on campaigns, see CreateCampaign.
///
///
/// Container for the necessary parameters to execute the UpdateCampaign service method.
///
/// The response from the UpdateCampaign service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for UpdateCampaign Operation
UpdateCampaignResponse UpdateCampaign(UpdateCampaignRequest request);
///
/// 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
/// operation.
///
///
///
/// You can still get recommendations from a campaign while an update is in progress.
/// The campaign will use the previous solution version and campaign configuration to
/// generate recommendations until the latest campaign update status is Active.
///
///
///
///
/// For more information on campaigns, see CreateCampaign.
///
///
/// Container for the necessary parameters to execute the UpdateCampaign service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateCampaign service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for UpdateCampaign Operation
Task UpdateCampaignAsync(UpdateCampaignRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateDataset
///
/// Update a dataset to replace its schema with a new or existing one. For more information,
/// see Replacing
/// a dataset's schema.
///
/// Container for the necessary parameters to execute the UpdateDataset service method.
///
/// The response from the UpdateDataset service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for UpdateDataset Operation
UpdateDatasetResponse UpdateDataset(UpdateDatasetRequest request);
///
/// Update a dataset to replace its schema with a new or existing one. For more information,
/// see Replacing
/// a dataset's schema.
///
/// Container for the necessary parameters to execute the UpdateDataset service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateDataset service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for UpdateDataset Operation
Task UpdateDatasetAsync(UpdateDatasetRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateMetricAttribution
///
/// Updates a metric attribution.
///
/// Container for the necessary parameters to execute the UpdateMetricAttribution service method.
///
/// The response from the UpdateMetricAttribution service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource already exists.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for UpdateMetricAttribution Operation
UpdateMetricAttributionResponse UpdateMetricAttribution(UpdateMetricAttributionRequest request);
///
/// Updates a metric attribution.
///
/// Container for the necessary parameters to execute the UpdateMetricAttribution service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateMetricAttribution service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource already exists.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for UpdateMetricAttribution Operation
Task UpdateMetricAttributionAsync(UpdateMetricAttributionRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateRecommender
///
/// Updates the recommender to modify the recommender configuration. If you update the
/// recommender to modify the columns used in training, Amazon Personalize automatically
/// starts a full retraining of the models backing your recommender. While the update
/// completes, you can still get recommendations from the recommender. The recommender
/// uses the previous configuration until the update completes. To track the status of
/// this update, use the latestRecommenderUpdate returned in the DescribeRecommender
/// operation.
///
/// Container for the necessary parameters to execute the UpdateRecommender service method.
///
/// The response from the UpdateRecommender service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for UpdateRecommender Operation
UpdateRecommenderResponse UpdateRecommender(UpdateRecommenderRequest request);
///
/// Updates the recommender to modify the recommender configuration. If you update the
/// recommender to modify the columns used in training, Amazon Personalize automatically
/// starts a full retraining of the models backing your recommender. While the update
/// completes, you can still get recommendations from the recommender. The recommender
/// uses the previous configuration until the update completes. To track the status of
/// this update, use the latestRecommenderUpdate returned in the DescribeRecommender
/// operation.
///
/// Container for the necessary parameters to execute the UpdateRecommender service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateRecommender service method, as returned by Personalize.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource is in use.
///
///
/// Could not find the specified resource.
///
/// REST API Reference for UpdateRecommender Operation
Task UpdateRecommenderAsync(UpdateRecommenderRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}