/* * Copyright 2018-2023 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. */ package com.amazonaws.services.ivs; import javax.annotation.Generated; import com.amazonaws.services.ivs.model.*; /** * Interface for accessing Amazon IVS asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.ivs.AbstractAmazonIVSAsync} instead. *

* 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 *

*
* Accept: application/json *
*
*
* Accept-Encoding: gzip, deflate *
*
*
* Content-Type: application/json *
*

* Resources *

* The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS): *

*
* Channel — Stores configuration data related to your live stream. You first create a channel and then use the * channel’s stream key to start your live stream. See the Channel endpoints for more information. *
*
*
* Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize * streaming. See the StreamKey endpoints for more information. Treat the stream key like a secret, since it * allows anyone to stream to the channel. *
*
*
* Playback key pair — Video playback may be restricted using playback-authorization tokens, which use public-key * encryption. A playback key pair is the public-private pair of keys used to sign and validate the * playback-authorization token. See the PlaybackKeyPair endpoints for more information. *
*
*
* Recording configuration — Stores configuration related to recording a live stream and where to store the * recorded content. Multiple channels can reference the same recording configuration. See the Recording Configuration * endpoints for more information. *
*

* 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 is about verifying identity. You need to be authenticated to sign Amazon IVS API requests. *
*
*
* Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS API * requests. In addition, authorization is needed to view Amazon IVS private channels. * (Private channels are channels that are enabled for "playback authorization.") *
*

* 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: *

*
* Authentication and generating signatures — See Authenticating Requests * (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference. *
*
*
* Managing Amazon IVS permissions — See Identity and Access Management on the * Security page of the Amazon IVS User Guide. *
*

* 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 *

*
* CreateChannel — Creates a new channel and an associated stream key to start streaming. *
*
*
* GetChannel — Gets the channel configuration for the specified channel ARN. *
*
*
* BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously. *
*
*
* 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 Conflict Exception). *
*
*
* UpdateChannel — Updates a channel's configuration. This does not affect an ongoing stream of this channel. You * must stop and restart the stream for the changes to take effect. *
*
*
* DeleteChannel — Deletes the specified channel. *
*

* StreamKey Endpoints *

*
* CreateStreamKey — Creates a stream key, used to initiate a stream, for the specified channel ARN. *
*
*
* GetStreamKey — Gets stream key information for the specified ARN. *
*
*
* BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously. *
*
*
* ListStreamKeys — Gets summary information about stream keys for the specified channel. *
*
*
* DeleteStreamKey — Deletes the stream key for the specified ARN, so it can no longer be used to stream. *
*

* Stream Endpoints *

*
* GetStream — Gets information about the active (live) stream on a specified channel. *
*
*
* GetStreamSession — Gets metadata on a specified stream. *
*
*
* ListStreams — Gets summary information about live streams in your account, in the Amazon Web Services region * where the API request is processed. *
*
*
* 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. *
*
*
* StopStream — Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with * DeleteStreamKey to prevent further streaming to a channel. *
*
*
* 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. *
*

* Private Channel Endpoints *

* For more information, see Setting Up * Private Channels in the Amazon IVS User Guide. *

*
* 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 (channels enabled for playback authorization). *
*
*
* 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. *
*
*
* ListPlaybackKeyPairs — Gets summary information about playback key pairs. *
*
*
* DeletePlaybackKeyPair — Deletes a specified authorization key pair. This invalidates future viewer tokens * generated using the key pair’s privateKey. *
*
*
* 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. *
*
*
* BatchStartViewerSessionRevocation — Performs StartViewerSessionRevocation on multiple channel ARN and * viewer ID pairs simultaneously. *
*

* RecordingConfiguration Endpoints *

*
* CreateRecordingConfiguration — Creates a new recording configuration, used to enable recording to Amazon S3. *
*
*
* GetRecordingConfiguration — Gets the recording-configuration metadata for the specified ARN. *
*
*
* ListRecordingConfigurations — Gets summary information about all recording configurations in your account, in * the Amazon Web Services region where the API request is processed. *
*
*
* DeleteRecordingConfiguration — Deletes the recording configuration for the specified ARN. *
*

* Amazon Web Services Tags Endpoints *

*
* TagResource — Adds or updates tags for the Amazon Web Services resource with the specified ARN. *
*
*
* UntagResource — Removes tags from the resource with the specified ARN. *
*
*
* ListTagsForResource — Gets information about Amazon Web Services tags for the specified ARN. *
*

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonIVSAsync extends AmazonIVS { /** *

* Performs GetChannel on multiple ARNs simultaneously. *

* * @param batchGetChannelRequest * @return A Java Future containing the result of the BatchGetChannel operation returned by the service. * @sample AmazonIVSAsync.BatchGetChannel * @see AWS API * Documentation */ java.util.concurrent.Future batchGetChannelAsync(BatchGetChannelRequest batchGetChannelRequest); /** *

* Performs GetChannel on multiple ARNs simultaneously. *

* * @param batchGetChannelRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the BatchGetChannel operation returned by the service. * @sample AmazonIVSAsyncHandler.BatchGetChannel * @see AWS API * Documentation */ java.util.concurrent.Future batchGetChannelAsync(BatchGetChannelRequest batchGetChannelRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Performs GetStreamKey on multiple ARNs simultaneously. *

* * @param batchGetStreamKeyRequest * @return A Java Future containing the result of the BatchGetStreamKey operation returned by the service. * @sample AmazonIVSAsync.BatchGetStreamKey * @see AWS API * Documentation */ java.util.concurrent.Future batchGetStreamKeyAsync(BatchGetStreamKeyRequest batchGetStreamKeyRequest); /** *

* Performs GetStreamKey on multiple ARNs simultaneously. *

* * @param batchGetStreamKeyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the BatchGetStreamKey operation returned by the service. * @sample AmazonIVSAsyncHandler.BatchGetStreamKey * @see AWS API * Documentation */ java.util.concurrent.Future batchGetStreamKeyAsync(BatchGetStreamKeyRequest batchGetStreamKeyRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously. *

* * @param batchStartViewerSessionRevocationRequest * @return A Java Future containing the result of the BatchStartViewerSessionRevocation operation returned by the * service. * @sample AmazonIVSAsync.BatchStartViewerSessionRevocation * @see AWS API Documentation */ java.util.concurrent.Future batchStartViewerSessionRevocationAsync( BatchStartViewerSessionRevocationRequest batchStartViewerSessionRevocationRequest); /** *

* Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously. *

* * @param batchStartViewerSessionRevocationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the BatchStartViewerSessionRevocation operation returned by the * service. * @sample AmazonIVSAsyncHandler.BatchStartViewerSessionRevocation * @see AWS API Documentation */ java.util.concurrent.Future batchStartViewerSessionRevocationAsync( BatchStartViewerSessionRevocationRequest batchStartViewerSessionRevocationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Creates a new channel and an associated stream key to start streaming. *

* * @param createChannelRequest * @return A Java Future containing the result of the CreateChannel operation returned by the service. * @sample AmazonIVSAsync.CreateChannel * @see AWS API * Documentation */ java.util.concurrent.Future createChannelAsync(CreateChannelRequest createChannelRequest); /** *

* Creates a new channel and an associated stream key to start streaming. *

* * @param createChannelRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateChannel operation returned by the service. * @sample AmazonIVSAsyncHandler.CreateChannel * @see AWS API * Documentation */ java.util.concurrent.Future createChannelAsync(CreateChannelRequest createChannelRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param createRecordingConfigurationRequest * @return A Java Future containing the result of the CreateRecordingConfiguration operation returned by the * service. * @sample AmazonIVSAsync.CreateRecordingConfiguration * @see AWS API Documentation */ java.util.concurrent.Future createRecordingConfigurationAsync( CreateRecordingConfigurationRequest createRecordingConfigurationRequest); /** *

* Creates a new recording configuration, used to enable recording to Amazon S3. *

* * @param createRecordingConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateRecordingConfiguration operation returned by the * service. * @sample AmazonIVSAsyncHandler.CreateRecordingConfiguration * @see AWS API Documentation */ java.util.concurrent.Future createRecordingConfigurationAsync( CreateRecordingConfigurationRequest createRecordingConfigurationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param createStreamKeyRequest * @return A Java Future containing the result of the CreateStreamKey operation returned by the service. * @sample AmazonIVSAsync.CreateStreamKey * @see AWS API * Documentation */ java.util.concurrent.Future createStreamKeyAsync(CreateStreamKeyRequest createStreamKeyRequest); /** *

* Creates a stream key, used to initiate a stream, for the specified channel ARN. *

* * @param createStreamKeyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateStreamKey operation returned by the service. * @sample AmazonIVSAsyncHandler.CreateStreamKey * @see AWS API * Documentation */ java.util.concurrent.Future createStreamKeyAsync(CreateStreamKeyRequest createStreamKeyRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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.) *

* * @param deleteChannelRequest * @return A Java Future containing the result of the DeleteChannel operation returned by the service. * @sample AmazonIVSAsync.DeleteChannel * @see AWS API * Documentation */ java.util.concurrent.Future deleteChannelAsync(DeleteChannelRequest deleteChannelRequest); /** *

* Deletes the specified channel and its associated stream keys. *

* * @param deleteChannelRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteChannel operation returned by the service. * @sample AmazonIVSAsyncHandler.DeleteChannel * @see AWS API * Documentation */ java.util.concurrent.Future deleteChannelAsync(DeleteChannelRequest deleteChannelRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param deletePlaybackKeyPairRequest * @return A Java Future containing the result of the DeletePlaybackKeyPair operation returned by the service. * @sample AmazonIVSAsync.DeletePlaybackKeyPair * @see AWS API * Documentation */ java.util.concurrent.Future deletePlaybackKeyPairAsync(DeletePlaybackKeyPairRequest deletePlaybackKeyPairRequest); /** *

* * @param deletePlaybackKeyPairRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeletePlaybackKeyPair operation returned by the service. * @sample AmazonIVSAsyncHandler.DeletePlaybackKeyPair * @see AWS API * Documentation */ java.util.concurrent.Future deletePlaybackKeyPairAsync(DeletePlaybackKeyPairRequest deletePlaybackKeyPairRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param deleteRecordingConfigurationRequest * @return A Java Future containing the result of the DeleteRecordingConfiguration operation returned by the * service. * @sample AmazonIVSAsync.DeleteRecordingConfiguration * @see AWS API Documentation */ java.util.concurrent.Future deleteRecordingConfigurationAsync( DeleteRecordingConfigurationRequest deleteRecordingConfigurationRequest); /** *

* Deletes the recording configuration for the specified ARN. *

* * @param deleteRecordingConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteRecordingConfiguration operation returned by the * service. * @sample AmazonIVSAsyncHandler.DeleteRecordingConfiguration * @see AWS API Documentation */ java.util.concurrent.Future deleteRecordingConfigurationAsync( DeleteRecordingConfigurationRequest deleteRecordingConfigurationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Deletes the stream key for the specified ARN, so it can no longer be used to stream. *

* * @param deleteStreamKeyRequest * @return A Java Future containing the result of the DeleteStreamKey operation returned by the service. * @sample AmazonIVSAsync.DeleteStreamKey * @see AWS API * Documentation */ java.util.concurrent.Future deleteStreamKeyAsync(DeleteStreamKeyRequest deleteStreamKeyRequest); /** *

* Deletes the stream key for the specified ARN, so it can no longer be used to stream. *

* * @param deleteStreamKeyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteStreamKey operation returned by the service. * @sample AmazonIVSAsyncHandler.DeleteStreamKey * @see AWS API * Documentation */ java.util.concurrent.Future deleteStreamKeyAsync(DeleteStreamKeyRequest deleteStreamKeyRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Gets the channel configuration for the specified channel ARN. See also BatchGetChannel. *

* * @param getChannelRequest * @return A Java Future containing the result of the GetChannel operation returned by the service. * @sample AmazonIVSAsync.GetChannel * @see AWS API * Documentation */ java.util.concurrent.Future getChannelAsync(GetChannelRequest getChannelRequest); /** *

* Gets the channel configuration for the specified channel ARN. See also BatchGetChannel. *

* * @param getChannelRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetChannel operation returned by the service. * @sample AmazonIVSAsyncHandler.GetChannel * @see AWS API * Documentation */ java.util.concurrent.Future getChannelAsync(GetChannelRequest getChannelRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param getPlaybackKeyPairRequest * @return A Java Future containing the result of the GetPlaybackKeyPair operation returned by the service. * @sample AmazonIVSAsync.GetPlaybackKeyPair * @see AWS API * Documentation */ java.util.concurrent.Future getPlaybackKeyPairAsync(GetPlaybackKeyPairRequest getPlaybackKeyPairRequest); /** *

* * @param getPlaybackKeyPairRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetPlaybackKeyPair operation returned by the service. * @sample AmazonIVSAsyncHandler.GetPlaybackKeyPair * @see AWS API * Documentation */ java.util.concurrent.Future getPlaybackKeyPairAsync(GetPlaybackKeyPairRequest getPlaybackKeyPairRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Gets the recording configuration for the specified ARN. *

* * @param getRecordingConfigurationRequest * @return A Java Future containing the result of the GetRecordingConfiguration operation returned by the service. * @sample AmazonIVSAsync.GetRecordingConfiguration * @see AWS * API Documentation */ java.util.concurrent.Future getRecordingConfigurationAsync( GetRecordingConfigurationRequest getRecordingConfigurationRequest); /** *

* Gets the recording configuration for the specified ARN. *

* * @param getRecordingConfigurationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetRecordingConfiguration operation returned by the service. * @sample AmazonIVSAsyncHandler.GetRecordingConfiguration * @see AWS * API Documentation */ java.util.concurrent.Future getRecordingConfigurationAsync( GetRecordingConfigurationRequest getRecordingConfigurationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Gets information about the active (live) stream on a specified channel. *

* * @param getStreamRequest * @return A Java Future containing the result of the GetStream operation returned by the service. * @sample AmazonIVSAsync.GetStream * @see AWS API * Documentation */ java.util.concurrent.Future getStreamAsync(GetStreamRequest getStreamRequest); /** *

* Gets information about the active (live) stream on a specified channel. *

* * @param getStreamRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetStream operation returned by the service. * @sample AmazonIVSAsyncHandler.GetStream * @see AWS API * Documentation */ java.util.concurrent.Future getStreamAsync(GetStreamRequest getStreamRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Gets stream-key information for a specified ARN. *

* * @param getStreamKeyRequest * @return A Java Future containing the result of the GetStreamKey operation returned by the service. * @sample AmazonIVSAsync.GetStreamKey * @see AWS API * Documentation */ java.util.concurrent.Future getStreamKeyAsync(GetStreamKeyRequest getStreamKeyRequest); /** *

* Gets stream-key information for a specified ARN. *

* * @param getStreamKeyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetStreamKey operation returned by the service. * @sample AmazonIVSAsyncHandler.GetStreamKey * @see AWS API * Documentation */ java.util.concurrent.Future getStreamKeyAsync(GetStreamKeyRequest getStreamKeyRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Gets metadata on a specified stream. *

* * @param getStreamSessionRequest * @return A Java Future containing the result of the GetStreamSession operation returned by the service. * @sample AmazonIVSAsync.GetStreamSession * @see AWS API * Documentation */ java.util.concurrent.Future getStreamSessionAsync(GetStreamSessionRequest getStreamSessionRequest); /** *

* Gets metadata on a specified stream. *

* * @param getStreamSessionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetStreamSession operation returned by the service. * @sample AmazonIVSAsyncHandler.GetStreamSession * @see AWS API * Documentation */ java.util.concurrent.Future getStreamSessionAsync(GetStreamSessionRequest getStreamSessionRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param importPlaybackKeyPairRequest * @return A Java Future containing the result of the ImportPlaybackKeyPair operation returned by the service. * @sample AmazonIVSAsync.ImportPlaybackKeyPair * @see AWS API * Documentation */ java.util.concurrent.Future importPlaybackKeyPairAsync(ImportPlaybackKeyPairRequest importPlaybackKeyPairRequest); /** *

* * @param importPlaybackKeyPairRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ImportPlaybackKeyPair operation returned by the service. * @sample AmazonIVSAsyncHandler.ImportPlaybackKeyPair * @see AWS API * Documentation */ java.util.concurrent.Future importPlaybackKeyPairAsync(ImportPlaybackKeyPairRequest importPlaybackKeyPairRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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). *

* * @param listChannelsRequest * @return A Java Future containing the result of the ListChannels operation returned by the service. * @sample AmazonIVSAsync.ListChannels * @see AWS API * Documentation */ java.util.concurrent.Future listChannelsAsync(ListChannelsRequest listChannelsRequest); /** *

* * @param listChannelsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListChannels operation returned by the service. * @sample AmazonIVSAsyncHandler.ListChannels * @see AWS API * Documentation */ java.util.concurrent.Future listChannelsAsync(ListChannelsRequest listChannelsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in * the Amazon IVS User Guide. *

* * @param listPlaybackKeyPairsRequest * @return A Java Future containing the result of the ListPlaybackKeyPairs operation returned by the service. * @sample AmazonIVSAsync.ListPlaybackKeyPairs * @see AWS API * Documentation */ java.util.concurrent.Future listPlaybackKeyPairsAsync(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest); /** *

* Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in * the Amazon IVS User Guide. *

* * @param listPlaybackKeyPairsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListPlaybackKeyPairs operation returned by the service. * @sample AmazonIVSAsyncHandler.ListPlaybackKeyPairs * @see AWS API * Documentation */ java.util.concurrent.Future listPlaybackKeyPairsAsync(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Gets summary information about all recording configurations in your account, in the Amazon Web Services region * where the API request is processed. *

* * @param listRecordingConfigurationsRequest * @return A Java Future containing the result of the ListRecordingConfigurations operation returned by the service. * @sample AmazonIVSAsync.ListRecordingConfigurations * @see AWS API Documentation */ java.util.concurrent.Future listRecordingConfigurationsAsync( ListRecordingConfigurationsRequest listRecordingConfigurationsRequest); /** *

* Gets summary information about all recording configurations in your account, in the Amazon Web Services region * where the API request is processed. *

* * @param listRecordingConfigurationsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListRecordingConfigurations operation returned by the service. * @sample AmazonIVSAsyncHandler.ListRecordingConfigurations * @see AWS API Documentation */ java.util.concurrent.Future listRecordingConfigurationsAsync( ListRecordingConfigurationsRequest listRecordingConfigurationsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Gets summary information about stream keys for the specified channel. *

* * @param listStreamKeysRequest * @return A Java Future containing the result of the ListStreamKeys operation returned by the service. * @sample AmazonIVSAsync.ListStreamKeys * @see AWS API * Documentation */ java.util.concurrent.Future listStreamKeysAsync(ListStreamKeysRequest listStreamKeysRequest); /** *

* Gets summary information about stream keys for the specified channel. *

* * @param listStreamKeysRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListStreamKeys operation returned by the service. * @sample AmazonIVSAsyncHandler.ListStreamKeys * @see AWS API * Documentation */ java.util.concurrent.Future listStreamKeysAsync(ListStreamKeysRequest listStreamKeysRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param listStreamSessionsRequest * @return A Java Future containing the result of the ListStreamSessions operation returned by the service. * @sample AmazonIVSAsync.ListStreamSessions * @see AWS API * Documentation */ java.util.concurrent.Future listStreamSessionsAsync(ListStreamSessionsRequest listStreamSessionsRequest); /** *

* 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. *

* * @param listStreamSessionsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListStreamSessions operation returned by the service. * @sample AmazonIVSAsyncHandler.ListStreamSessions * @see AWS API * Documentation */ java.util.concurrent.Future listStreamSessionsAsync(ListStreamSessionsRequest listStreamSessionsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Gets summary information about live streams in your account, in the Amazon Web Services region where the API * request is processed. *

* * @param listStreamsRequest * @return A Java Future containing the result of the ListStreams operation returned by the service. * @sample AmazonIVSAsync.ListStreams * @see AWS API * Documentation */ java.util.concurrent.Future listStreamsAsync(ListStreamsRequest listStreamsRequest); /** *

* Gets summary information about live streams in your account, in the Amazon Web Services region where the API * request is processed. *

* * @param listStreamsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListStreams operation returned by the service. * @sample AmazonIVSAsyncHandler.ListStreams * @see AWS API * Documentation */ java.util.concurrent.Future listStreamsAsync(ListStreamsRequest listStreamsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Gets information about Amazon Web Services tags for the specified ARN. *

* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonIVSAsync.ListTagsForResource * @see AWS API * Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest); /** *

* Gets information about Amazon Web Services tags for the specified ARN. *

* * @param listTagsForResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonIVSAsyncHandler.ListTagsForResource * @see AWS API * Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param putMetadataRequest * @return A Java Future containing the result of the PutMetadata operation returned by the service. * @sample AmazonIVSAsync.PutMetadata * @see AWS API * Documentation */ java.util.concurrent.Future putMetadataAsync(PutMetadataRequest putMetadataRequest); /** *

* * @param putMetadataRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the PutMetadata operation returned by the service. * @sample AmazonIVSAsyncHandler.PutMetadata * @see AWS API * Documentation */ java.util.concurrent.Future putMetadataAsync(PutMetadataRequest putMetadataRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param startViewerSessionRevocationRequest * @return A Java Future containing the result of the StartViewerSessionRevocation operation returned by the * service. * @sample AmazonIVSAsync.StartViewerSessionRevocation * @see AWS API Documentation */ java.util.concurrent.Future startViewerSessionRevocationAsync( StartViewerSessionRevocationRequest startViewerSessionRevocationRequest); /** *

* * @param startViewerSessionRevocationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StartViewerSessionRevocation operation returned by the * service. * @sample AmazonIVSAsyncHandler.StartViewerSessionRevocation * @see AWS API Documentation */ java.util.concurrent.Future startViewerSessionRevocationAsync( StartViewerSessionRevocationRequest startViewerSessionRevocationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * * @param stopStreamRequest * @return A Java Future containing the result of the StopStream operation returned by the service. * @sample AmazonIVSAsync.StopStream * @see AWS API * Documentation */ java.util.concurrent.Future stopStreamAsync(StopStreamRequest stopStreamRequest); /** *

* Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with * DeleteStreamKey to prevent further streaming to a channel. *

* *

* * * @param stopStreamRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StopStream operation returned by the service. * @sample AmazonIVSAsyncHandler.StopStream * @see AWS API * Documentation */ java.util.concurrent.Future stopStreamAsync(StopStreamRequest stopStreamRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Adds or updates tags for the Amazon Web Services resource with the specified ARN. *

* * @param tagResourceRequest * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AmazonIVSAsync.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest); /** *

* Adds or updates tags for the Amazon Web Services resource with the specified ARN. *

* * @param tagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AmazonIVSAsyncHandler.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Removes tags from the resource with the specified ARN. *

* * @param untagResourceRequest * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AmazonIVSAsync.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest); /** *

* Removes tags from the resource with the specified ARN. *

* * @param untagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AmazonIVSAsyncHandler.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param updateChannelRequest * @return A Java Future containing the result of the UpdateChannel operation returned by the service. * @sample AmazonIVSAsync.UpdateChannel * @see AWS API * Documentation */ java.util.concurrent.Future updateChannelAsync(UpdateChannelRequest updateChannelRequest); /** *

* 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. *

* * @param updateChannelRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateChannel operation returned by the service. * @sample AmazonIVSAsyncHandler.UpdateChannel * @see AWS API * Documentation */ java.util.concurrent.Future updateChannelAsync(UpdateChannelRequest updateChannelRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }