AmazonIVSClient (AWS SDK for Java

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

All Implemented Interfaces:

AmazonIVS

Direct Known Subclasses:

AmazonIVSAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonIVSClient
extends AmazonWebServiceClient
implements AmazonIVS
```
Client for accessing Amazon IVS. All service calls made using this client are blocking, and will not return until the service call 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.
- 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.
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, Stream Keys, and Playback Key Pairs.

Channel Endpoints
- CreateChannel — Creates a new channel and an associated stream key to start streaming.
- GetChannel — Gets the channel configuration for the specified channel ARN (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 Endpoints
- CreateStreamKey — Creates a stream key, used to initiate a stream, for the specified channel ARN.
- GetStreamKey — Gets stream key information for the specified ARN.
- BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously.
- ListStreamKeys — Gets summary information about stream keys for the specified channel.
- DeleteStreamKey — Deletes the stream key for the specified ARN, so it can no longer be used to stream.
Stream Endpoints
- GetStream — Gets information about the active (live) stream on a specified channel.
- 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.
PlaybackKeyPair Endpoints
- ImportPlaybackKeyPair — Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to authorized channels.
- GetPlaybackKeyPair — Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to authorized channels.
- ListPlaybackKeyPairs — Gets summary information about playback key pairs.
- DeletePlaybackKeyPair — Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey.
AWS Tags Endpoints
- 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.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- 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
`BatchGetChannelResult`	`batchGetChannel(BatchGetChannelRequest request)` Performs GetChannel on multiple ARNs simultaneously.
`BatchGetStreamKeyResult`	`batchGetStreamKey(BatchGetStreamKeyRequest request)` Performs GetStreamKey on multiple ARNs simultaneously.
`static AmazonIVSClientBuilder`	`builder()`
`CreateChannelResult`	`createChannel(CreateChannelRequest request)` Creates a new channel and an associated stream key to start streaming.
`CreateStreamKeyResult`	`createStreamKey(CreateStreamKeyRequest request)` Creates a stream key, used to initiate a stream, for the specified channel ARN.
`DeleteChannelResult`	`deleteChannel(DeleteChannelRequest request)` Deletes the specified channel and its associated stream keys.
`DeletePlaybackKeyPairResult`	`deletePlaybackKeyPair(DeletePlaybackKeyPairRequest request)` Deletes a specified authorization key pair.
`DeleteStreamKeyResult`	`deleteStreamKey(DeleteStreamKeyRequest request)` Deletes the stream key for the specified ARN, so it can no longer be used to stream.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetChannelResult`	`getChannel(GetChannelRequest request)` Gets the channel configuration for the specified channel ARN.
`GetPlaybackKeyPairResult`	`getPlaybackKeyPair(GetPlaybackKeyPairRequest request)` Gets a specified playback authorization key pair and returns the `arn` and `fingerprint`.
`GetStreamResult`	`getStream(GetStreamRequest request)` Gets information about the active (live) stream on a specified channel.
`GetStreamKeyResult`	`getStreamKey(GetStreamKeyRequest request)` Gets stream-key information for a specified ARN.
`ImportPlaybackKeyPairResult`	`importPlaybackKeyPair(ImportPlaybackKeyPairRequest request)` Imports the public portion of a new key pair and returns its `arn` and `fingerprint`.
`ListChannelsResult`	`listChannels(ListChannelsRequest request)` Gets summary information about all channels in your account, in the AWS region where the API request is processed.
`ListPlaybackKeyPairsResult`	`listPlaybackKeyPairs(ListPlaybackKeyPairsRequest request)` Gets summary information about playback key pairs.
`ListStreamKeysResult`	`listStreamKeys(ListStreamKeysRequest request)` Gets summary information about stream keys for the specified channel.
`ListStreamsResult`	`listStreams(ListStreamsRequest request)` Gets summary information about live streams in your account, in the AWS region where the API request is processed.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Gets information about AWS tags for the specified ARN.
`PutMetadataResult`	`putMetadata(PutMetadataRequest request)` Inserts metadata into an RTMPS stream for the specified channel.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StopStreamResult`	`stopStream(StopStreamRequest request)` Disconnects the incoming RTMPS stream for the specified channel.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds or updates tags for the AWS resource with the specified ARN.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes tags from the resource with the specified ARN.
`UpdateChannelResult`	`updateChannel(UpdateChannelRequest request)` Updates a channel's configuration.

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

- Method Detail
  - builder
```
public static AmazonIVSClientBuilder builder()
```
  - batchGetChannel
```
public BatchGetChannelResult batchGetChannel(BatchGetChannelRequest request)
```
    Performs GetChannel on multiple ARNs simultaneously.
    
    Specified by:
    
    batchGetChannel in interface AmazonIVS
    
    Parameters:
    
    batchGetChannelRequest -
    
    Returns:
    
    Result of the BatchGetChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetStreamKey
```
public BatchGetStreamKeyResult batchGetStreamKey(BatchGetStreamKeyRequest request)
```
    Performs GetStreamKey on multiple ARNs simultaneously.
    
    Specified by:
    
    batchGetStreamKey in interface AmazonIVS
    
    Parameters:
    
    batchGetStreamKeyRequest -
    
    Returns:
    
    Result of the BatchGetStreamKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createChannel
```
public CreateChannelResult createChannel(CreateChannelRequest request)
```
    Creates a new channel and an associated stream key to start streaming.
    
    Specified by:
    
    createChannel in interface AmazonIVS
    
    Parameters:
    
    createChannelRequest -
    
    Returns:
    
    Result of the CreateChannel operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ServiceQuotaExceededException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - createStreamKey
```
public CreateStreamKeyResult createStreamKey(CreateStreamKeyRequest request)
```
    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:
    
    createStreamKey in interface AmazonIVS
    
    Parameters:
    
    createStreamKeyRequest -
    
    Returns:
    
    Result of the CreateStreamKey operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ResourceNotFoundException
    
    ServiceQuotaExceededException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - deleteChannel
```
public DeleteChannelResult deleteChannel(DeleteChannelRequest request)
```
    Deletes the specified channel and its associated stream keys.
    
    Specified by:
    
    deleteChannel in interface AmazonIVS
    
    Parameters:
    
    deleteChannelRequest -
    
    Returns:
    
    Result of the DeleteChannel operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ResourceNotFoundException
    
    ConflictException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - deletePlaybackKeyPair
```
public DeletePlaybackKeyPairResult deletePlaybackKeyPair(DeletePlaybackKeyPairRequest request)
```
    Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey.
    
    Specified by:
    
    deletePlaybackKeyPair in interface AmazonIVS
    
    Parameters:
    
    deletePlaybackKeyPairRequest -
    
    Returns:
    
    Result of the DeletePlaybackKeyPair operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ResourceNotFoundException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - deleteStreamKey
```
public DeleteStreamKeyResult deleteStreamKey(DeleteStreamKeyRequest request)
```
    Deletes the stream key for the specified ARN, so it can no longer be used to stream.
    
    Specified by:
    
    deleteStreamKey in interface AmazonIVS
    
    Parameters:
    
    deleteStreamKeyRequest -
    
    Returns:
    
    Result of the DeleteStreamKey operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ResourceNotFoundException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - getChannel
```
public GetChannelResult getChannel(GetChannelRequest request)
```
    Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
    
    Specified by:
    
    getChannel in interface AmazonIVS
    
    Parameters:
    
    getChannelRequest -
    
    Returns:
    
    Result of the GetChannel operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - getPlaybackKeyPair
```
public GetPlaybackKeyPairResult getPlaybackKeyPair(GetPlaybackKeyPairRequest request)
```
    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 authorized channels.
    
    Specified by:
    
    getPlaybackKeyPair in interface AmazonIVS
    
    Parameters:
    
    getPlaybackKeyPairRequest -
    
    Returns:
    
    Result of the GetPlaybackKeyPair operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - getStream
```
public GetStreamResult getStream(GetStreamRequest request)
```
    Gets information about the active (live) stream on a specified channel.
    
    Specified by:
    
    getStream in interface AmazonIVS
    
    Parameters:
    
    getStreamRequest -
    
    Returns:
    
    Result of the GetStream operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AccessDeniedException
    
    ChannelNotBroadcastingException
    
    See Also:
    
    AWS API Documentation
  - getStreamKey
```
public GetStreamKeyResult getStreamKey(GetStreamKeyRequest request)
```
    Gets stream-key information for a specified ARN.
    
    Specified by:
    
    getStreamKey in interface AmazonIVS
    
    Parameters:
    
    getStreamKeyRequest -
    
    Returns:
    
    Result of the GetStreamKey operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - importPlaybackKeyPair
```
public ImportPlaybackKeyPairResult importPlaybackKeyPair(ImportPlaybackKeyPairRequest request)
```
    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 authorized channels.
    
    Specified by:
    
    importPlaybackKeyPair in interface AmazonIVS
    
    Parameters:
    
    importPlaybackKeyPairRequest -
    
    Returns:
    
    Result of the ImportPlaybackKeyPair operation returned by the service.
    
    Throws:
    
    ValidationException
    
    ConflictException
    
    AccessDeniedException
    
    ServiceQuotaExceededException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - listChannels
```
public ListChannelsResult listChannels(ListChannelsRequest request)
```
    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:
    
    listChannels in interface AmazonIVS
    
    Parameters:
    
    listChannelsRequest -
    
    Returns:
    
    Result of the ListChannels operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - listPlaybackKeyPairs
```
public ListPlaybackKeyPairsResult listPlaybackKeyPairs(ListPlaybackKeyPairsRequest request)
```
    Gets summary information about playback key pairs.
    
    Specified by:
    
    listPlaybackKeyPairs in interface AmazonIVS
    
    Parameters:
    
    listPlaybackKeyPairsRequest -
    
    Returns:
    
    Result of the ListPlaybackKeyPairs operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - listStreamKeys
```
public ListStreamKeysResult listStreamKeys(ListStreamKeysRequest request)
```
    Gets summary information about stream keys for the specified channel.
    
    Specified by:
    
    listStreamKeys in interface AmazonIVS
    
    Parameters:
    
    listStreamKeysRequest -
    
    Returns:
    
    Result of the ListStreamKeys operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - listStreams
```
public ListStreamsResult listStreams(ListStreamsRequest request)
```
    Gets summary information about live streams in your account, in the AWS region where the API request is processed.
    
    Specified by:
    
    listStreams in interface AmazonIVS
    
    Parameters:
    
    listStreamsRequest -
    
    Returns:
    
    Result of the ListStreams operation returned by the service.
    
    Throws:
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Gets information about AWS tags for the specified ARN.
    
    Specified by:
    
    listTagsForResource in interface AmazonIVS
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    InternalServerException
    
    ValidationException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - putMetadata
```
public PutMetadataResult putMetadata(PutMetadataRequest request)
```
    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:
    
    putMetadata in interface AmazonIVS
    
    Parameters:
    
    putMetadataRequest -
    
    Returns:
    
    Result of the PutMetadata operation returned by the service.
    
    Throws:
    
    ThrottlingException
    
    ResourceNotFoundException
    
    ChannelNotBroadcastingException
    
    ValidationException
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - stopStream
```
public StopStreamResult stopStream(StopStreamRequest request)
```
    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:
    
    stopStream in interface AmazonIVS
    
    Parameters:
    
    stopStreamRequest -
    
    Returns:
    
    Result of the StopStream operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ChannelNotBroadcastingException
    
    ValidationException
    
    AccessDeniedException
    
    StreamUnavailableException
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Adds or updates tags for the AWS resource with the specified ARN.
    
    Specified by:
    
    tagResource in interface AmazonIVS
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    InternalServerException
    
    ValidationException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes tags from the resource with the specified ARN.
    
    Specified by:
    
    untagResource in interface AmazonIVS
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    InternalServerException
    
    ValidationException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - updateChannel
```
public UpdateChannelResult updateChannel(UpdateChannelRequest request)
```
    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:
    
    updateChannel in interface AmazonIVS
    
    Parameters:
    
    updateChannelRequest -
    
    Returns:
    
    Result of the UpdateChannel operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ResourceNotFoundException
    
    ConflictException
    
    PendingVerificationException
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonIVS
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonIVS
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AmazonIVSClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

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

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

batchGetChannel

batchGetStreamKey

createChannel

createStreamKey

deleteChannel

deletePlaybackKeyPair

deleteStreamKey

getChannel

getPlaybackKeyPair

getStream

getStreamKey

importPlaybackKeyPair

listChannels

listPlaybackKeyPairs

listStreamKeys

listStreams

listTagsForResource

putMetadata

stopStream

tagResource

untagResource

updateChannel

getCachedResponseMetadata

shutdown