@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.
Allowed Header Values
Accept:
application/json
Accept-Encoding:
gzip, deflate
Content-Type:
application/json
Key Concepts
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.
Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. 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.
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.
Playback restriction policy — Restricts playback by countries and/or origin sites.
For more information about your IVS live stream, also see Getting Started with IVS Low-Latency Streaming.
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
batchGetChannel, batchGetStreamKey, batchStartViewerSessionRevocation, builder, createChannel, createPlaybackRestrictionPolicy, createRecordingConfiguration, createStreamKey, deleteChannel, deletePlaybackKeyPair, deletePlaybackRestrictionPolicy, deleteRecordingConfiguration, deleteStreamKey, getCachedResponseMetadata, getChannel, getPlaybackKeyPair, getPlaybackRestrictionPolicy, getRecordingConfiguration, getStream, getStreamKey, getStreamSession, importPlaybackKeyPair, listChannels, listPlaybackKeyPairs, listPlaybackRestrictionPolicies, listRecordingConfigurations, listStreamKeys, listStreams, listStreamSessions, listTagsForResource, putMetadata, startViewerSessionRevocation, stopStream, tagResource, untagResource, updateChannel, updatePlaybackRestrictionPolicy
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
batchGetChannel, batchGetStreamKey, batchStartViewerSessionRevocation, createChannel, createPlaybackRestrictionPolicy, createRecordingConfiguration, createStreamKey, deleteChannel, deletePlaybackKeyPair, deletePlaybackRestrictionPolicy, deleteRecordingConfiguration, deleteStreamKey, getCachedResponseMetadata, getChannel, getPlaybackKeyPair, getPlaybackRestrictionPolicy, getRecordingConfiguration, getStream, getStreamKey, getStreamSession, importPlaybackKeyPair, listChannels, listPlaybackKeyPairs, listPlaybackRestrictionPolicies, listRecordingConfigurations, listStreamKeys, listStreams, listStreamSessions, listTagsForResource, putMetadata, startViewerSessionRevocation, stopStream, tagResource, untagResource, updateChannel, updatePlaybackRestrictionPolicy
public static AmazonIVSAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<BatchGetChannelResult> batchGetChannelAsync(BatchGetChannelRequest request)
AmazonIVSAsync
Performs GetChannel on multiple ARNs simultaneously.
batchGetChannelAsync
in interface AmazonIVSAsync
public Future<BatchGetChannelResult> batchGetChannelAsync(BatchGetChannelRequest request, AsyncHandler<BatchGetChannelRequest,BatchGetChannelResult> asyncHandler)
AmazonIVSAsync
Performs GetChannel on multiple ARNs simultaneously.
batchGetChannelAsync
in interface AmazonIVSAsync
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.public Future<BatchGetStreamKeyResult> batchGetStreamKeyAsync(BatchGetStreamKeyRequest request)
AmazonIVSAsync
Performs GetStreamKey on multiple ARNs simultaneously.
batchGetStreamKeyAsync
in interface AmazonIVSAsync
public Future<BatchGetStreamKeyResult> batchGetStreamKeyAsync(BatchGetStreamKeyRequest request, AsyncHandler<BatchGetStreamKeyRequest,BatchGetStreamKeyResult> asyncHandler)
AmazonIVSAsync
Performs GetStreamKey on multiple ARNs simultaneously.
batchGetStreamKeyAsync
in interface AmazonIVSAsync
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.public Future<BatchStartViewerSessionRevocationResult> batchStartViewerSessionRevocationAsync(BatchStartViewerSessionRevocationRequest request)
AmazonIVSAsync
Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
batchStartViewerSessionRevocationAsync
in interface AmazonIVSAsync
public Future<BatchStartViewerSessionRevocationResult> batchStartViewerSessionRevocationAsync(BatchStartViewerSessionRevocationRequest request, AsyncHandler<BatchStartViewerSessionRevocationRequest,BatchStartViewerSessionRevocationResult> asyncHandler)
AmazonIVSAsync
Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
batchStartViewerSessionRevocationAsync
in interface AmazonIVSAsync
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.public Future<CreateChannelResult> createChannelAsync(CreateChannelRequest request)
AmazonIVSAsync
Creates a new channel and an associated stream key to start streaming.
createChannelAsync
in interface AmazonIVSAsync
public Future<CreateChannelResult> createChannelAsync(CreateChannelRequest request, AsyncHandler<CreateChannelRequest,CreateChannelResult> asyncHandler)
AmazonIVSAsync
Creates a new channel and an associated stream key to start streaming.
createChannelAsync
in interface AmazonIVSAsync
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.public Future<CreatePlaybackRestrictionPolicyResult> createPlaybackRestrictionPolicyAsync(CreatePlaybackRestrictionPolicyRequest request)
AmazonIVSAsync
Creates a new playback restriction policy, for constraining playback by countries and/or origins.
createPlaybackRestrictionPolicyAsync
in interface AmazonIVSAsync
public Future<CreatePlaybackRestrictionPolicyResult> createPlaybackRestrictionPolicyAsync(CreatePlaybackRestrictionPolicyRequest request, AsyncHandler<CreatePlaybackRestrictionPolicyRequest,CreatePlaybackRestrictionPolicyResult> asyncHandler)
AmazonIVSAsync
Creates a new playback restriction policy, for constraining playback by countries and/or origins.
createPlaybackRestrictionPolicyAsync
in interface AmazonIVSAsync
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.public Future<CreateRecordingConfigurationResult> createRecordingConfigurationAsync(CreateRecordingConfigurationRequest request)
AmazonIVSAsync
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.
createRecordingConfigurationAsync
in interface AmazonIVSAsync
public Future<CreateRecordingConfigurationResult> createRecordingConfigurationAsync(CreateRecordingConfigurationRequest request, AsyncHandler<CreateRecordingConfigurationRequest,CreateRecordingConfigurationResult> asyncHandler)
AmazonIVSAsync
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.
createRecordingConfigurationAsync
in interface AmazonIVSAsync
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.public Future<CreateStreamKeyResult> createStreamKeyAsync(CreateStreamKeyRequest request)
AmazonIVSAsync
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.
createStreamKeyAsync
in interface AmazonIVSAsync
public Future<CreateStreamKeyResult> createStreamKeyAsync(CreateStreamKeyRequest request, AsyncHandler<CreateStreamKeyRequest,CreateStreamKeyResult> asyncHandler)
AmazonIVSAsync
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.
createStreamKeyAsync
in interface AmazonIVSAsync
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.public Future<DeleteChannelResult> deleteChannelAsync(DeleteChannelRequest request)
AmazonIVSAsync
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.)
deleteChannelAsync
in interface AmazonIVSAsync
public Future<DeleteChannelResult> deleteChannelAsync(DeleteChannelRequest request, AsyncHandler<DeleteChannelRequest,DeleteChannelResult> asyncHandler)
AmazonIVSAsync
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.)
deleteChannelAsync
in interface AmazonIVSAsync
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.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 AmazonIVSAsync
public 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 AmazonIVSAsync
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.public Future<DeletePlaybackRestrictionPolicyResult> deletePlaybackRestrictionPolicyAsync(DeletePlaybackRestrictionPolicyRequest request)
AmazonIVSAsync
Deletes the specified playback restriction policy.
deletePlaybackRestrictionPolicyAsync
in interface AmazonIVSAsync
public Future<DeletePlaybackRestrictionPolicyResult> deletePlaybackRestrictionPolicyAsync(DeletePlaybackRestrictionPolicyRequest request, AsyncHandler<DeletePlaybackRestrictionPolicyRequest,DeletePlaybackRestrictionPolicyResult> asyncHandler)
AmazonIVSAsync
Deletes the specified playback restriction policy.
deletePlaybackRestrictionPolicyAsync
in interface AmazonIVSAsync
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.public Future<DeleteRecordingConfigurationResult> deleteRecordingConfigurationAsync(DeleteRecordingConfigurationRequest request)
AmazonIVSAsync
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.
deleteRecordingConfigurationAsync
in interface AmazonIVSAsync
public Future<DeleteRecordingConfigurationResult> deleteRecordingConfigurationAsync(DeleteRecordingConfigurationRequest request, AsyncHandler<DeleteRecordingConfigurationRequest,DeleteRecordingConfigurationResult> asyncHandler)
AmazonIVSAsync
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.
deleteRecordingConfigurationAsync
in interface AmazonIVSAsync
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.public Future<DeleteStreamKeyResult> deleteStreamKeyAsync(DeleteStreamKeyRequest request)
AmazonIVSAsync
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
deleteStreamKeyAsync
in interface AmazonIVSAsync
public Future<DeleteStreamKeyResult> deleteStreamKeyAsync(DeleteStreamKeyRequest request, AsyncHandler<DeleteStreamKeyRequest,DeleteStreamKeyResult> asyncHandler)
AmazonIVSAsync
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
deleteStreamKeyAsync
in interface AmazonIVSAsync
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.public Future<GetChannelResult> getChannelAsync(GetChannelRequest request)
AmazonIVSAsync
Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
getChannelAsync
in interface AmazonIVSAsync
public Future<GetChannelResult> getChannelAsync(GetChannelRequest request, AsyncHandler<GetChannelRequest,GetChannelResult> asyncHandler)
AmazonIVSAsync
Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
getChannelAsync
in interface AmazonIVSAsync
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.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 AmazonIVSAsync
public 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 AmazonIVSAsync
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.public Future<GetPlaybackRestrictionPolicyResult> getPlaybackRestrictionPolicyAsync(GetPlaybackRestrictionPolicyRequest request)
AmazonIVSAsync
Gets the specified playback restriction policy.
getPlaybackRestrictionPolicyAsync
in interface AmazonIVSAsync
public Future<GetPlaybackRestrictionPolicyResult> getPlaybackRestrictionPolicyAsync(GetPlaybackRestrictionPolicyRequest request, AsyncHandler<GetPlaybackRestrictionPolicyRequest,GetPlaybackRestrictionPolicyResult> asyncHandler)
AmazonIVSAsync
Gets the specified playback restriction policy.
getPlaybackRestrictionPolicyAsync
in interface AmazonIVSAsync
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.public Future<GetRecordingConfigurationResult> getRecordingConfigurationAsync(GetRecordingConfigurationRequest request)
AmazonIVSAsync
Gets the recording configuration for the specified ARN.
getRecordingConfigurationAsync
in interface AmazonIVSAsync
public Future<GetRecordingConfigurationResult> getRecordingConfigurationAsync(GetRecordingConfigurationRequest request, AsyncHandler<GetRecordingConfigurationRequest,GetRecordingConfigurationResult> asyncHandler)
AmazonIVSAsync
Gets the recording configuration for the specified ARN.
getRecordingConfigurationAsync
in interface AmazonIVSAsync
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.public Future<GetStreamResult> getStreamAsync(GetStreamRequest request)
AmazonIVSAsync
Gets information about the active (live) stream on a specified channel.
getStreamAsync
in interface AmazonIVSAsync
public Future<GetStreamResult> getStreamAsync(GetStreamRequest request, AsyncHandler<GetStreamRequest,GetStreamResult> asyncHandler)
AmazonIVSAsync
Gets information about the active (live) stream on a specified channel.
getStreamAsync
in interface AmazonIVSAsync
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.public Future<GetStreamKeyResult> getStreamKeyAsync(GetStreamKeyRequest request)
AmazonIVSAsync
Gets stream-key information for a specified ARN.
getStreamKeyAsync
in interface AmazonIVSAsync
public Future<GetStreamKeyResult> getStreamKeyAsync(GetStreamKeyRequest request, AsyncHandler<GetStreamKeyRequest,GetStreamKeyResult> asyncHandler)
AmazonIVSAsync
Gets stream-key information for a specified ARN.
getStreamKeyAsync
in interface AmazonIVSAsync
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.public Future<GetStreamSessionResult> getStreamSessionAsync(GetStreamSessionRequest request)
AmazonIVSAsync
Gets metadata on a specified stream.
getStreamSessionAsync
in interface AmazonIVSAsync
public Future<GetStreamSessionResult> getStreamSessionAsync(GetStreamSessionRequest request, AsyncHandler<GetStreamSessionRequest,GetStreamSessionResult> asyncHandler)
AmazonIVSAsync
Gets metadata on a specified stream.
getStreamSessionAsync
in interface AmazonIVSAsync
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.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 AmazonIVSAsync
public 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 AmazonIVSAsync
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.public Future<ListChannelsResult> listChannelsAsync(ListChannelsRequest request)
AmazonIVSAsync
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).
listChannelsAsync
in interface AmazonIVSAsync
public Future<ListChannelsResult> listChannelsAsync(ListChannelsRequest request, AsyncHandler<ListChannelsRequest,ListChannelsResult> asyncHandler)
AmazonIVSAsync
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).
listChannelsAsync
in interface AmazonIVSAsync
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.public Future<ListPlaybackKeyPairsResult> listPlaybackKeyPairsAsync(ListPlaybackKeyPairsRequest request)
AmazonIVSAsync
Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
listPlaybackKeyPairsAsync
in interface AmazonIVSAsync
public Future<ListPlaybackKeyPairsResult> listPlaybackKeyPairsAsync(ListPlaybackKeyPairsRequest request, AsyncHandler<ListPlaybackKeyPairsRequest,ListPlaybackKeyPairsResult> asyncHandler)
AmazonIVSAsync
Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
listPlaybackKeyPairsAsync
in interface AmazonIVSAsync
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.public Future<ListPlaybackRestrictionPoliciesResult> listPlaybackRestrictionPoliciesAsync(ListPlaybackRestrictionPoliciesRequest request)
AmazonIVSAsync
Gets summary information about playback restriction policies.
listPlaybackRestrictionPoliciesAsync
in interface AmazonIVSAsync
public Future<ListPlaybackRestrictionPoliciesResult> listPlaybackRestrictionPoliciesAsync(ListPlaybackRestrictionPoliciesRequest request, AsyncHandler<ListPlaybackRestrictionPoliciesRequest,ListPlaybackRestrictionPoliciesResult> asyncHandler)
AmazonIVSAsync
Gets summary information about playback restriction policies.
listPlaybackRestrictionPoliciesAsync
in interface AmazonIVSAsync
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.public Future<ListRecordingConfigurationsResult> listRecordingConfigurationsAsync(ListRecordingConfigurationsRequest request)
AmazonIVSAsync
Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
listRecordingConfigurationsAsync
in interface AmazonIVSAsync
public Future<ListRecordingConfigurationsResult> listRecordingConfigurationsAsync(ListRecordingConfigurationsRequest request, AsyncHandler<ListRecordingConfigurationsRequest,ListRecordingConfigurationsResult> asyncHandler)
AmazonIVSAsync
Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
listRecordingConfigurationsAsync
in interface AmazonIVSAsync
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.public Future<ListStreamKeysResult> listStreamKeysAsync(ListStreamKeysRequest request)
AmazonIVSAsync
Gets summary information about stream keys for the specified channel.
listStreamKeysAsync
in interface AmazonIVSAsync
public Future<ListStreamKeysResult> listStreamKeysAsync(ListStreamKeysRequest request, AsyncHandler<ListStreamKeysRequest,ListStreamKeysResult> asyncHandler)
AmazonIVSAsync
Gets summary information about stream keys for the specified channel.
listStreamKeysAsync
in interface AmazonIVSAsync
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.public Future<ListStreamSessionsResult> listStreamSessionsAsync(ListStreamSessionsRequest request)
AmazonIVSAsync
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.
listStreamSessionsAsync
in interface AmazonIVSAsync
public Future<ListStreamSessionsResult> listStreamSessionsAsync(ListStreamSessionsRequest request, AsyncHandler<ListStreamSessionsRequest,ListStreamSessionsResult> asyncHandler)
AmazonIVSAsync
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.
listStreamSessionsAsync
in interface AmazonIVSAsync
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.public Future<ListStreamsResult> listStreamsAsync(ListStreamsRequest request)
AmazonIVSAsync
Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
listStreamsAsync
in interface AmazonIVSAsync
public Future<ListStreamsResult> listStreamsAsync(ListStreamsRequest request, AsyncHandler<ListStreamsRequest,ListStreamsResult> asyncHandler)
AmazonIVSAsync
Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
listStreamsAsync
in interface AmazonIVSAsync
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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonIVSAsync
Gets information about Amazon Web Services tags for the specified ARN.
listTagsForResourceAsync
in interface AmazonIVSAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonIVSAsync
Gets information about Amazon Web Services tags for the specified ARN.
listTagsForResourceAsync
in interface AmazonIVSAsync
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.public Future<PutMetadataResult> putMetadataAsync(PutMetadataRequest request)
AmazonIVSAsync
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.
putMetadataAsync
in interface AmazonIVSAsync
public Future<PutMetadataResult> putMetadataAsync(PutMetadataRequest request, AsyncHandler<PutMetadataRequest,PutMetadataResult> asyncHandler)
AmazonIVSAsync
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.
putMetadataAsync
in interface AmazonIVSAsync
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.public Future<StartViewerSessionRevocationResult> startViewerSessionRevocationAsync(StartViewerSessionRevocationRequest request)
AmazonIVSAsync
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.
startViewerSessionRevocationAsync
in interface AmazonIVSAsync
public Future<StartViewerSessionRevocationResult> startViewerSessionRevocationAsync(StartViewerSessionRevocationRequest request, AsyncHandler<StartViewerSessionRevocationRequest,StartViewerSessionRevocationResult> asyncHandler)
AmazonIVSAsync
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.
startViewerSessionRevocationAsync
in interface AmazonIVSAsync
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.public Future<StopStreamResult> stopStreamAsync(StopStreamRequest request)
AmazonIVSAsync
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.
stopStreamAsync
in interface AmazonIVSAsync
public Future<StopStreamResult> stopStreamAsync(StopStreamRequest request, AsyncHandler<StopStreamRequest,StopStreamResult> asyncHandler)
AmazonIVSAsync
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.
stopStreamAsync
in interface AmazonIVSAsync
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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonIVSAsync
Adds or updates tags for the Amazon Web Services resource with the specified ARN.
tagResourceAsync
in interface AmazonIVSAsync
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonIVSAsync
Adds or updates tags for the Amazon Web Services resource with the specified ARN.
tagResourceAsync
in interface AmazonIVSAsync
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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonIVSAsync
Removes tags from the resource with the specified ARN.
untagResourceAsync
in interface AmazonIVSAsync
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonIVSAsync
Removes tags from the resource with the specified ARN.
untagResourceAsync
in interface AmazonIVSAsync
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.public Future<UpdateChannelResult> updateChannelAsync(UpdateChannelRequest request)
AmazonIVSAsync
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.
updateChannelAsync
in interface AmazonIVSAsync
public Future<UpdateChannelResult> updateChannelAsync(UpdateChannelRequest request, AsyncHandler<UpdateChannelRequest,UpdateChannelResult> asyncHandler)
AmazonIVSAsync
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.
updateChannelAsync
in interface AmazonIVSAsync
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.public Future<UpdatePlaybackRestrictionPolicyResult> updatePlaybackRestrictionPolicyAsync(UpdatePlaybackRestrictionPolicyRequest request)
AmazonIVSAsync
Updates a specified playback restriction policy.
updatePlaybackRestrictionPolicyAsync
in interface AmazonIVSAsync
public Future<UpdatePlaybackRestrictionPolicyResult> updatePlaybackRestrictionPolicyAsync(UpdatePlaybackRestrictionPolicyRequest request, AsyncHandler<UpdatePlaybackRestrictionPolicyRequest,UpdatePlaybackRestrictionPolicyResult> asyncHandler)
AmazonIVSAsync
Updates a specified playback restriction policy.
updatePlaybackRestrictionPolicyAsync
in interface AmazonIVSAsync
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.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AmazonIVS
shutdown
in class AmazonIVSClient