AmazonIVS (AWS SDK for Java

All Known Subinterfaces:

AmazonIVSAsync

All Known Implementing Classes:

AbstractAmazonIVS, AbstractAmazonIVSAsync, AmazonIVSAsyncClient, AmazonIVSClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonIVS
```
Interface for accessing Amazon IVS.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonIVS instead.

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-2, 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.

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 a specified channel ARN (Amazon Resource Name).
- BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously.
- ListChannels — Gets summary information about channels. 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 a specified channel.
StreamKey:
- CreateStreamKey — Creates a stream key, used to initiate a stream, for a specified channel ARN.
- GetStreamKey — Gets stream key information for the specified ARN.
- BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously.
- ListStreamKeys — Gets a list of stream keys. The list can be filtered to a particular channel.
- DeleteStreamKey — Deletes the stream key for a 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.
- StopStream — Disconnects a streamer on a specified channel. This disconnects the incoming RTMP stream from the client. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.
- PutMetadata Inserts metadata into an RTMP stream for a 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 an AWS resource with a specified ARN.
- UntagResource — Removes tags from a resource with a specified ARN.
- ListTagsForResource — Gets information about AWS tags for a specified ARN.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BatchGetChannelResult`	`batchGetChannel(BatchGetChannelRequest batchGetChannelRequest)` Performs GetChannel on multiple ARNs simultaneously.
`BatchGetStreamKeyResult`	`batchGetStreamKey(BatchGetStreamKeyRequest batchGetStreamKeyRequest)` Performs GetStreamKey on multiple ARNs simultaneously.
`CreateChannelResult`	`createChannel(CreateChannelRequest createChannelRequest)` Creates a new channel and an associated stream key to start streaming.
`CreateStreamKeyResult`	`createStreamKey(CreateStreamKeyRequest createStreamKeyRequest)` Creates a stream key, used to initiate a stream, for a specified channel ARN.
`DeleteChannelResult`	`deleteChannel(DeleteChannelRequest deleteChannelRequest)` Deletes a specified channel and its associated stream keys.
`DeleteStreamKeyResult`	`deleteStreamKey(DeleteStreamKeyRequest deleteStreamKeyRequest)` Deletes the stream key for a 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 getChannelRequest)` Gets the channel configuration for a specified channel ARN.
`GetStreamResult`	`getStream(GetStreamRequest getStreamRequest)` Gets information about the active (live) stream on a specified channel.
`GetStreamKeyResult`	`getStreamKey(GetStreamKeyRequest getStreamKeyRequest)` Gets stream-key information for a specified ARN.
`ListChannelsResult`	`listChannels(ListChannelsRequest listChannelsRequest)` Gets summary information about channels.
`ListStreamKeysResult`	`listStreamKeys(ListStreamKeysRequest listStreamKeysRequest)` Gets summary information about stream keys.
`ListStreamsResult`	`listStreams(ListStreamsRequest listStreamsRequest)` Gets summary information about live streams.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Gets information about the tags for a specified ARN.
`PutMetadataResult`	`putMetadata(PutMetadataRequest putMetadataRequest)` Inserts metadata into an RTMP stream for a specified channel.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StopStreamResult`	`stopStream(StopStreamRequest stopStreamRequest)` Disconnects the stream for the specified channel.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds or updates tags for a resource with a specified ARN.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes tags for a resource with a specified ARN.
`UpdateChannelResult`	`updateChannel(UpdateChannelRequest updateChannelRequest)` Updates a channel's configuration.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - batchGetChannel
```
BatchGetChannelResult batchGetChannel(BatchGetChannelRequest batchGetChannelRequest)
```
    Performs GetChannel on multiple ARNs simultaneously.
    
    Parameters:
    
    batchGetChannelRequest -
    
    Returns:
    
    Result of the BatchGetChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetStreamKey
```
BatchGetStreamKeyResult batchGetStreamKey(BatchGetStreamKeyRequest batchGetStreamKeyRequest)
```
    Performs GetStreamKey on multiple ARNs simultaneously.
    
    Parameters:
    
    batchGetStreamKeyRequest -
    
    Returns:
    
    Result of the BatchGetStreamKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createChannel
```
CreateChannelResult createChannel(CreateChannelRequest createChannelRequest)
```
    Creates a new channel and an associated stream key to start streaming.
    
    Parameters:
    
    createChannelRequest -
    
    Returns:
    
    Result of the CreateChannel operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ServiceQuotaExceededException
    
    See Also:
    
    AWS API Documentation
  - createStreamKey
```
CreateStreamKeyResult createStreamKey(CreateStreamKeyRequest createStreamKeyRequest)
```
    Creates a stream key, used to initiate a stream, for a 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.
    
    Parameters:
    
    createStreamKeyRequest -
    
    Returns:
    
    Result of the CreateStreamKey operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ResourceNotFoundException
    
    ServiceQuotaExceededException
    
    See Also:
    
    AWS API Documentation
  - deleteChannel
