/* * 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 ivs-realtime-2020-07-14.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.IVSRealTime.Model; namespace Amazon.IVSRealTime { /// /// Interface for accessing IVSRealTime /// /// Introduction /// /// /// /// The Amazon Interactive Video Service (IVS) stage API is REST compatible, using a standard /// HTTP API and an AWS EventBridge event stream for responses. JSON is used for both /// requests and responses, including errors. /// /// /// /// Terminology: /// /// /// /// Resources /// /// /// /// The following resources contain information about your IVS live stream (see Getting /// Started with Amazon IVS): /// /// /// /// Tagging /// /// /// /// A tag is a metadata label that you assign to an AWS resource. A tag comprises /// a key and a value, both set by you. For example, you might set a tag /// as topic:nature to label a particular video category. See Tagging /// AWS Resources for more information, including restrictions that apply to tags /// and "Tag naming limits and requirements"; Amazon IVS stages has no service-specific /// constraints beyond what is documented there. /// /// /// /// Tags can help you identify and organize your AWS resources. For example, you can use /// the same tag for different resources to indicate that they are related. You can also /// use tags to manage access (see Access /// Tags). /// /// /// /// The Amazon IVS stage API has these tag-related endpoints: TagResource, UntagResource, /// and ListTagsForResource. The following resource supports tagging: Stage. /// /// /// /// At most 50 tags can be applied to a resource. /// /// /// /// Stages Endpoints /// /// /// /// Tags Endpoints /// /// /// public partial interface IAmazonIVSRealTime : IAmazonService, IDisposable { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// IIVSRealTimePaginatorFactory Paginators { get; } #endif #region CreateParticipantToken /// /// Creates an additional token for a specified stage. This can be done after stage creation /// or when tokens expire. Tokens always are scoped to the stage for which they are created. /// /// /// /// Encryption keys are owned by Amazon IVS and never used directly by your application. /// /// /// Container for the necessary parameters to execute the CreateParticipantToken service method. /// /// The response from the CreateParticipantToken service method, as returned by IVSRealTime. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for CreateParticipantToken Operation CreateParticipantTokenResponse CreateParticipantToken(CreateParticipantTokenRequest request); /// /// Initiates the asynchronous execution of the CreateParticipantToken operation. /// /// /// Container for the necessary parameters to execute the CreateParticipantToken operation on AmazonIVSRealTimeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateParticipantToken /// operation. /// REST API Reference for CreateParticipantToken Operation IAsyncResult BeginCreateParticipantToken(CreateParticipantTokenRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateParticipantToken operation. /// /// /// The IAsyncResult returned by the call to BeginCreateParticipantToken. /// /// Returns a CreateParticipantTokenResult from IVSRealTime. /// REST API Reference for CreateParticipantToken Operation CreateParticipantTokenResponse EndCreateParticipantToken(IAsyncResult asyncResult); #endregion #region CreateStage /// /// Creates a new stage (and optionally participant tokens). /// /// Container for the necessary parameters to execute the CreateStage service method. /// /// The response from the CreateStage service method, as returned by IVSRealTime. /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for CreateStage Operation CreateStageResponse CreateStage(CreateStageRequest request); /// /// Initiates the asynchronous execution of the CreateStage operation. /// /// /// Container for the necessary parameters to execute the CreateStage operation on AmazonIVSRealTimeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateStage /// operation. /// REST API Reference for CreateStage Operation IAsyncResult BeginCreateStage(CreateStageRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateStage operation. /// /// /// The IAsyncResult returned by the call to BeginCreateStage. /// /// Returns a CreateStageResult from IVSRealTime. /// REST API Reference for CreateStage Operation CreateStageResponse EndCreateStage(IAsyncResult asyncResult); #endregion #region DeleteStage /// /// Shuts down and deletes the specified stage (disconnecting all participants). /// /// Container for the necessary parameters to execute the DeleteStage service method. /// /// The response from the DeleteStage service method, as returned by IVSRealTime. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for DeleteStage Operation DeleteStageResponse DeleteStage(DeleteStageRequest request); /// /// Initiates the asynchronous execution of the DeleteStage operation. /// /// /// Container for the necessary parameters to execute the DeleteStage operation on AmazonIVSRealTimeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteStage /// operation. /// REST API Reference for DeleteStage Operation IAsyncResult BeginDeleteStage(DeleteStageRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteStage operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteStage. /// /// Returns a DeleteStageResult from IVSRealTime. /// REST API Reference for DeleteStage Operation DeleteStageResponse EndDeleteStage(IAsyncResult asyncResult); #endregion #region DisconnectParticipant /// /// Disconnects a specified participant and revokes the participant permanently from a /// specified stage. /// /// Container for the necessary parameters to execute the DisconnectParticipant service method. /// /// The response from the DisconnectParticipant service method, as returned by IVSRealTime. /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for DisconnectParticipant Operation DisconnectParticipantResponse DisconnectParticipant(DisconnectParticipantRequest request); /// /// Initiates the asynchronous execution of the DisconnectParticipant operation. /// /// /// Container for the necessary parameters to execute the DisconnectParticipant operation on AmazonIVSRealTimeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisconnectParticipant /// operation. /// REST API Reference for DisconnectParticipant Operation IAsyncResult BeginDisconnectParticipant(DisconnectParticipantRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DisconnectParticipant operation. /// /// /// The IAsyncResult returned by the call to BeginDisconnectParticipant. /// /// Returns a DisconnectParticipantResult from IVSRealTime. /// REST API Reference for DisconnectParticipant Operation DisconnectParticipantResponse EndDisconnectParticipant(IAsyncResult asyncResult); #endregion #region GetParticipant /// /// Gets information about the specified participant token. /// /// Container for the necessary parameters to execute the GetParticipant service method. /// /// The response from the GetParticipant service method, as returned by IVSRealTime. /// /// /// /// /// /// /// /// /// /// REST API Reference for GetParticipant Operation GetParticipantResponse GetParticipant(GetParticipantRequest request); /// /// Initiates the asynchronous execution of the GetParticipant operation. /// /// /// Container for the necessary parameters to execute the GetParticipant operation on AmazonIVSRealTimeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetParticipant /// operation. /// REST API Reference for GetParticipant Operation IAsyncResult BeginGetParticipant(GetParticipantRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetParticipant operation. /// /// /// The IAsyncResult returned by the call to BeginGetParticipant. /// /// Returns a GetParticipantResult from IVSRealTime. /// REST API Reference for GetParticipant Operation GetParticipantResponse EndGetParticipant(IAsyncResult asyncResult); #endregion #region GetStage /// /// Gets information for the specified stage. /// /// Container for the necessary parameters to execute the GetStage service method. /// /// The response from the GetStage service method, as returned by IVSRealTime. /// /// /// /// /// /// /// /// /// /// REST API Reference for GetStage Operation GetStageResponse GetStage(GetStageRequest request); /// /// Initiates the asynchronous execution of the GetStage operation. /// /// /// Container for the necessary parameters to execute the GetStage operation on AmazonIVSRealTimeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetStage /// operation. /// REST API Reference for GetStage Operation IAsyncResult BeginGetStage(GetStageRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetStage operation. /// /// /// The IAsyncResult returned by the call to BeginGetStage. /// /// Returns a GetStageResult from IVSRealTime. /// REST API Reference for GetStage Operation GetStageResponse EndGetStage(IAsyncResult asyncResult); #endregion #region GetStageSession /// /// Gets information for the specified stage session. /// /// Container for the necessary parameters to execute the GetStageSession service method. /// /// The response from the GetStageSession service method, as returned by IVSRealTime. /// /// /// /// /// /// /// /// /// /// REST API Reference for GetStageSession Operation GetStageSessionResponse GetStageSession(GetStageSessionRequest request); /// /// Initiates the asynchronous execution of the GetStageSession operation. /// /// /// Container for the necessary parameters to execute the GetStageSession operation on AmazonIVSRealTimeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetStageSession /// operation. /// REST API Reference for GetStageSession Operation IAsyncResult BeginGetStageSession(GetStageSessionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetStageSession operation. /// /// /// The IAsyncResult returned by the call to BeginGetStageSession. /// /// Returns a GetStageSessionResult from IVSRealTime. /// REST API Reference for GetStageSession Operation GetStageSessionResponse EndGetStageSession(IAsyncResult asyncResult); #endregion #region ListParticipantEvents /// /// Lists events for a specified participant that occurred during a specified stage session. /// /// Container for the necessary parameters to execute the ListParticipantEvents service method. /// /// The response from the ListParticipantEvents service method, as returned by IVSRealTime. /// /// /// /// /// /// /// REST API Reference for ListParticipantEvents Operation ListParticipantEventsResponse ListParticipantEvents(ListParticipantEventsRequest request); /// /// Initiates the asynchronous execution of the ListParticipantEvents operation. /// /// /// Container for the necessary parameters to execute the ListParticipantEvents operation on AmazonIVSRealTimeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListParticipantEvents /// operation. /// REST API Reference for ListParticipantEvents Operation IAsyncResult BeginListParticipantEvents(ListParticipantEventsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListParticipantEvents operation. /// /// /// The IAsyncResult returned by the call to BeginListParticipantEvents. /// /// Returns a ListParticipantEventsResult from IVSRealTime. /// REST API Reference for ListParticipantEvents Operation ListParticipantEventsResponse EndListParticipantEvents(IAsyncResult asyncResult); #endregion #region ListParticipants /// /// Lists all participants in a specified stage session. /// /// Container for the necessary parameters to execute the ListParticipants service method. /// /// The response from the ListParticipants service method, as returned by IVSRealTime. /// /// /// /// /// /// /// REST API Reference for ListParticipants Operation ListParticipantsResponse ListParticipants(ListParticipantsRequest request); /// /// Initiates the asynchronous execution of the ListParticipants operation. /// /// /// Container for the necessary parameters to execute the ListParticipants operation on AmazonIVSRealTimeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListParticipants /// operation. /// REST API Reference for ListParticipants Operation IAsyncResult BeginListParticipants(ListParticipantsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListParticipants operation. /// /// /// The IAsyncResult returned by the call to BeginListParticipants. /// /// Returns a ListParticipantsResult from IVSRealTime. /// REST API Reference for ListParticipants Operation ListParticipantsResponse EndListParticipants(IAsyncResult asyncResult); #endregion #region ListStages /// /// Gets summary information about all stages in your account, in the AWS region where /// the API request is processed. /// /// Container for the necessary parameters to execute the ListStages service method. /// /// The response from the ListStages service method, as returned by IVSRealTime. /// /// /// /// /// /// /// /// /// /// REST API Reference for ListStages Operation ListStagesResponse ListStages(ListStagesRequest request); /// /// Initiates the asynchronous execution of the ListStages operation. /// /// /// Container for the necessary parameters to execute the ListStages operation on AmazonIVSRealTimeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListStages /// operation. /// REST API Reference for ListStages Operation IAsyncResult BeginListStages(ListStagesRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListStages operation. /// /// /// The IAsyncResult returned by the call to BeginListStages. /// /// Returns a ListStagesResult from IVSRealTime. /// REST API Reference for ListStages Operation ListStagesResponse EndListStages(IAsyncResult asyncResult); #endregion #region ListStageSessions /// /// Gets all sessions for a specified stage. /// /// Container for the necessary parameters to execute the ListStageSessions service method. /// /// The response from the ListStageSessions service method, as returned by IVSRealTime. /// /// /// /// /// /// /// REST API Reference for ListStageSessions Operation ListStageSessionsResponse ListStageSessions(ListStageSessionsRequest request); /// /// Initiates the asynchronous execution of the ListStageSessions operation. /// /// /// Container for the necessary parameters to execute the ListStageSessions operation on AmazonIVSRealTimeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListStageSessions /// operation. /// REST API Reference for ListStageSessions Operation IAsyncResult BeginListStageSessions(ListStageSessionsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListStageSessions operation. /// /// /// The IAsyncResult returned by the call to BeginListStageSessions. /// /// Returns a ListStageSessionsResult from IVSRealTime. /// REST API Reference for ListStageSessions Operation ListStageSessionsResponse EndListStageSessions(IAsyncResult asyncResult); #endregion #region ListTagsForResource /// /// Gets information about AWS tags for the specified ARN. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// The response from the ListTagsForResource service method, as returned by IVSRealTime. /// /// /// /// /// /// /// /// /// /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request); /// /// Initiates the asynchronous execution of the ListTagsForResource operation. /// /// /// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonIVSRealTimeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource /// operation. /// REST API Reference for ListTagsForResource Operation IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListTagsForResource operation. /// /// /// The IAsyncResult returned by the call to BeginListTagsForResource. /// /// Returns a ListTagsForResourceResult from IVSRealTime. /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult); #endregion #region TagResource /// /// Adds or updates tags for the AWS resource with the specified ARN. /// /// Container for the necessary parameters to execute the TagResource service method. /// /// The response from the TagResource service method, as returned by IVSRealTime. /// /// /// /// /// /// /// /// /// /// REST API Reference for TagResource Operation TagResourceResponse TagResource(TagResourceRequest request); /// /// Initiates the asynchronous execution of the TagResource operation. /// /// /// Container for the necessary parameters to execute the TagResource operation on AmazonIVSRealTimeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource /// operation. /// REST API Reference for TagResource Operation IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the TagResource operation. /// /// /// The IAsyncResult returned by the call to BeginTagResource. /// /// Returns a TagResourceResult from IVSRealTime. /// REST API Reference for TagResource Operation TagResourceResponse EndTagResource(IAsyncResult asyncResult); #endregion #region UntagResource /// /// Removes tags from the resource with the specified ARN. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// The response from the UntagResource service method, as returned by IVSRealTime. /// /// /// /// /// /// /// /// /// /// REST API Reference for UntagResource Operation UntagResourceResponse UntagResource(UntagResourceRequest request); /// /// Initiates the asynchronous execution of the UntagResource operation. /// /// /// Container for the necessary parameters to execute the UntagResource operation on AmazonIVSRealTimeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource /// operation. /// REST API Reference for UntagResource Operation IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UntagResource operation. /// /// /// The IAsyncResult returned by the call to BeginUntagResource. /// /// Returns a UntagResourceResult from IVSRealTime. /// REST API Reference for UntagResource Operation UntagResourceResponse EndUntagResource(IAsyncResult asyncResult); #endregion #region UpdateStage /// /// Updates a stage’s configuration. /// /// Container for the necessary parameters to execute the UpdateStage service method. /// /// The response from the UpdateStage service method, as returned by IVSRealTime. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for UpdateStage Operation UpdateStageResponse UpdateStage(UpdateStageRequest request); /// /// Initiates the asynchronous execution of the UpdateStage operation. /// /// /// Container for the necessary parameters to execute the UpdateStage operation on AmazonIVSRealTimeClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateStage /// operation. /// REST API Reference for UpdateStage Operation IAsyncResult BeginUpdateStage(UpdateStageRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateStage operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateStage. /// /// Returns a UpdateStageResult from IVSRealTime. /// REST API Reference for UpdateStage Operation UpdateStageResponse EndUpdateStage(IAsyncResult asyncResult); #endregion } }