/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the personalize-runtime-2018-05-22.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.PersonalizeRuntime.Model;
namespace Amazon.PersonalizeRuntime
{
///
/// Interface for accessing PersonalizeRuntime
///
///
///
public partial interface IAmazonPersonalizeRuntime : IAmazonService, IDisposable
{
#region GetPersonalizedRanking
///
/// Re-ranks a list of recommended items for the given user. The first item in the list
/// is deemed the most likely item to be of interest to the user.
///
///
///
/// The solution backing the campaign must have been created using a recipe of type PERSONALIZED_RANKING.
///
///
///
/// Container for the necessary parameters to execute the GetPersonalizedRanking service method.
///
/// The response from the GetPersonalizedRanking service method, as returned by PersonalizeRuntime.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource does not exist.
///
/// REST API Reference for GetPersonalizedRanking Operation
GetPersonalizedRankingResponse GetPersonalizedRanking(GetPersonalizedRankingRequest request);
///
/// Re-ranks a list of recommended items for the given user. The first item in the list
/// is deemed the most likely item to be of interest to the user.
///
///
///
/// The solution backing the campaign must have been created using a recipe of type PERSONALIZED_RANKING.
///
///
///
/// Container for the necessary parameters to execute the GetPersonalizedRanking service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetPersonalizedRanking service method, as returned by PersonalizeRuntime.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource does not exist.
///
/// REST API Reference for GetPersonalizedRanking Operation
Task GetPersonalizedRankingAsync(GetPersonalizedRankingRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetRecommendations
///
/// Returns a list of recommended items. For campaigns, the campaign's Amazon Resource
/// Name (ARN) is required and the required user and item input depends on the recipe
/// type used to create the solution backing the campaign as follows:
///
/// -
///
/// USER_PERSONALIZATION -
userId required, itemId not used
///
/// -
///
/// RELATED_ITEMS -
itemId required, userId not used
///
///
///
/// Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING
/// use the API.
///
///
///
/// For recommenders, the recommender's ARN is required and the required item and user
/// input depends on the use case (domain-based recipe) backing the recommender. For information
/// on use case requirements see Choosing
/// recommender use cases.
///
///
/// Container for the necessary parameters to execute the GetRecommendations service method.
///
/// The response from the GetRecommendations service method, as returned by PersonalizeRuntime.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource does not exist.
///
/// REST API Reference for GetRecommendations Operation
GetRecommendationsResponse GetRecommendations(GetRecommendationsRequest request);
///
/// Returns a list of recommended items. For campaigns, the campaign's Amazon Resource
/// Name (ARN) is required and the required user and item input depends on the recipe
/// type used to create the solution backing the campaign as follows:
///
/// -
///
/// USER_PERSONALIZATION -
userId required, itemId not used
///
/// -
///
/// RELATED_ITEMS -
itemId required, userId not used
///
///
///
/// Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING
/// use the API.
///
///
///
/// For recommenders, the recommender's ARN is required and the required item and user
/// input depends on the use case (domain-based recipe) backing the recommender. For information
/// on use case requirements see Choosing
/// recommender use cases.
///
///
/// Container for the necessary parameters to execute the GetRecommendations service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetRecommendations service method, as returned by PersonalizeRuntime.
///
/// Provide a valid value for the field or parameter.
///
///
/// The specified resource does not exist.
///
/// REST API Reference for GetRecommendations Operation
Task GetRecommendationsAsync(GetRecommendationsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}