```
DeleteChannelResult deleteChannel(DeleteChannelRequest deleteChannelRequest)
```
    Deletes a specified channel and its associated stream keys.
    
    Parameters:
    
    deleteChannelRequest -
    
    Returns:
    
    Result of the DeleteChannel operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ResourceNotFoundException
    
    ConflictException
    
    See Also:
    
    AWS API Documentation
  - deleteStreamKey
```
DeleteStreamKeyResult deleteStreamKey(DeleteStreamKeyRequest deleteStreamKeyRequest)
```
    Deletes the stream key for a specified ARN, so it can no longer be used to stream.
    
    Parameters:
    
    deleteStreamKeyRequest -
    
    Returns:
    
    Result of the DeleteStreamKey operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - getChannel
```
GetChannelResult getChannel(GetChannelRequest getChannelRequest)
```
    Gets the channel configuration for a specified channel ARN. See also BatchGetChannel.
    
    Parameters:
    
    getChannelRequest -
    
    Returns:
    
    Result of the GetChannel operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - getStream
```
GetStreamResult getStream(GetStreamRequest getStreamRequest)
```
    Gets information about the active (live) stream on a specified channel.
    
    Parameters:
    
    getStreamRequest -
    
    Returns:
    
    Result of the GetStream operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ValidationException
    
    AccessDeniedException
    
    ChannelNotBroadcastingException
    
    See Also:
    
    AWS API Documentation
  - getStreamKey
```
GetStreamKeyResult getStreamKey(GetStreamKeyRequest getStreamKeyRequest)
```
    Gets stream-key information for a specified ARN.
    
    Parameters:
    
    getStreamKeyRequest -
    
    Returns:
    
    Result of the GetStreamKey operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - listChannels
```
ListChannelsResult listChannels(ListChannelsRequest listChannelsRequest)
```
    Gets summary information about channels. This list can be filtered to match a specified string.
    
    Parameters:
    
    listChannelsRequest -
    
    Returns:
    
    Result of the ListChannels operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - listStreamKeys
```
ListStreamKeysResult listStreamKeys(ListStreamKeysRequest listStreamKeysRequest)
```
    Gets summary information about stream keys. The list can be filtered to a particular channel.
    
    Parameters:
    
    listStreamKeysRequest -
    
    Returns:
    
    Result of the ListStreamKeys operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - listStreams
```
ListStreamsResult listStreams(ListStreamsRequest listStreamsRequest)
```
    Gets summary information about live streams.
    
    Parameters:
    
    listStreamsRequest -
    
    Returns:
    
    Result of the ListStreams operation returned by the service.
    
    Throws:
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Gets information about the tags for a specified ARN.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    InternalServerException
    
    ValidationException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - putMetadata
```
PutMetadataResult putMetadata(PutMetadataRequest putMetadataRequest)
```
    Inserts metadata into an RTMP stream for a specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1KB payload.
    
    Parameters:
    
    putMetadataRequest -
    
    Returns:
    
    Result of the PutMetadata operation returned by the service.
    
    Throws:
    
    ThrottlingException
    
    ResourceNotFoundException
    
    ChannelNotBroadcastingException
    
    ValidationException
    
    AccessDeniedException
    
    See Also:
    
    AWS API Documentation
  - stopStream
```
StopStreamResult stopStream(StopStreamRequest stopStreamRequest)
```
    Disconnects the stream for the specified channel. This disconnects the incoming RTMP stream from the client. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.
    
    Many streaming client-software libraries automatically reconnect a dropped RTMP session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel.
    
    Parameters:
    
    stopStreamRequest -
    
    Returns:
    
    Result of the StopStream operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException
    
    ChannelNotBroadcastingException
    
    ValidationException
    
    AccessDeniedException
    
    StreamUnavailableException
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Adds or updates tags for a resource with a specified ARN.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    InternalServerException
    
    ValidationException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes tags for a resource with a specified ARN.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    InternalServerException
    
    ValidationException
    
    ResourceNotFoundException
    
    See Also:
    
    AWS API Documentation
  - updateChannel
```
UpdateChannelResult updateChannel(UpdateChannelRequest updateChannelRequest)
```
    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.
    
    Parameters:
    
    updateChannelRequest -
    
    Returns:
    
    Result of the UpdateChannel operation returned by the service.
    
    Throws:
    
    ValidationException
    
    AccessDeniedException
    
    ResourceNotFoundException
    
    ConflictException
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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 a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonIVS

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

batchGetChannel

batchGetStreamKey

createChannel

createStreamKey

deleteChannel

deleteStreamKey

getChannel

getStream

getStreamKey

listChannels

listStreamKeys

listStreams

listTagsForResource

putMetadata

stopStream

tagResource

untagResource

updateChannel

shutdown

getCachedResponseMetadata