AmazonIVSAsyncClient (AWS Java SDK for Amazon Interactive Video 1.11.842 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.ivs.AmazonIVSClient
  - - com.amazonaws.services.ivs.AmazonIVSAsyncClient

All Implemented Interfaces:

AmazonIVS, AmazonIVSAsync
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonIVSAsyncClient
extends AmazonIVSClient
implements AmazonIVSAsync
```
Client for accessing Amazon IVS asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an 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 AWS SNS event stream for responses. JSON is used for both requests and responses, including errors.

The API is an AWS regional service, currently in these regions: us-west-2, us-east-1, and eu-west-1.

All API request parameters and URLs are case sensitive.

For a summary of notable documentation changes in each release, see Document History.

Service Endpoints

The following are the Amazon IVS service endpoints (all HTTPS):

Region name: US West (Oregon)
- Region: us-west-2
- Endpoint: ivs.us-west-2.amazonaws.com
Region name: US East (Virginia)
- Region: us-east-1
- Endpoint: ivs.us-east-1.amazonaws.com
Region name: EU West (Dublin)
- Region: eu-west-1
- Endpoint: ivs.eu-west-1.amazonaws.com
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.
Tagging

A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags.

Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).

The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resources support tagging: Channels and Stream Keys.

API Endpoints

Channel:
- CreateChannel — Creates a new channel and an associated stream key to start streaming.
- GetChannel — Gets the channel configuration for the specified channel ARN (Amazon Resource Name).
- BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously.
- ListChannels — Gets summary information about all channels in your account, in the AWS region where the API request is processed. This list can be filtered to match a specified string.
- 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:
- 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:
- GetStream — Gets information about the active (live) stream on a specified channel.
- ListStreams — Gets summary information about live streams 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 an RTMPS stream for the specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1KB payload.
AWS Tags:
- TagResource — Adds or updates tags for the AWS resource with the specified ARN.
- UntagResource — Removes tags from the resource with the specified ARN.
- ListTagsForResource — Gets information about AWS tags for the specified ARN.

Field Summary
- Fields inherited from class com.amazonaws.services.ivs.AmazonIVSClient
  configFactory
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.ivs.AmazonIVS
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AmazonIVSAsyncClientBuilder`	`asyncBuilder()`
`Future<BatchGetChannelResult>`	`batchGetChannelAsync(BatchGetChannelRequest request)` Performs GetChannel on multiple ARNs simultaneously.
`Future<BatchGetChannelResult>`	`batchGetChannelAsync(BatchGetChannelRequest request, AsyncHandler<BatchGetChannelRequest,BatchGetChannelResult> asyncHandler)` Performs GetChannel on multiple ARNs simultaneously.
`Future<BatchGetStreamKeyResult>`	`batchGetStreamKeyAsync(BatchGetStreamKeyRequest request)` Performs GetStreamKey on multiple ARNs simultaneously.
`Future<BatchGetStreamKeyResult>`	`batchGetStreamKeyAsync(BatchGetStreamKeyRequest request, AsyncHandler<BatchGetStreamKeyRequest,BatchGetStreamKeyResult> asyncHandler)` Performs GetStreamKey on multiple ARNs simultaneously.
`Future<CreateChannelResult>`	`createChannelAsync(CreateChannelRequest request)` Creates a new channel and an associated stream key to start streaming.
`Future<CreateChannelResult>`	`createChannelAsync(CreateChannelRequest request, AsyncHandler<CreateChannelRequest,CreateChannelResult> asyncHandler)` Creates a new channel and an associated stream key to start streaming.
`Future<CreateStreamKeyResult>`	`createStreamKeyAsync(CreateStreamKeyRequest request)` Creates a stream key, used to initiate a stream, for the specified channel ARN.
`Future<CreateStreamKeyResult>`	`createStreamKeyAsync(CreateStreamKeyRequest request, AsyncHandler<CreateStreamKeyRequest,CreateStreamKeyResult> asyncHandler)` Creates a stream key, used to initiate a stream, for the specified channel ARN.
`Future<DeleteChannelResult>`	`deleteChannelAsync(DeleteChannelRequest request)` Deletes the specified channel and its associated stream keys.
`Future<DeleteChannelResult>`	`deleteChannelAsync(DeleteChannelRequest request, AsyncHandler<DeleteChannelRequest,DeleteChannelResult> asyncHandler)` Deletes the specified channel and its associated stream keys.
`Future<DeleteStreamKeyResult>`	`deleteStreamKeyAsync(DeleteStreamKeyRequest request)` Deletes the stream key for the specified ARN, so it can no longer be used to stream.
`Future<DeleteStreamKeyResult>`	`deleteStreamKeyAsync(DeleteStreamKeyRequest request, AsyncHandler<DeleteStreamKeyRequest,DeleteStreamKeyResult> asyncHandler)` Deletes the stream key for the specified ARN, so it can no longer be used to stream.
`Future<GetChannelResult>`	`getChannelAsync(GetChannelRequest request)` Gets the channel configuration for the specified channel ARN.
`Future<GetChannelResult>`	`getChannelAsync(GetChannelRequest request, AsyncHandler<GetChannelRequest,GetChannelResult> asyncHandler)` Gets the channel configuration for the specified channel ARN.
`ExecutorService`	`getExecutorService()` Returns the executor service used by this client to execute async requests.
`Future<GetStreamResult>`	`getStreamAsync(GetStreamRequest request)` Gets information about the active (live) stream on a specified channel.
`Future<GetStreamResult>`	`getStreamAsync(GetStreamRequest request, AsyncHandler<GetStreamRequest,GetStreamResult> asyncHandler)` Gets information about the active (live) stream on a specified channel.
`Future<GetStreamKeyResult>`	`getStreamKeyAsync(GetStreamKeyRequest request)` Gets stream-key information for a specified ARN.
`Future<GetStreamKeyResult>`	`getStreamKeyAsync(GetStreamKeyRequest request, AsyncHandler<GetStreamKeyRequest,GetStreamKeyResult> asyncHandler)` Gets stream-key information for a specified ARN.
`Future<ListChannelsResult>`	`listChannelsAsync(ListChannelsRequest request)` Gets summary information about all channels in your account, in the AWS region where the API request is processed.
`Future<ListChannelsResult>`	`listChannelsAsync(ListChannelsRequest request, AsyncHandler<ListChannelsRequest,ListChannelsResult> asyncHandler)` Gets summary information about all channels in your account, in the AWS region where the API request is processed.
`Future<ListStreamKeysResult>`	`listStreamKeysAsync(ListStreamKeysRequest request)` Gets summary information about stream keys for the specified channel.
`Future<ListStreamKeysResult>`	`listStreamKeysAsync(ListStreamKeysRequest request, AsyncHandler<ListStreamKeysRequest,ListStreamKeysResult> asyncHandler)` Gets summary information about stream keys for the specified channel.
`Future<ListStreamsResult>`	`listStreamsAsync(ListStreamsRequest request)` Gets summary information about live streams in your account, in the AWS region where the API request is processed.
`Future<ListStreamsResult>`	`listStreamsAsync(ListStreamsRequest request, AsyncHandler<ListStreamsRequest,ListStreamsResult> asyncHandler)` Gets summary information about live streams in your account, in the AWS region where the API request is processed.
`Future<ListTagsForResourceResult>`	`listTagsForResourceAsync(ListTagsForResourceRequest request)` Gets information about AWS tags for the specified ARN.
`Future<ListTagsForResourceResult>`	`listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)` Gets information about AWS tags for the specified ARN.
`Future<PutMetadataResult>`	`putMetadataAsync(PutMetadataRequest request)` Inserts metadata into an RTMPS stream for the specified channel.
`Future<PutMetadataResult>`	`putMetadataAsync(PutMetadataRequest request, AsyncHandler<PutMetadataRequest,PutMetadataResult> asyncHandler)` Inserts metadata into an RTMPS stream for the specified channel.
`void`	`shutdown()` Shuts down the client, releasing all managed resources.
`Future<StopStreamResult>`	`stopStreamAsync(StopStreamRequest request)` Disconnects the incoming RTMPS stream for the specified channel.
`Future<StopStreamResult>`	`stopStreamAsync(StopStreamRequest request, AsyncHandler<StopStreamRequest,StopStreamResult> asyncHandler)` Disconnects the incoming RTMPS stream for the specified channel.
`Future<TagResourceResult>`	`tagResourceAsync(TagResourceRequest request)` Adds or updates tags for the AWS resource with the specified ARN.
`Future<TagResourceResult>`	`tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)` Adds or updates tags for the AWS resource with the specified ARN.
`Future<UntagResourceResult>`	`untagResourceAsync(UntagResourceRequest request)` Removes tags from the resource with the specified ARN.
`Future<UntagResourceResult>`	`untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)` Removes tags from the resource with the specified ARN.
`Future<UpdateChannelResult>`	`updateChannelAsync(UpdateChannelRequest request)` Updates a channel's configuration.
`Future<UpdateChannelResult>`	`updateChannelAsync(UpdateChannelRequest request, AsyncHandler<UpdateChannelRequest,UpdateChannelResult> asyncHandler)` Updates a channel's configuration.

Methods inherited from class com.amazonaws.services.ivs.AmazonIVSClient
batchGetChannel, batchGetStreamKey, builder, createChannel, createStreamKey, deleteChannel, deleteStreamKey, getCachedResponseMetadata, getChannel, getStream, getStreamKey, listChannels, listStreamKeys, listStreams, listTagsForResource, putMetadata, stopStream, tagResource, untagResource, updateChannel

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.ivs.AmazonIVS
batchGetChannel, batchGetStreamKey, createChannel, createStreamKey, deleteChannel, deleteStreamKey, getCachedResponseMetadata, getChannel, getStream, getStreamKey, listChannels, listStreamKeys, listStreams, listTagsForResource, putMetadata, stopStream, tagResource, untagResource, updateChannel

- Method Detail
  - asyncBuilder
```
public static AmazonIVSAsyncClientBuilder asyncBuilder()
```
  - getExecutorService
```
public ExecutorService getExecutorService()
```
    Returns the executor service used by this client to execute async requests.
    
    Returns:
    
    The executor service used by this client to execute async requests.
  - batchGetChannelAsync
```
public Future<BatchGetChannelResult> batchGetChannelAsync(BatchGetChannelRequest request)
```
    Description copied from interface: AmazonIVSAsync
    
    Performs GetChannel on multiple ARNs simultaneously.
    
    Specified by:
    
    batchGetChannelAsync in interface AmazonIVSAsync
    
    Returns:
    
    A Java Future containing the result of the BatchGetChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetChannelAsync
```
public Future<BatchGetChannelResult> batchGetChannelAsync(BatchGetChannelRequest request,
                                                          AsyncHandler<BatchGetChannelRequest,BatchGetChannelResult> asyncHandler)
```
    Description copied from interface: AmazonIVSAsync
    
    Performs GetChannel on multiple ARNs simultaneously.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the BatchGetChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetStreamKeyAsync
```
public Future<BatchGetStreamKeyResult> batchGetStreamKeyAsync(BatchGetStreamKeyRequest request)
```
    Description copied from interface: AmazonIVSAsync
    
    Performs GetStreamKey on multiple ARNs simultaneously.
    
    Specified by:
    
    batchGetStreamKeyAsync in interface AmazonIVSAsync
    
    Returns:
    
    A Java Future containing the result of the BatchGetStreamKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetStreamKeyAsync
```
public Future<BatchGetStreamKeyResult> batchGetStreamKeyAsync(BatchGetStreamKeyRequest request,
                                                              AsyncHandler<BatchGetStreamKeyRequest,BatchGetStreamKeyResult> asyncHandler)
```
    Description copied from interface: AmazonIVSAsync
    
    Performs GetStreamKey on multiple ARNs simultaneously.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the BatchGetStreamKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createChannelAsync
```
public Future<CreateChannelResult> createChannelAsync(CreateChannelRequest request)
```
    Description copied from interface: AmazonIVSAsync
    
    Creates a new channel and an associated stream key to start streaming.
    
    Specified by:
    
    createChannelAsync in interface AmazonIVSAsync
    
    Returns:
    
    A Java Future containing the result of the CreateChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createChannelAsync
```
public Future<CreateChannelResult> createChannelAsync(CreateChannelRequest request,
                                                      AsyncHandler<CreateChannelRequest,CreateChannelResult> asyncHandler)
```
    Description copied from interface: AmazonIVSAsync
    
    Creates a new channel and an associated stream key to start streaming.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the CreateChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createStreamKeyAsync
```
public Future<CreateStreamKeyResult> createStreamKeyAsync(CreateStreamKeyRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    createStreamKeyAsync in interface AmazonIVSAsync
    
    Returns:
    
    A Java Future containing the result of the CreateStreamKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createStreamKeyAsync
```
public Future<CreateStreamKeyResult> createStreamKeyAsync(CreateStreamKeyRequest request,
                                                          AsyncHandler<CreateStreamKeyRequest,CreateStreamKeyResult> asyncHandler)
```
    Description copied from interface: 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.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the CreateStreamKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteChannelAsync
```
public Future<DeleteChannelResult> deleteChannelAsync(DeleteChannelRequest request)
```
    Description copied from interface: AmazonIVSAsync
    
    Deletes the specified channel and its associated stream keys.
    
    Specified by:
    
    deleteChannelAsync in interface AmazonIVSAsync
    
    Returns:
    
    A Java Future containing the result of the DeleteChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteChannelAsync
```
public Future<DeleteChannelResult> deleteChannelAsync(DeleteChannelRequest request,
                                                      AsyncHandler<DeleteChannelRequest,DeleteChannelResult> asyncHandler)
```
    Description copied from interface: AmazonIVSAsync
    
    Deletes the specified channel and its associated stream keys.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the DeleteChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteStreamKeyAsync
```
public Future<DeleteStreamKeyResult> deleteStreamKeyAsync(DeleteStreamKeyRequest request)
```
    Description copied from interface: AmazonIVSAsync
    
    Deletes the stream key for the specified ARN, so it can no longer be used to stream.
    
    Specified by:
    
    deleteStreamKeyAsync in interface AmazonIVSAsync
    
    Returns:
    
    A Java Future containing the result of the DeleteStreamKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteStreamKeyAsync
```
public Future<DeleteStreamKeyResult> deleteStreamKeyAsync(DeleteStreamKeyRequest request,
                                                          AsyncHandler<DeleteStreamKeyRequest,DeleteStreamKeyResult> asyncHandler)
```
    Description copied from interface: AmazonIVSAsync
    
    Deletes the stream key for the specified ARN, so it can no longer be used to stream.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the DeleteStreamKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getChannelAsync
```
public Future<GetChannelResult> getChannelAsync(GetChannelRequest request)
```
    Description copied from interface: AmazonIVSAsync
    
    Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
    
    Specified by:
    
    getChannelAsync in interface AmazonIVSAsync
    
    Returns:
    
    A Java Future containing the result of the GetChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getChannelAsync
```
public Future<GetChannelResult> getChannelAsync(GetChannelRequest request,
                                                AsyncHandler<GetChannelRequest,GetChannelResult> asyncHandler)
```
    Description copied from interface: AmazonIVSAsync
    
    Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the GetChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getStreamAsync
```
public Future<GetStreamResult> getStreamAsync(GetStreamRequest request)
```
    Description copied from interface: AmazonIVSAsync
    
    Gets information about the active (live) stream on a specified channel.
    
    Specified by:
    
    getStreamAsync in interface AmazonIVSAsync
    
    Returns:
    
    A Java Future containing the result of the GetStream operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getStreamAsync
```
public Future<GetStreamResult> getStreamAsync(GetStreamRequest request,
                                              AsyncHandler<GetStreamRequest,GetStreamResult> asyncHandler)
```
    Description copied from interface: AmazonIVSAsync
    
    Gets information about the active (live) stream on a specified channel.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the GetStream operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getStreamKeyAsync
```
public Future<GetStreamKeyResult> getStreamKeyAsync(GetStreamKeyRequest request)
```
    Description copied from interface: AmazonIVSAsync
    
    Gets stream-key information for a specified ARN.
    
    Specified by:
    
    getStreamKeyAsync in interface AmazonIVSAsync
    
    Returns:
    
    A Java Future containing the result of the GetStreamKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getStreamKeyAsync
```
public Future<GetStreamKeyResult> getStreamKeyAsync(GetStreamKeyRequest request,
                                                    AsyncHandler<GetStreamKeyRequest,GetStreamKeyResult> asyncHandler)
```
    Description copied from interface: AmazonIVSAsync
    
    Gets stream-key information for a specified ARN.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the GetStreamKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listChannelsAsync
```
public Future<ListChannelsResult> listChannelsAsync(ListChannelsRequest request)
```
    Description copied from interface: AmazonIVSAsync
    
    Gets summary information about all channels in your account, in the AWS region where the API request is processed. This list can be filtered to match a specified string.
    
    Specified by:
    
    listChannelsAsync in interface AmazonIVSAsync
    
    Returns:
    
    A Java Future containing the result of the ListChannels operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listChannelsAsync
```
public Future<ListChannelsResult> listChannelsAsync(ListChannelsRequest request,
                                                    AsyncHandler<ListChannelsRequest,ListChannelsResult> asyncHandler)
```
    Description copied from interface: AmazonIVSAsync
    
    Gets summary information about all channels in your account, in the AWS region where the API request is processed. This list can be filtered to match a specified string.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the ListChannels operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listStreamKeysAsync
```
public Future<ListStreamKeysResult> listStreamKeysAsync(ListStreamKeysRequest request)
```
    Description copied from interface: AmazonIVSAsync
    
    Gets summary information about stream keys for the specified channel.
    
    Specified by:
    
    listStreamKeysAsync in interface AmazonIVSAsync
    
    Returns:
    
    A Java Future containing the result of the ListStreamKeys operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listStreamKeysAsync
```
public Future<ListStreamKeysResult> listStreamKeysAsync(ListStreamKeysRequest request,
                                                        AsyncHandler<ListStreamKeysRequest,ListStreamKeysResult> asyncHandler)
```
    Description copied from interface: AmazonIVSAsync
    
    Gets summary information about stream keys for the specified channel.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the ListStreamKeys operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listStreamsAsync
```
public Future<ListStreamsResult> listStreamsAsync(ListStreamsRequest request)
```
    Description copied from interface: AmazonIVSAsync
    
    Gets summary information about live streams in your account, in the AWS region where the API request is processed.
    
    Specified by:
    
    listStreamsAsync in interface AmazonIVSAsync
    
    Returns:
    
    A Java Future containing the result of the ListStreams operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listStreamsAsync
```
public Future<ListStreamsResult> listStreamsAsync(ListStreamsRequest request,
                                                  AsyncHandler<ListStreamsRequest,ListStreamsResult> asyncHandler)
```
    Description copied from interface: AmazonIVSAsync
    
    Gets summary information about live streams in your account, in the AWS region where the API request is processed.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the ListStreams operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResourceAsync
```
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonIVSAsync
    
    Gets information about AWS tags for the specified ARN.
    
    Specified by:
    
    listTagsForResourceAsync in interface AmazonIVSAsync
    
    Returns:
    
    A Java Future containing the result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResourceAsync
```
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request,
                                                                  AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
```
    Description copied from interface: AmazonIVSAsync
    
    Gets information about AWS tags for the specified ARN.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putMetadataAsync
```
public Future<PutMetadataResult> putMetadataAsync(PutMetadataRequest request)
```
    Description copied from interface: AmazonIVSAsync
    
    Inserts metadata into an RTMPS stream for the specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1KB payload.
    
    Specified by:
    
    putMetadataAsync in interface AmazonIVSAsync
    
    Returns:
    
    A Java Future containing the result of the PutMetadata operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putMetadataAsync
```
public Future<PutMetadataResult> putMetadataAsync(PutMetadataRequest request,
                                                  AsyncHandler<PutMetadataRequest,PutMetadataResult> asyncHandler)
```
    Description copied from interface: AmazonIVSAsync
    
    Inserts metadata into an RTMPS stream for the specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1KB payload.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the PutMetadata operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopStreamAsync
```
public Future<StopStreamResult> stopStreamAsync(StopStreamRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    stopStreamAsync in interface AmazonIVSAsync
    
    Returns:
    
    A Java Future containing the result of the StopStream operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopStreamAsync
```
public Future<StopStreamResult> stopStreamAsync(StopStreamRequest request,
                                                AsyncHandler<StopStreamRequest,StopStreamResult> asyncHandler)
```
    Description copied from interface: 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.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the StopStream operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResourceAsync
```
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
```
    Description copied from interface: AmazonIVSAsync
    
    Adds or updates tags for the AWS resource with the specified ARN.
    
    Specified by:
    
    tagResourceAsync in interface AmazonIVSAsync
    
    Returns:
    
    A Java Future containing the result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResourceAsync
```
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request,
                                                  AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
```
    Description copied from interface: AmazonIVSAsync
    
    Adds or updates tags for the AWS resource with the specified ARN.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResourceAsync
```
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
```
    Description copied from interface: AmazonIVSAsync
    
    Removes tags from the resource with the specified ARN.
    
    Specified by:
    
    untagResourceAsync in interface AmazonIVSAsync
    
    Returns:
    
    A Java Future containing the result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResourceAsync
```
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request,
                                                      AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
```
    Description copied from interface: AmazonIVSAsync
    
    Removes tags from the resource with the specified ARN.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateChannelAsync
```
public Future<UpdateChannelResult> updateChannelAsync(UpdateChannelRequest request)
```
    Description copied from interface: AmazonIVSAsync
    
    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.
    
    Specified by:
    
    updateChannelAsync in interface AmazonIVSAsync
    
    Returns:
    
    A Java Future containing the result of the UpdateChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateChannelAsync
```
public Future<UpdateChannelResult> updateChannelAsync(UpdateChannelRequest request,
                                                      AsyncHandler<UpdateChannelRequest,UpdateChannelResult> asyncHandler)
```
    Description copied from interface: AmazonIVSAsync
    
    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.
    
    Specified by:
    
    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.
    
    Returns:
    
    A Java Future containing the result of the UpdateChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.
    
    Specified by:
    
    shutdown in interface AmazonIVS
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Class AmazonIVSAsyncClient

Field Summary

Fields inherited from class com.amazonaws.services.ivs.AmazonIVSClient

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.ivs.AmazonIVS

Method Summary

Methods inherited from class com.amazonaws.services.ivs.AmazonIVSClient

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.ivs.AmazonIVS

Method Detail

asyncBuilder

getExecutorService

batchGetChannelAsync

batchGetChannelAsync

batchGetStreamKeyAsync

batchGetStreamKeyAsync

createChannelAsync

createChannelAsync

createStreamKeyAsync

createStreamKeyAsync

deleteChannelAsync

deleteChannelAsync

deleteStreamKeyAsync

deleteStreamKeyAsync

getChannelAsync

getChannelAsync

getStreamAsync

getStreamAsync

getStreamKeyAsync

getStreamKeyAsync

listChannelsAsync

listChannelsAsync

listStreamKeysAsync

listStreamKeysAsync

listStreamsAsync

listStreamsAsync

listTagsForResourceAsync

listTagsForResourceAsync

putMetadataAsync

putMetadataAsync

stopStreamAsync

stopStreamAsync

tagResourceAsync

tagResourceAsync

untagResourceAsync

untagResourceAsync

updateChannelAsync

updateChannelAsync

shutdown