/* * 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-events-2018-03-22.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.PersonalizeEvents.Model; namespace Amazon.PersonalizeEvents { /// <summary> /// Interface for accessing PersonalizeEvents /// /// Amazon Personalize can consume real-time user event data, such as <i>stream</i> or /// <i>click</i> data, and use it for model training either alone or combined with historical /// data. For more information see <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html">Recording /// Events</a>. /// </summary> public partial interface IAmazonPersonalizeEvents : IAmazonService, IDisposable { #region PutEvents /// <summary> /// Records user interaction event data. For more information see <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html">Recording /// Events</a>. /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutEvents service method.</param> /// /// <returns>The response from the PutEvents service method, as returned by PersonalizeEvents.</returns> /// <exception cref="Amazon.PersonalizeEvents.Model.InvalidInputException"> /// Provide a valid value for the field or parameter. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/PutEvents">REST API Reference for PutEvents Operation</seealso> PutEventsResponse PutEvents(PutEventsRequest request); /// <summary> /// Initiates the asynchronous execution of the PutEvents operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutEvents operation on AmazonPersonalizeEventsClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutEvents /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/PutEvents">REST API Reference for PutEvents Operation</seealso> IAsyncResult BeginPutEvents(PutEventsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutEvents operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutEvents.</param> /// /// <returns>Returns a PutEventsResult from PersonalizeEvents.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/PutEvents">REST API Reference for PutEvents Operation</seealso> PutEventsResponse EndPutEvents(IAsyncResult asyncResult); #endregion #region PutItems /// <summary> /// Adds one or more items to an Items dataset. For more information see <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html">Importing /// Items Incrementally</a>. /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutItems service method.</param> /// /// <returns>The response from the PutItems service method, as returned by PersonalizeEvents.</returns> /// <exception cref="Amazon.PersonalizeEvents.Model.InvalidInputException"> /// Provide a valid value for the field or parameter. /// </exception> /// <exception cref="Amazon.PersonalizeEvents.Model.ResourceInUseException"> /// The specified resource is in use. /// </exception> /// <exception cref="Amazon.PersonalizeEvents.Model.ResourceNotFoundException"> /// Could not find the specified resource. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/PutItems">REST API Reference for PutItems Operation</seealso> PutItemsResponse PutItems(PutItemsRequest request); /// <summary> /// Initiates the asynchronous execution of the PutItems operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutItems operation on AmazonPersonalizeEventsClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutItems /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/PutItems">REST API Reference for PutItems Operation</seealso> IAsyncResult BeginPutItems(PutItemsRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutItems operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutItems.</param> /// /// <returns>Returns a PutItemsResult from PersonalizeEvents.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/PutItems">REST API Reference for PutItems Operation</seealso> PutItemsResponse EndPutItems(IAsyncResult asyncResult); #endregion #region PutUsers /// <summary> /// Adds one or more users to a Users dataset. For more information see <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html">Importing /// Users Incrementally</a>. /// </summary> /// <param name="request">Container for the necessary parameters to execute the PutUsers service method.</param> /// /// <returns>The response from the PutUsers service method, as returned by PersonalizeEvents.</returns> /// <exception cref="Amazon.PersonalizeEvents.Model.InvalidInputException"> /// Provide a valid value for the field or parameter. /// </exception> /// <exception cref="Amazon.PersonalizeEvents.Model.ResourceInUseException"> /// The specified resource is in use. /// </exception> /// <exception cref="Amazon.PersonalizeEvents.Model.ResourceNotFoundException"> /// Could not find the specified resource. /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/PutUsers">REST API Reference for PutUsers Operation</seealso> PutUsersResponse PutUsers(PutUsersRequest request); /// <summary> /// Initiates the asynchronous execution of the PutUsers operation. /// </summary> /// /// <param name="request">Container for the necessary parameters to execute the PutUsers operation on AmazonPersonalizeEventsClient.</param> /// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> /// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.</param> /// /// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutUsers /// operation.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/PutUsers">REST API Reference for PutUsers Operation</seealso> IAsyncResult BeginPutUsers(PutUsersRequest request, AsyncCallback callback, object state); /// <summary> /// Finishes the asynchronous execution of the PutUsers operation. /// </summary> /// /// <param name="asyncResult">The IAsyncResult returned by the call to BeginPutUsers.</param> /// /// <returns>Returns a PutUsersResult from PersonalizeEvents.</returns> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/PutUsers">REST API Reference for PutUsers Operation</seealso> PutUsersResponse EndPutUsers(IAsyncResult asyncResult); #endregion } }