@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonIVSAsyncClient extends AmazonIVSClient implements AmazonIVSAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
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.
<p> <b>Allowed Header Values</b> </p> <ul> <li> <p> <code> <b>Accept:</b> </code> application/json</p> </li> <li> <p> <code> <b>Accept-Encoding:</b> </code> gzip, deflate</p> </li> <li> <p> <code> <b>Content-Type:</b> </code>application/json</p> </li> </ul> <p> <b>Resources</b> </p> <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html"> Getting Started with Amazon IVS</a>):</p> <ul> <li> <p>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. </p> </li> <li> <p>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. <i> <b>Treat the stream key like a secret, since it allows anyone to stream to the channel.</b> </i> </p> </li> <li> <p>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.</p> </li> <li> <p>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.</p> </li> </ul> <p> <b>Tagging</b> </p> <p>A <i>tag</i> is a metadata label that you assign to an Amazon Web Services resource. A tag comprises a <i>key</i> and a <i>value</i>, both set by you. For example, you might set a tag as <code>topic:nature</code> to label a particular video category. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions that apply to tags.</p> <p>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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html"> Access Tags</a>). </p> <p>The Amazon IVS API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a>. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations.</p> <p>At most 50 tags can be applied to a resource. </p> <p> <b>Authentication versus Authorization</b> </p> <p>Note the differences between these concepts:</p> <ul> <li> <p> <i>Authentication</i> is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.</p> </li> <li> <p> <i>Authorization</i> is about granting permissions. You need to be authorized to view <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Amazon IVS private channels</a>. (Private channels are channels that are enabled for "playback authorization.")</p> </li> </ul> <p> <b>Authentication</b> </p> <p>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.</p> <p>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 an IAM user account that has the <code>ivs:PutMetadata</code> permission.</p> <p>For more information:</p> <ul> <li> <p>Authentication and generating signatures — See <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">Authenticating Requests (Amazon Web Services Signature Version 4)</a> in the <i>Amazon Web Services General Reference</i>.</p> </li> <li> <p>Managing Amazon IVS permissions — See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html">Identity and Access Management</a> on the Security page of the <i>Amazon IVS User Guide</i>.</p> </li> </ul> <p> <b>Channel Endpoints</b> </p> <ul> <li> <p> <a>CreateChannel</a> — Creates a new channel and an associated stream key to start streaming.</p> </li> <li> <p> <a>GetChannel</a> — Gets the channel configuration for the specified channel ARN (Amazon Resource Name).</p> </li> <li> <p> <a>BatchGetChannel</a> — Performs <a>GetChannel</a> on multiple ARNs simultaneously.</p> </li> <li> <p> <a>ListChannels</a> — 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).</p> </li> <li> <p> <a>UpdateChannel</a> — 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.</p> </li> <li> <p> <a>DeleteChannel</a> — Deletes the specified channel.</p> </li> </ul> <p> <b>StreamKey Endpoints</b> </p> <ul> <li> <p> <a>CreateStreamKey</a> — Creates a stream key, used to initiate a stream, for the specified channel ARN.</p> </li> <li> <p> <a>GetStreamKey</a> — Gets stream key information for the specified ARN.</p> </li> <li> <p> <a>BatchGetStreamKey</a> — Performs <a>GetStreamKey</a> on multiple ARNs simultaneously.</p> </li> <li> <p> <a>ListStreamKeys</a> — Gets summary information about stream keys for the specified channel.</p> </li> <li> <p> <a>DeleteStreamKey</a> — Deletes the stream key for the specified ARN, so it can no longer be used to stream.</p> </li> </ul> <p> <b>Stream Endpoints</b> </p> <ul> <li> <p> <a>GetStream</a> — Gets information about the active (live) stream on a specified channel.</p> </li> <li> <p> <a>ListStreams</a> — Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.</p> </li> <li> <p> <a>StopStream</a> — Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with <a>DeleteStreamKey</a> to prevent further streaming to a channel.</p> </li> <li> <p> <a>PutMetadata</a> — 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.</p> </li> </ul> <p> <b>PlaybackKeyPair Endpoints</b> </p> <p>For more information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private Channels</a> in the <i>Amazon IVS User Guide</i>.</p> <ul> <li> <p> <a>ImportPlaybackKeyPair</a> — Imports the public portion of a new key pair and returns its <code>arn</code> and <code>fingerprint</code>. The <code>privateKey</code> can then be used to generate viewer authorization tokens, to grant viewers access to private channels (channels enabled for playback authorization).</p> </li> <li> <p> <a>GetPlaybackKeyPair</a> — Gets a specified playback authorization key pair and returns the <code>arn</code> and <code>fingerprint</code>. The <code>privateKey</code> held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels.</p> </li> <li> <p> <a>ListPlaybackKeyPairs</a> — Gets summary information about playback key pairs.</p> </li> <li> <p> <a>DeletePlaybackKeyPair</a> — Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s <code>privateKey</code>.</p> </li> </ul> <p> <b>RecordingConfiguration Endpoints</b> </p> <ul> <li> <p> <a>CreateRecordingConfiguration</a> — Creates a new recording configuration, used to enable recording to Amazon S3.</p> </li> <li> <p> <a>GetRecordingConfiguration</a> — Gets the recording-configuration metadata for the specified ARN.</p> </li> <li> <p> <a>ListRecordingConfigurations</a> — Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.</p> </li> <li> <p> <a>DeleteRecordingConfiguration</a> — Deletes the recording configuration for the specified ARN.</p> </li> </ul> <p> <b>Amazon Web Services Tags Endpoints</b> </p> <ul> <li> <p> <a>TagResource</a> — Adds or updates tags for the Amazon Web Services resource with the specified ARN.</p> </li> <li> <p> <a>UntagResource</a> — Removes tags from the resource with the specified ARN.</p> </li> <li> <p> <a>ListTagsForResource</a> — Gets information about Amazon Web Services tags for the specified ARN.</p> </li> </ul>
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbatchGetChannel, batchGetStreamKey, builder, createChannel, createRecordingConfiguration, createStreamKey, deleteChannel, deletePlaybackKeyPair, deleteRecordingConfiguration, deleteStreamKey, getCachedResponseMetadata, getChannel, getPlaybackKeyPair, getRecordingConfiguration, getStream, getStreamKey, importPlaybackKeyPair, listChannels, listPlaybackKeyPairs, listRecordingConfigurations, listStreamKeys, listStreams, listTagsForResource, putMetadata, stopStream, tagResource, untagResource, updateChanneladdRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitbatchGetChannel, batchGetStreamKey, createChannel, createRecordingConfiguration, createStreamKey, deleteChannel, deletePlaybackKeyPair, deleteRecordingConfiguration, deleteStreamKey, getCachedResponseMetadata, getChannel, getPlaybackKeyPair, getRecordingConfiguration, getStream, getStreamKey, importPlaybackKeyPair, listChannels, listPlaybackKeyPairs, listRecordingConfigurations, listStreamKeys, listStreams, listTagsForResource, putMetadata, stopStream, tagResource, untagResource, updateChannelpublic static AmazonIVSAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<BatchGetChannelResult> batchGetChannelAsync(BatchGetChannelRequest request)
AmazonIVSAsyncPerforms GetChannel on multiple ARNs simultaneously.
batchGetChannelAsync in interface AmazonIVSAsyncpublic Future<BatchGetChannelResult> batchGetChannelAsync(BatchGetChannelRequest request, AsyncHandler<BatchGetChannelRequest,BatchGetChannelResult> asyncHandler)
AmazonIVSAsyncPerforms GetChannel on multiple ARNs simultaneously.
batchGetChannelAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<BatchGetStreamKeyResult> batchGetStreamKeyAsync(BatchGetStreamKeyRequest request)
AmazonIVSAsyncPerforms GetStreamKey on multiple ARNs simultaneously.
batchGetStreamKeyAsync in interface AmazonIVSAsyncpublic Future<BatchGetStreamKeyResult> batchGetStreamKeyAsync(BatchGetStreamKeyRequest request, AsyncHandler<BatchGetStreamKeyRequest,BatchGetStreamKeyResult> asyncHandler)
AmazonIVSAsyncPerforms GetStreamKey on multiple ARNs simultaneously.
batchGetStreamKeyAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<CreateChannelResult> createChannelAsync(CreateChannelRequest request)
AmazonIVSAsyncCreates a new channel and an associated stream key to start streaming.
createChannelAsync in interface AmazonIVSAsyncpublic Future<CreateChannelResult> createChannelAsync(CreateChannelRequest request, AsyncHandler<CreateChannelRequest,CreateChannelResult> asyncHandler)
AmazonIVSAsyncCreates a new channel and an associated stream key to start streaming.
createChannelAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<CreateRecordingConfigurationResult> createRecordingConfigurationAsync(CreateRecordingConfigurationRequest request)
AmazonIVSAsyncCreates 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.
createRecordingConfigurationAsync in interface AmazonIVSAsyncpublic Future<CreateRecordingConfigurationResult> createRecordingConfigurationAsync(CreateRecordingConfigurationRequest request, AsyncHandler<CreateRecordingConfigurationRequest,CreateRecordingConfigurationResult> asyncHandler)
AmazonIVSAsyncCreates 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.
createRecordingConfigurationAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<CreateStreamKeyResult> createStreamKeyAsync(CreateStreamKeyRequest request)
AmazonIVSAsyncCreates 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.
createStreamKeyAsync in interface AmazonIVSAsyncpublic Future<CreateStreamKeyResult> createStreamKeyAsync(CreateStreamKeyRequest request, AsyncHandler<CreateStreamKeyRequest,CreateStreamKeyResult> asyncHandler)
AmazonIVSAsyncCreates 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.
createStreamKeyAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<DeleteChannelResult> deleteChannelAsync(DeleteChannelRequest request)
AmazonIVSAsyncDeletes 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 was changed from Live to Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)
deleteChannelAsync in interface AmazonIVSAsyncpublic Future<DeleteChannelResult> deleteChannelAsync(DeleteChannelRequest request, AsyncHandler<DeleteChannelRequest,DeleteChannelResult> asyncHandler)
AmazonIVSAsyncDeletes 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 was changed from Live to Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)
deleteChannelAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<DeletePlaybackKeyPairResult> deletePlaybackKeyPairAsync(DeletePlaybackKeyPairRequest request)
AmazonIVSAsync
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.
deletePlaybackKeyPairAsync in interface AmazonIVSAsyncpublic Future<DeletePlaybackKeyPairResult> deletePlaybackKeyPairAsync(DeletePlaybackKeyPairRequest request, AsyncHandler<DeletePlaybackKeyPairRequest,DeletePlaybackKeyPairResult> asyncHandler)
AmazonIVSAsync
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.
deletePlaybackKeyPairAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<DeleteRecordingConfigurationResult> deleteRecordingConfigurationAsync(DeleteRecordingConfigurationRequest request)
AmazonIVSAsyncDeletes 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.
deleteRecordingConfigurationAsync in interface AmazonIVSAsyncpublic Future<DeleteRecordingConfigurationResult> deleteRecordingConfigurationAsync(DeleteRecordingConfigurationRequest request, AsyncHandler<DeleteRecordingConfigurationRequest,DeleteRecordingConfigurationResult> asyncHandler)
AmazonIVSAsyncDeletes 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.
deleteRecordingConfigurationAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<DeleteStreamKeyResult> deleteStreamKeyAsync(DeleteStreamKeyRequest request)
AmazonIVSAsyncDeletes the stream key for the specified ARN, so it can no longer be used to stream.
deleteStreamKeyAsync in interface AmazonIVSAsyncpublic Future<DeleteStreamKeyResult> deleteStreamKeyAsync(DeleteStreamKeyRequest request, AsyncHandler<DeleteStreamKeyRequest,DeleteStreamKeyResult> asyncHandler)
AmazonIVSAsyncDeletes the stream key for the specified ARN, so it can no longer be used to stream.
deleteStreamKeyAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<GetChannelResult> getChannelAsync(GetChannelRequest request)
AmazonIVSAsyncGets the channel configuration for the specified channel ARN. See also BatchGetChannel.
getChannelAsync in interface AmazonIVSAsyncpublic Future<GetChannelResult> getChannelAsync(GetChannelRequest request, AsyncHandler<GetChannelRequest,GetChannelResult> asyncHandler)
AmazonIVSAsyncGets the channel configuration for the specified channel ARN. See also BatchGetChannel.
getChannelAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<GetPlaybackKeyPairResult> getPlaybackKeyPairAsync(GetPlaybackKeyPairRequest request)
AmazonIVSAsync
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.
getPlaybackKeyPairAsync in interface AmazonIVSAsyncpublic Future<GetPlaybackKeyPairResult> getPlaybackKeyPairAsync(GetPlaybackKeyPairRequest request, AsyncHandler<GetPlaybackKeyPairRequest,GetPlaybackKeyPairResult> asyncHandler)
AmazonIVSAsync
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.
getPlaybackKeyPairAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<GetRecordingConfigurationResult> getRecordingConfigurationAsync(GetRecordingConfigurationRequest request)
AmazonIVSAsyncGets the recording configuration for the specified ARN.
getRecordingConfigurationAsync in interface AmazonIVSAsyncpublic Future<GetRecordingConfigurationResult> getRecordingConfigurationAsync(GetRecordingConfigurationRequest request, AsyncHandler<GetRecordingConfigurationRequest,GetRecordingConfigurationResult> asyncHandler)
AmazonIVSAsyncGets the recording configuration for the specified ARN.
getRecordingConfigurationAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<GetStreamResult> getStreamAsync(GetStreamRequest request)
AmazonIVSAsyncGets information about the active (live) stream on a specified channel.
getStreamAsync in interface AmazonIVSAsyncpublic Future<GetStreamResult> getStreamAsync(GetStreamRequest request, AsyncHandler<GetStreamRequest,GetStreamResult> asyncHandler)
AmazonIVSAsyncGets information about the active (live) stream on a specified channel.
getStreamAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<GetStreamKeyResult> getStreamKeyAsync(GetStreamKeyRequest request)
AmazonIVSAsyncGets stream-key information for a specified ARN.
getStreamKeyAsync in interface AmazonIVSAsyncpublic Future<GetStreamKeyResult> getStreamKeyAsync(GetStreamKeyRequest request, AsyncHandler<GetStreamKeyRequest,GetStreamKeyResult> asyncHandler)
AmazonIVSAsyncGets stream-key information for a specified ARN.
getStreamKeyAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<ImportPlaybackKeyPairResult> importPlaybackKeyPairAsync(ImportPlaybackKeyPairRequest request)
AmazonIVSAsync
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.
importPlaybackKeyPairAsync in interface AmazonIVSAsyncpublic Future<ImportPlaybackKeyPairResult> importPlaybackKeyPairAsync(ImportPlaybackKeyPairRequest request, AsyncHandler<ImportPlaybackKeyPairRequest,ImportPlaybackKeyPairResult> asyncHandler)
AmazonIVSAsync
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.
importPlaybackKeyPairAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<ListChannelsResult> listChannelsAsync(ListChannelsRequest request)
AmazonIVSAsyncGets 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).
listChannelsAsync in interface AmazonIVSAsyncpublic Future<ListChannelsResult> listChannelsAsync(ListChannelsRequest request, AsyncHandler<ListChannelsRequest,ListChannelsResult> asyncHandler)
AmazonIVSAsyncGets 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).
listChannelsAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<ListPlaybackKeyPairsResult> listPlaybackKeyPairsAsync(ListPlaybackKeyPairsRequest request)
AmazonIVSAsyncGets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
listPlaybackKeyPairsAsync in interface AmazonIVSAsyncpublic Future<ListPlaybackKeyPairsResult> listPlaybackKeyPairsAsync(ListPlaybackKeyPairsRequest request, AsyncHandler<ListPlaybackKeyPairsRequest,ListPlaybackKeyPairsResult> asyncHandler)
AmazonIVSAsyncGets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
listPlaybackKeyPairsAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<ListRecordingConfigurationsResult> listRecordingConfigurationsAsync(ListRecordingConfigurationsRequest request)
AmazonIVSAsyncGets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
listRecordingConfigurationsAsync in interface AmazonIVSAsyncpublic Future<ListRecordingConfigurationsResult> listRecordingConfigurationsAsync(ListRecordingConfigurationsRequest request, AsyncHandler<ListRecordingConfigurationsRequest,ListRecordingConfigurationsResult> asyncHandler)
AmazonIVSAsyncGets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
listRecordingConfigurationsAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<ListStreamKeysResult> listStreamKeysAsync(ListStreamKeysRequest request)
AmazonIVSAsyncGets summary information about stream keys for the specified channel.
listStreamKeysAsync in interface AmazonIVSAsyncpublic Future<ListStreamKeysResult> listStreamKeysAsync(ListStreamKeysRequest request, AsyncHandler<ListStreamKeysRequest,ListStreamKeysResult> asyncHandler)
AmazonIVSAsyncGets summary information about stream keys for the specified channel.
listStreamKeysAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<ListStreamsResult> listStreamsAsync(ListStreamsRequest request)
AmazonIVSAsyncGets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
listStreamsAsync in interface AmazonIVSAsyncpublic Future<ListStreamsResult> listStreamsAsync(ListStreamsRequest request, AsyncHandler<ListStreamsRequest,ListStreamsResult> asyncHandler)
AmazonIVSAsyncGets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
listStreamsAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonIVSAsyncGets information about Amazon Web Services tags for the specified ARN.
listTagsForResourceAsync in interface AmazonIVSAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonIVSAsyncGets information about Amazon Web Services tags for the specified ARN.
listTagsForResourceAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<PutMetadataResult> putMetadataAsync(PutMetadataRequest request)
AmazonIVSAsyncInserts 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.
putMetadataAsync in interface AmazonIVSAsyncpublic Future<PutMetadataResult> putMetadataAsync(PutMetadataRequest request, AsyncHandler<PutMetadataRequest,PutMetadataResult> asyncHandler)
AmazonIVSAsyncInserts 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.
putMetadataAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<StopStreamResult> stopStreamAsync(StopStreamRequest request)
AmazonIVSAsyncDisconnects 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.
stopStreamAsync in interface AmazonIVSAsyncpublic Future<StopStreamResult> stopStreamAsync(StopStreamRequest request, AsyncHandler<StopStreamRequest,StopStreamResult> asyncHandler)
AmazonIVSAsyncDisconnects 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.
stopStreamAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonIVSAsyncAdds or updates tags for the Amazon Web Services resource with the specified ARN.
tagResourceAsync in interface AmazonIVSAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonIVSAsyncAdds or updates tags for the Amazon Web Services resource with the specified ARN.
tagResourceAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonIVSAsyncRemoves tags from the resource with the specified ARN.
untagResourceAsync in interface AmazonIVSAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonIVSAsyncRemoves tags from the resource with the specified ARN.
untagResourceAsync in interface AmazonIVSAsyncasyncHandler - 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.public Future<UpdateChannelResult> updateChannelAsync(UpdateChannelRequest request)
AmazonIVSAsyncUpdates 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.
updateChannelAsync in interface AmazonIVSAsyncpublic Future<UpdateChannelResult> updateChannelAsync(UpdateChannelRequest request, AsyncHandler<UpdateChannelRequest,UpdateChannelResult> asyncHandler)
AmazonIVSAsyncUpdates 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.
updateChannelAsync in interface AmazonIVSAsyncasyncHandler - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonIVSshutdown in class AmazonIVSClient