/* * 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-2020-07-14.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.IVS.Model; namespace Amazon.IVS { /// /// Interface for accessing IVS /// /// Introduction /// /// /// /// The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard /// HTTP API and an Amazon Web Services EventBridge event stream for responses. JSON is /// used for both requests and responses, including errors. /// /// /// /// The API is an Amazon Web Services regional service. For a list of supported regions /// and Amazon IVS HTTPS service endpoints, see the Amazon /// IVS page in the Amazon Web Services General Reference. /// /// /// /// All API request parameters and URLs are case sensitive. /// /// /// /// For a summary of notable documentation changes in each release, see /// Document History. /// /// /// /// Allowed Header Values /// /// /// /// 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 Amazon Web Services 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 /// Amazon Web Services Resources for more information, including restrictions that /// apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific /// constraints beyond what is documented there. /// /// /// /// Tags can help you identify and organize your Amazon Web Services 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 API has these tag-related endpoints: TagResource, UntagResource, /// and ListTagsForResource. The following resources support tagging: Channels, /// Stream Keys, Playback Key Pairs, and Recording Configurations. /// /// /// /// At most 50 tags can be applied to a resource. /// /// /// /// Authentication versus Authorization /// /// /// /// Note the differences between these concepts: /// /// /// /// Authentication /// /// /// /// All Amazon IVS API requests must be authenticated with a signature. The Amazon Web /// Services Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing /// the underlying API calls for you. However, if your application calls the Amazon IVS /// API directly, it’s your responsibility to sign the requests. /// /// /// /// You generate a signature using valid Amazon Web Services credentials that have permission /// to perform the requested action. For example, you must sign PutMetadata requests with /// a signature generated from a user account that has the ivs:PutMetadata /// permission. /// /// /// /// For more information: /// /// /// /// Amazon Resource Names (ARNs) /// /// /// /// ARNs uniquely identify AWS resources. An ARN is required when you need to specify /// a resource unambiguously across all of AWS, such as in IAM policies and API calls. /// For more information, see Amazon /// Resource Names in the AWS General Reference. /// /// /// /// Channel Endpoints /// /// /// /// StreamKey Endpoints /// /// /// /// Stream Endpoints /// /// /// /// Private Channel Endpoints /// /// /// /// For more information, see Setting /// Up Private Channels in the Amazon IVS User Guide. /// /// /// /// RecordingConfiguration Endpoints /// /// /// /// Amazon Web Services Tags Endpoints /// /// /// public partial interface IAmazonIVS : IAmazonService, IDisposable { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// IIVSPaginatorFactory Paginators { get; } #endif #region BatchGetChannel /// /// Performs GetChannel on multiple ARNs simultaneously. /// /// Container for the necessary parameters to execute the BatchGetChannel service method. /// /// The response from the BatchGetChannel service method, as returned by IVS. /// REST API Reference for BatchGetChannel Operation BatchGetChannelResponse BatchGetChannel(BatchGetChannelRequest request); /// /// Initiates the asynchronous execution of the BatchGetChannel operation. /// /// /// Container for the necessary parameters to execute the BatchGetChannel operation on AmazonIVSClient. /// 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 EndBatchGetChannel /// operation. /// REST API Reference for BatchGetChannel Operation IAsyncResult BeginBatchGetChannel(BatchGetChannelRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the BatchGetChannel operation. /// /// /// The IAsyncResult returned by the call to BeginBatchGetChannel. /// /// Returns a BatchGetChannelResult from IVS. /// REST API Reference for BatchGetChannel Operation BatchGetChannelResponse EndBatchGetChannel(IAsyncResult asyncResult); #endregion #region BatchGetStreamKey /// /// Performs GetStreamKey on multiple ARNs simultaneously. /// /// Container for the necessary parameters to execute the BatchGetStreamKey service method. /// /// The response from the BatchGetStreamKey service method, as returned by IVS. /// REST API Reference for BatchGetStreamKey Operation BatchGetStreamKeyResponse BatchGetStreamKey(BatchGetStreamKeyRequest request); /// /// Initiates the asynchronous execution of the BatchGetStreamKey operation. /// /// /// Container for the necessary parameters to execute the BatchGetStreamKey operation on AmazonIVSClient. /// 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 EndBatchGetStreamKey /// operation. /// REST API Reference for BatchGetStreamKey Operation IAsyncResult BeginBatchGetStreamKey(BatchGetStreamKeyRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the BatchGetStreamKey operation. /// /// /// The IAsyncResult returned by the call to BeginBatchGetStreamKey. /// /// Returns a BatchGetStreamKeyResult from IVS. /// REST API Reference for BatchGetStreamKey Operation BatchGetStreamKeyResponse EndBatchGetStreamKey(IAsyncResult asyncResult); #endregion #region BatchStartViewerSessionRevocation /// /// Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID /// pairs simultaneously. /// /// Container for the necessary parameters to execute the BatchStartViewerSessionRevocation service method. /// /// The response from the BatchStartViewerSessionRevocation service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for BatchStartViewerSessionRevocation Operation BatchStartViewerSessionRevocationResponse BatchStartViewerSessionRevocation(BatchStartViewerSessionRevocationRequest request); /// /// Initiates the asynchronous execution of the BatchStartViewerSessionRevocation operation. /// /// /// Container for the necessary parameters to execute the BatchStartViewerSessionRevocation operation on AmazonIVSClient. /// 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 EndBatchStartViewerSessionRevocation /// operation. /// REST API Reference for BatchStartViewerSessionRevocation Operation IAsyncResult BeginBatchStartViewerSessionRevocation(BatchStartViewerSessionRevocationRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the BatchStartViewerSessionRevocation operation. /// /// /// The IAsyncResult returned by the call to BeginBatchStartViewerSessionRevocation. /// /// Returns a BatchStartViewerSessionRevocationResult from IVS. /// REST API Reference for BatchStartViewerSessionRevocation Operation BatchStartViewerSessionRevocationResponse EndBatchStartViewerSessionRevocation(IAsyncResult asyncResult); #endregion #region CreateChannel /// /// Creates a new channel and an associated stream key to start streaming. /// /// Container for the necessary parameters to execute the CreateChannel service method. /// /// The response from the CreateChannel service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for CreateChannel Operation CreateChannelResponse CreateChannel(CreateChannelRequest request); /// /// Initiates the asynchronous execution of the CreateChannel operation. /// /// /// Container for the necessary parameters to execute the CreateChannel operation on AmazonIVSClient. /// 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 EndCreateChannel /// operation. /// REST API Reference for CreateChannel Operation IAsyncResult BeginCreateChannel(CreateChannelRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateChannel operation. /// /// /// The IAsyncResult returned by the call to BeginCreateChannel. /// /// Returns a CreateChannelResult from IVS. /// REST API Reference for CreateChannel Operation CreateChannelResponse EndCreateChannel(IAsyncResult asyncResult); #endregion #region CreateRecordingConfiguration /// /// Creates a new recording configuration, used to enable recording to Amazon S3. /// /// /// /// Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI /// to create a recording configuration, it returns success even if the S3 bucket is in /// a different region. In this case, the state of the recording configuration /// is CREATE_FAILED (instead of ACTIVE). (In other regions, /// the CLI correctly returns failure if the bucket is in a different region.) /// /// /// /// Workaround: Ensure that your S3 bucket is in the same region as the recording /// configuration. If you create a recording configuration in a different region as your /// S3 bucket, delete that recording configuration and create a new one with an S3 bucket /// from the correct region. /// /// /// Container for the necessary parameters to execute the CreateRecordingConfiguration service method. /// /// The response from the CreateRecordingConfiguration service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for CreateRecordingConfiguration Operation CreateRecordingConfigurationResponse CreateRecordingConfiguration(CreateRecordingConfigurationRequest request); /// /// Initiates the asynchronous execution of the CreateRecordingConfiguration operation. /// /// /// Container for the necessary parameters to execute the CreateRecordingConfiguration operation on AmazonIVSClient. /// 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 EndCreateRecordingConfiguration /// operation. /// REST API Reference for CreateRecordingConfiguration Operation IAsyncResult BeginCreateRecordingConfiguration(CreateRecordingConfigurationRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateRecordingConfiguration operation. /// /// /// The IAsyncResult returned by the call to BeginCreateRecordingConfiguration. /// /// Returns a CreateRecordingConfigurationResult from IVS. /// REST API Reference for CreateRecordingConfiguration Operation CreateRecordingConfigurationResponse EndCreateRecordingConfiguration(IAsyncResult asyncResult); #endregion #region CreateStreamKey /// /// Creates a stream key, used to initiate a stream, for the specified channel ARN. /// /// /// /// Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey /// on the same channel, it will fail because a stream key already exists and there is /// a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey /// and then CreateStreamKey. /// /// /// Container for the necessary parameters to execute the CreateStreamKey service method. /// /// The response from the CreateStreamKey service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for CreateStreamKey Operation CreateStreamKeyResponse CreateStreamKey(CreateStreamKeyRequest request); /// /// Initiates the asynchronous execution of the CreateStreamKey operation. /// /// /// Container for the necessary parameters to execute the CreateStreamKey operation on AmazonIVSClient. /// 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 EndCreateStreamKey /// operation. /// REST API Reference for CreateStreamKey Operation IAsyncResult BeginCreateStreamKey(CreateStreamKeyRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateStreamKey operation. /// /// /// The IAsyncResult returned by the call to BeginCreateStreamKey. /// /// Returns a CreateStreamKeyResult from IVS. /// REST API Reference for CreateStreamKey Operation CreateStreamKeyResponse EndCreateStreamKey(IAsyncResult asyncResult); #endregion #region DeleteChannel /// /// Deletes the specified channel and its associated stream keys. /// /// /// /// If you try to delete a live channel, you will get an error (409 ConflictException). /// To delete a channel that is live, call StopStream, wait for the Amazon EventBridge /// "Stream End" event (to verify that the stream's state is no longer Live), then call /// DeleteChannel. (See /// Using EventBridge with Amazon IVS.) /// /// /// Container for the necessary parameters to execute the DeleteChannel service method. /// /// The response from the DeleteChannel service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for DeleteChannel Operation DeleteChannelResponse DeleteChannel(DeleteChannelRequest request); /// /// Initiates the asynchronous execution of the DeleteChannel operation. /// /// /// Container for the necessary parameters to execute the DeleteChannel operation on AmazonIVSClient. /// 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 EndDeleteChannel /// operation. /// REST API Reference for DeleteChannel Operation IAsyncResult BeginDeleteChannel(DeleteChannelRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteChannel operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteChannel. /// /// Returns a DeleteChannelResult from IVS. /// REST API Reference for DeleteChannel Operation DeleteChannelResponse EndDeleteChannel(IAsyncResult asyncResult); #endregion #region DeletePlaybackKeyPair /// /// Deletes a specified authorization key pair. This invalidates future viewer tokens /// generated using the key pair’s privateKey. For more information, see /// Setting /// Up Private Channels in the Amazon IVS User Guide. /// /// Container for the necessary parameters to execute the DeletePlaybackKeyPair service method. /// /// The response from the DeletePlaybackKeyPair service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for DeletePlaybackKeyPair Operation DeletePlaybackKeyPairResponse DeletePlaybackKeyPair(DeletePlaybackKeyPairRequest request); /// /// Initiates the asynchronous execution of the DeletePlaybackKeyPair operation. /// /// /// Container for the necessary parameters to execute the DeletePlaybackKeyPair operation on AmazonIVSClient. /// 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 EndDeletePlaybackKeyPair /// operation. /// REST API Reference for DeletePlaybackKeyPair Operation IAsyncResult BeginDeletePlaybackKeyPair(DeletePlaybackKeyPairRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeletePlaybackKeyPair operation. /// /// /// The IAsyncResult returned by the call to BeginDeletePlaybackKeyPair. /// /// Returns a DeletePlaybackKeyPairResult from IVS. /// REST API Reference for DeletePlaybackKeyPair Operation DeletePlaybackKeyPairResponse EndDeletePlaybackKeyPair(IAsyncResult asyncResult); #endregion #region DeleteRecordingConfiguration /// /// Deletes the recording configuration for the specified ARN. /// /// /// /// If you try to delete a recording configuration that is associated with a channel, /// you will get an error (409 ConflictException). To avoid this, for all channels that /// reference the recording configuration, first use UpdateChannel to set the recordingConfigurationArn /// field to an empty string, then use DeleteRecordingConfiguration. /// /// /// Container for the necessary parameters to execute the DeleteRecordingConfiguration service method. /// /// The response from the DeleteRecordingConfiguration service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for DeleteRecordingConfiguration Operation DeleteRecordingConfigurationResponse DeleteRecordingConfiguration(DeleteRecordingConfigurationRequest request); /// /// Initiates the asynchronous execution of the DeleteRecordingConfiguration operation. /// /// /// Container for the necessary parameters to execute the DeleteRecordingConfiguration operation on AmazonIVSClient. /// 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 EndDeleteRecordingConfiguration /// operation. /// REST API Reference for DeleteRecordingConfiguration Operation IAsyncResult BeginDeleteRecordingConfiguration(DeleteRecordingConfigurationRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteRecordingConfiguration operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteRecordingConfiguration. /// /// Returns a DeleteRecordingConfigurationResult from IVS. /// REST API Reference for DeleteRecordingConfiguration Operation DeleteRecordingConfigurationResponse EndDeleteRecordingConfiguration(IAsyncResult asyncResult); #endregion #region DeleteStreamKey /// /// Deletes the stream key for the specified ARN, so it can no longer be used to stream. /// /// Container for the necessary parameters to execute the DeleteStreamKey service method. /// /// The response from the DeleteStreamKey service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for DeleteStreamKey Operation DeleteStreamKeyResponse DeleteStreamKey(DeleteStreamKeyRequest request); /// /// Initiates the asynchronous execution of the DeleteStreamKey operation. /// /// /// Container for the necessary parameters to execute the DeleteStreamKey operation on AmazonIVSClient. /// 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 EndDeleteStreamKey /// operation. /// REST API Reference for DeleteStreamKey Operation IAsyncResult BeginDeleteStreamKey(DeleteStreamKeyRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteStreamKey operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteStreamKey. /// /// Returns a DeleteStreamKeyResult from IVS. /// REST API Reference for DeleteStreamKey Operation DeleteStreamKeyResponse EndDeleteStreamKey(IAsyncResult asyncResult); #endregion #region GetChannel /// /// Gets the channel configuration for the specified channel ARN. See also BatchGetChannel. /// /// Container for the necessary parameters to execute the GetChannel service method. /// /// The response from the GetChannel service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// REST API Reference for GetChannel Operation GetChannelResponse GetChannel(GetChannelRequest request); /// /// Initiates the asynchronous execution of the GetChannel operation. /// /// /// Container for the necessary parameters to execute the GetChannel operation on AmazonIVSClient. /// 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 EndGetChannel /// operation. /// REST API Reference for GetChannel Operation IAsyncResult BeginGetChannel(GetChannelRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetChannel operation. /// /// /// The IAsyncResult returned by the call to BeginGetChannel. /// /// Returns a GetChannelResult from IVS. /// REST API Reference for GetChannel Operation GetChannelResponse EndGetChannel(IAsyncResult asyncResult); #endregion #region GetPlaybackKeyPair /// /// Gets a specified playback authorization key pair and returns the arn /// and fingerprint. The privateKey held by the caller can be /// used to generate viewer authorization tokens, to grant viewers access to private channels. /// For more information, see Setting /// Up Private Channels in the Amazon IVS User Guide. /// /// Container for the necessary parameters to execute the GetPlaybackKeyPair service method. /// /// The response from the GetPlaybackKeyPair service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// REST API Reference for GetPlaybackKeyPair Operation GetPlaybackKeyPairResponse GetPlaybackKeyPair(GetPlaybackKeyPairRequest request); /// /// Initiates the asynchronous execution of the GetPlaybackKeyPair operation. /// /// /// Container for the necessary parameters to execute the GetPlaybackKeyPair operation on AmazonIVSClient. /// 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 EndGetPlaybackKeyPair /// operation. /// REST API Reference for GetPlaybackKeyPair Operation IAsyncResult BeginGetPlaybackKeyPair(GetPlaybackKeyPairRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetPlaybackKeyPair operation. /// /// /// The IAsyncResult returned by the call to BeginGetPlaybackKeyPair. /// /// Returns a GetPlaybackKeyPairResult from IVS. /// REST API Reference for GetPlaybackKeyPair Operation GetPlaybackKeyPairResponse EndGetPlaybackKeyPair(IAsyncResult asyncResult); #endregion #region GetRecordingConfiguration /// /// Gets the recording configuration for the specified ARN. /// /// Container for the necessary parameters to execute the GetRecordingConfiguration service method. /// /// The response from the GetRecordingConfiguration service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for GetRecordingConfiguration Operation GetRecordingConfigurationResponse GetRecordingConfiguration(GetRecordingConfigurationRequest request); /// /// Initiates the asynchronous execution of the GetRecordingConfiguration operation. /// /// /// Container for the necessary parameters to execute the GetRecordingConfiguration operation on AmazonIVSClient. /// 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 EndGetRecordingConfiguration /// operation. /// REST API Reference for GetRecordingConfiguration Operation IAsyncResult BeginGetRecordingConfiguration(GetRecordingConfigurationRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetRecordingConfiguration operation. /// /// /// The IAsyncResult returned by the call to BeginGetRecordingConfiguration. /// /// Returns a GetRecordingConfigurationResult from IVS. /// REST API Reference for GetRecordingConfiguration Operation GetRecordingConfigurationResponse EndGetRecordingConfiguration(IAsyncResult asyncResult); #endregion #region GetStream /// /// Gets information about the active (live) stream on a specified channel. /// /// Container for the necessary parameters to execute the GetStream service method. /// /// The response from the GetStream service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for GetStream Operation GetStreamResponse GetStream(GetStreamRequest request); /// /// Initiates the asynchronous execution of the GetStream operation. /// /// /// Container for the necessary parameters to execute the GetStream operation on AmazonIVSClient. /// 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 EndGetStream /// operation. /// REST API Reference for GetStream Operation IAsyncResult BeginGetStream(GetStreamRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetStream operation. /// /// /// The IAsyncResult returned by the call to BeginGetStream. /// /// Returns a GetStreamResult from IVS. /// REST API Reference for GetStream Operation GetStreamResponse EndGetStream(IAsyncResult asyncResult); #endregion #region GetStreamKey /// /// Gets stream-key information for a specified ARN. /// /// Container for the necessary parameters to execute the GetStreamKey service method. /// /// The response from the GetStreamKey service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// REST API Reference for GetStreamKey Operation GetStreamKeyResponse GetStreamKey(GetStreamKeyRequest request); /// /// Initiates the asynchronous execution of the GetStreamKey operation. /// /// /// Container for the necessary parameters to execute the GetStreamKey operation on AmazonIVSClient. /// 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 EndGetStreamKey /// operation. /// REST API Reference for GetStreamKey Operation IAsyncResult BeginGetStreamKey(GetStreamKeyRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetStreamKey operation. /// /// /// The IAsyncResult returned by the call to BeginGetStreamKey. /// /// Returns a GetStreamKeyResult from IVS. /// REST API Reference for GetStreamKey Operation GetStreamKeyResponse EndGetStreamKey(IAsyncResult asyncResult); #endregion #region GetStreamSession /// /// Gets metadata on a specified stream. /// /// Container for the necessary parameters to execute the GetStreamSession service method. /// /// The response from the GetStreamSession service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// REST API Reference for GetStreamSession Operation GetStreamSessionResponse GetStreamSession(GetStreamSessionRequest request); /// /// Initiates the asynchronous execution of the GetStreamSession operation. /// /// /// Container for the necessary parameters to execute the GetStreamSession operation on AmazonIVSClient. /// 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 EndGetStreamSession /// operation. /// REST API Reference for GetStreamSession Operation IAsyncResult BeginGetStreamSession(GetStreamSessionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetStreamSession operation. /// /// /// The IAsyncResult returned by the call to BeginGetStreamSession. /// /// Returns a GetStreamSessionResult from IVS. /// REST API Reference for GetStreamSession Operation GetStreamSessionResponse EndGetStreamSession(IAsyncResult asyncResult); #endregion #region ImportPlaybackKeyPair /// /// Imports the public portion of a new key pair and returns its arn and /// fingerprint. The privateKey can then be used to generate /// viewer authorization tokens, to grant viewers access to private channels. For more /// information, see Setting /// Up Private Channels in the Amazon IVS User Guide. /// /// Container for the necessary parameters to execute the ImportPlaybackKeyPair service method. /// /// The response from the ImportPlaybackKeyPair service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for ImportPlaybackKeyPair Operation ImportPlaybackKeyPairResponse ImportPlaybackKeyPair(ImportPlaybackKeyPairRequest request); /// /// Initiates the asynchronous execution of the ImportPlaybackKeyPair operation. /// /// /// Container for the necessary parameters to execute the ImportPlaybackKeyPair operation on AmazonIVSClient. /// 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 EndImportPlaybackKeyPair /// operation. /// REST API Reference for ImportPlaybackKeyPair Operation IAsyncResult BeginImportPlaybackKeyPair(ImportPlaybackKeyPairRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ImportPlaybackKeyPair operation. /// /// /// The IAsyncResult returned by the call to BeginImportPlaybackKeyPair. /// /// Returns a ImportPlaybackKeyPairResult from IVS. /// REST API Reference for ImportPlaybackKeyPair Operation ImportPlaybackKeyPairResponse EndImportPlaybackKeyPair(IAsyncResult asyncResult); #endregion #region ListChannels /// /// Gets summary information about all channels in your account, in the Amazon Web Services /// region where the API request is processed. This list can be filtered to match a specified /// name or recording-configuration ARN. Filters are mutually exclusive and cannot be /// used together. If you try to use both filters, you will get an error (409 ConflictException). /// /// Container for the necessary parameters to execute the ListChannels service method. /// /// The response from the ListChannels service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// REST API Reference for ListChannels Operation ListChannelsResponse ListChannels(ListChannelsRequest request); /// /// Initiates the asynchronous execution of the ListChannels operation. /// /// /// Container for the necessary parameters to execute the ListChannels operation on AmazonIVSClient. /// 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 EndListChannels /// operation. /// REST API Reference for ListChannels Operation IAsyncResult BeginListChannels(ListChannelsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListChannels operation. /// /// /// The IAsyncResult returned by the call to BeginListChannels. /// /// Returns a ListChannelsResult from IVS. /// REST API Reference for ListChannels Operation ListChannelsResponse EndListChannels(IAsyncResult asyncResult); #endregion #region ListPlaybackKeyPairs /// /// Gets summary information about playback key pairs. For more information, see Setting /// Up Private Channels in the Amazon IVS User Guide. /// /// Container for the necessary parameters to execute the ListPlaybackKeyPairs service method. /// /// The response from the ListPlaybackKeyPairs service method, as returned by IVS. /// /// /// /// /// /// /// REST API Reference for ListPlaybackKeyPairs Operation ListPlaybackKeyPairsResponse ListPlaybackKeyPairs(ListPlaybackKeyPairsRequest request); /// /// Initiates the asynchronous execution of the ListPlaybackKeyPairs operation. /// /// /// Container for the necessary parameters to execute the ListPlaybackKeyPairs operation on AmazonIVSClient. /// 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 EndListPlaybackKeyPairs /// operation. /// REST API Reference for ListPlaybackKeyPairs Operation IAsyncResult BeginListPlaybackKeyPairs(ListPlaybackKeyPairsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListPlaybackKeyPairs operation. /// /// /// The IAsyncResult returned by the call to BeginListPlaybackKeyPairs. /// /// Returns a ListPlaybackKeyPairsResult from IVS. /// REST API Reference for ListPlaybackKeyPairs Operation ListPlaybackKeyPairsResponse EndListPlaybackKeyPairs(IAsyncResult asyncResult); #endregion #region ListRecordingConfigurations /// /// Gets summary information about all recording configurations in your account, in the /// Amazon Web Services region where the API request is processed. /// /// Container for the necessary parameters to execute the ListRecordingConfigurations service method. /// /// The response from the ListRecordingConfigurations service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// REST API Reference for ListRecordingConfigurations Operation ListRecordingConfigurationsResponse ListRecordingConfigurations(ListRecordingConfigurationsRequest request); /// /// Initiates the asynchronous execution of the ListRecordingConfigurations operation. /// /// /// Container for the necessary parameters to execute the ListRecordingConfigurations operation on AmazonIVSClient. /// 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 EndListRecordingConfigurations /// operation. /// REST API Reference for ListRecordingConfigurations Operation IAsyncResult BeginListRecordingConfigurations(ListRecordingConfigurationsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListRecordingConfigurations operation. /// /// /// The IAsyncResult returned by the call to BeginListRecordingConfigurations. /// /// Returns a ListRecordingConfigurationsResult from IVS. /// REST API Reference for ListRecordingConfigurations Operation ListRecordingConfigurationsResponse EndListRecordingConfigurations(IAsyncResult asyncResult); #endregion #region ListStreamKeys /// /// Gets summary information about stream keys for the specified channel. /// /// Container for the necessary parameters to execute the ListStreamKeys service method. /// /// The response from the ListStreamKeys service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// REST API Reference for ListStreamKeys Operation ListStreamKeysResponse ListStreamKeys(ListStreamKeysRequest request); /// /// Initiates the asynchronous execution of the ListStreamKeys operation. /// /// /// Container for the necessary parameters to execute the ListStreamKeys operation on AmazonIVSClient. /// 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 EndListStreamKeys /// operation. /// REST API Reference for ListStreamKeys Operation IAsyncResult BeginListStreamKeys(ListStreamKeysRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListStreamKeys operation. /// /// /// The IAsyncResult returned by the call to BeginListStreamKeys. /// /// Returns a ListStreamKeysResult from IVS. /// REST API Reference for ListStreamKeys Operation ListStreamKeysResponse EndListStreamKeys(IAsyncResult asyncResult); #endregion #region ListStreams /// /// Gets summary information about live streams in your account, in the Amazon Web Services /// region where the API request is processed. /// /// Container for the necessary parameters to execute the ListStreams service method. /// /// The response from the ListStreams service method, as returned by IVS. /// /// /// /// /// /// /// REST API Reference for ListStreams Operation ListStreamsResponse ListStreams(ListStreamsRequest request); /// /// Initiates the asynchronous execution of the ListStreams operation. /// /// /// Container for the necessary parameters to execute the ListStreams operation on AmazonIVSClient. /// 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 EndListStreams /// operation. /// REST API Reference for ListStreams Operation IAsyncResult BeginListStreams(ListStreamsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListStreams operation. /// /// /// The IAsyncResult returned by the call to BeginListStreams. /// /// Returns a ListStreamsResult from IVS. /// REST API Reference for ListStreams Operation ListStreamsResponse EndListStreams(IAsyncResult asyncResult); #endregion #region ListStreamSessions /// /// Gets a summary of current and previous streams for a specified channel in your account, /// in the AWS region where the API request is processed. /// /// Container for the necessary parameters to execute the ListStreamSessions service method. /// /// The response from the ListStreamSessions service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// REST API Reference for ListStreamSessions Operation ListStreamSessionsResponse ListStreamSessions(ListStreamSessionsRequest request); /// /// Initiates the asynchronous execution of the ListStreamSessions operation. /// /// /// Container for the necessary parameters to execute the ListStreamSessions operation on AmazonIVSClient. /// 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 EndListStreamSessions /// operation. /// REST API Reference for ListStreamSessions Operation IAsyncResult BeginListStreamSessions(ListStreamSessionsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListStreamSessions operation. /// /// /// The IAsyncResult returned by the call to BeginListStreamSessions. /// /// Returns a ListStreamSessionsResult from IVS. /// REST API Reference for ListStreamSessions Operation ListStreamSessionsResponse EndListStreamSessions(IAsyncResult asyncResult); #endregion #region ListTagsForResource /// /// Gets information about Amazon Web Services 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 IVS. /// /// /// /// /// /// /// /// /// /// 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 AmazonIVSClient. /// 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 IVS. /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult); #endregion #region PutMetadata /// /// Inserts metadata into the active stream of the specified channel. At most 5 requests /// per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is /// not sufficient for your needs, we recommend batching your data into a single PutMetadata /// call.) At most 155 requests per second per account are allowed. Also see Embedding /// Metadata within a Video Stream in the Amazon IVS User Guide. /// /// Container for the necessary parameters to execute the PutMetadata service method. /// /// The response from the PutMetadata service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for PutMetadata Operation PutMetadataResponse PutMetadata(PutMetadataRequest request); /// /// Initiates the asynchronous execution of the PutMetadata operation. /// /// /// Container for the necessary parameters to execute the PutMetadata operation on AmazonIVSClient. /// 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 EndPutMetadata /// operation. /// REST API Reference for PutMetadata Operation IAsyncResult BeginPutMetadata(PutMetadataRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the PutMetadata operation. /// /// /// The IAsyncResult returned by the call to BeginPutMetadata. /// /// Returns a PutMetadataResult from IVS. /// REST API Reference for PutMetadata Operation PutMetadataResponse EndPutMetadata(IAsyncResult asyncResult); #endregion #region StartViewerSessionRevocation /// /// Starts the process of revoking the viewer session associated with a specified channel /// ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions /// less than and including that version. For instructions on associating a viewer ID /// with a viewer session, see Setting /// Up Private Channels. /// /// Container for the necessary parameters to execute the StartViewerSessionRevocation service method. /// /// The response from the StartViewerSessionRevocation service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for StartViewerSessionRevocation Operation StartViewerSessionRevocationResponse StartViewerSessionRevocation(StartViewerSessionRevocationRequest request); /// /// Initiates the asynchronous execution of the StartViewerSessionRevocation operation. /// /// /// Container for the necessary parameters to execute the StartViewerSessionRevocation operation on AmazonIVSClient. /// 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 EndStartViewerSessionRevocation /// operation. /// REST API Reference for StartViewerSessionRevocation Operation IAsyncResult BeginStartViewerSessionRevocation(StartViewerSessionRevocationRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StartViewerSessionRevocation operation. /// /// /// The IAsyncResult returned by the call to BeginStartViewerSessionRevocation. /// /// Returns a StartViewerSessionRevocationResult from IVS. /// REST API Reference for StartViewerSessionRevocation Operation StartViewerSessionRevocationResponse EndStartViewerSessionRevocation(IAsyncResult asyncResult); #endregion #region StopStream /// /// Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction /// with DeleteStreamKey to prevent further streaming to a channel. /// /// /// /// Many streaming client-software libraries automatically reconnect a dropped RTMPS session, /// so to stop the stream permanently, you may want to first revoke the streamKey /// attached to the channel. /// /// /// /// Container for the necessary parameters to execute the StopStream service method. /// /// The response from the StopStream service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for StopStream Operation StopStreamResponse StopStream(StopStreamRequest request); /// /// Initiates the asynchronous execution of the StopStream operation. /// /// /// Container for the necessary parameters to execute the StopStream operation on AmazonIVSClient. /// 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 EndStopStream /// operation. /// REST API Reference for StopStream Operation IAsyncResult BeginStopStream(StopStreamRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StopStream operation. /// /// /// The IAsyncResult returned by the call to BeginStopStream. /// /// Returns a StopStreamResult from IVS. /// REST API Reference for StopStream Operation StopStreamResponse EndStopStream(IAsyncResult asyncResult); #endregion #region TagResource /// /// Adds or updates tags for the Amazon Web Services 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 IVS. /// /// /// /// /// /// /// /// /// /// 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 AmazonIVSClient. /// 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 IVS. /// 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 IVS. /// /// /// /// /// /// /// /// /// /// 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 AmazonIVSClient. /// 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 IVS. /// REST API Reference for UntagResource Operation UntagResourceResponse EndUntagResource(IAsyncResult asyncResult); #endregion #region UpdateChannel /// /// Updates a channel's configuration. Live channels cannot be updated. You must stop /// the ongoing stream, update the channel, and restart the stream for the changes to /// take effect. /// /// Container for the necessary parameters to execute the UpdateChannel service method. /// /// The response from the UpdateChannel service method, as returned by IVS. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for UpdateChannel Operation UpdateChannelResponse UpdateChannel(UpdateChannelRequest request); /// /// Initiates the asynchronous execution of the UpdateChannel operation. /// /// /// Container for the necessary parameters to execute the UpdateChannel operation on AmazonIVSClient. /// 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 EndUpdateChannel /// operation. /// REST API Reference for UpdateChannel Operation IAsyncResult BeginUpdateChannel(UpdateChannelRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateChannel operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateChannel. /// /// Returns a UpdateChannelResult from IVS. /// REST API Reference for UpdateChannel Operation UpdateChannelResponse EndUpdateChannel(IAsyncResult asyncResult); #endregion } }