@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonIVS
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-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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
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 the specified channel ARN.
|
DeleteChannelResult |
deleteChannel(DeleteChannelRequest deleteChannelRequest)
Deletes the specified channel and its associated stream keys.
|
DeletePlaybackKeyPairResult |
deletePlaybackKeyPair(DeletePlaybackKeyPairRequest deletePlaybackKeyPairRequest)
Deletes a specified authorization key pair.
|
DeleteStreamKeyResult |
deleteStreamKey(DeleteStreamKeyRequest deleteStreamKeyRequest)
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 getChannelRequest)
Gets the channel configuration for the specified channel ARN.
|
GetPlaybackKeyPairResult |
getPlaybackKeyPair(GetPlaybackKeyPairRequest getPlaybackKeyPairRequest)
Gets a specified playback authorization key pair and returns the
arn and fingerprint . |
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.
|
ImportPlaybackKeyPairResult |
importPlaybackKeyPair(ImportPlaybackKeyPairRequest importPlaybackKeyPairRequest)
Imports the public portion of a new key pair and returns its
arn and fingerprint . |
ListChannelsResult |
listChannels(ListChannelsRequest listChannelsRequest)
Gets summary information about all channels in your account, in the AWS region where the API request is
processed.
|
ListPlaybackKeyPairsResult |
listPlaybackKeyPairs(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest)
Gets summary information about playback key pairs.
|
ListStreamKeysResult |
listStreamKeys(ListStreamKeysRequest listStreamKeysRequest)
Gets summary information about stream keys for the specified channel.
|
ListStreamsResult |
listStreams(ListStreamsRequest listStreamsRequest)
Gets summary information about live streams in your account, in the AWS region where the API request is
processed.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
|
PutMetadataResult |
putMetadata(PutMetadataRequest putMetadataRequest)
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 stopStreamRequest)
Disconnects the incoming RTMPS stream for the specified channel.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds or updates tags for the AWS resource with the specified ARN.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the resource with the specified ARN.
|
UpdateChannelResult |
updateChannel(UpdateChannelRequest updateChannelRequest)
Updates a channel's configuration.
|
static final String ENDPOINT_PREFIX
BatchGetChannelResult batchGetChannel(BatchGetChannelRequest batchGetChannelRequest)
Performs GetChannel on multiple ARNs simultaneously.
batchGetChannelRequest
- BatchGetStreamKeyResult batchGetStreamKey(BatchGetStreamKeyRequest batchGetStreamKeyRequest)
Performs GetStreamKey on multiple ARNs simultaneously.
batchGetStreamKeyRequest
- CreateChannelResult createChannel(CreateChannelRequest createChannelRequest)
Creates a new channel and an associated stream key to start streaming.
createChannelRequest
- ValidationException
AccessDeniedException
ServiceQuotaExceededException
PendingVerificationException
CreateStreamKeyResult createStreamKey(CreateStreamKeyRequest createStreamKeyRequest)
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.
createStreamKeyRequest
- ValidationException
AccessDeniedException
ResourceNotFoundException
ServiceQuotaExceededException
PendingVerificationException
DeleteChannelResult deleteChannel(DeleteChannelRequest deleteChannelRequest)
Deletes the specified channel and its associated stream keys.
deleteChannelRequest
- ValidationException
AccessDeniedException
ResourceNotFoundException
ConflictException
PendingVerificationException
DeletePlaybackKeyPairResult deletePlaybackKeyPair(DeletePlaybackKeyPairRequest deletePlaybackKeyPairRequest)
Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s
privateKey
.
deletePlaybackKeyPairRequest
- ValidationException
AccessDeniedException
ResourceNotFoundException
PendingVerificationException
DeleteStreamKeyResult deleteStreamKey(DeleteStreamKeyRequest deleteStreamKeyRequest)
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
deleteStreamKeyRequest
- ValidationException
AccessDeniedException
ResourceNotFoundException
PendingVerificationException
GetChannelResult getChannel(GetChannelRequest getChannelRequest)
Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
getChannelRequest
- ValidationException
AccessDeniedException
ResourceNotFoundException
GetPlaybackKeyPairResult getPlaybackKeyPair(GetPlaybackKeyPairRequest getPlaybackKeyPairRequest)
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.
getPlaybackKeyPairRequest
- ValidationException
AccessDeniedException
ResourceNotFoundException
GetStreamResult getStream(GetStreamRequest getStreamRequest)
Gets information about the active (live) stream on a specified channel.
getStreamRequest
- ResourceNotFoundException
ValidationException
AccessDeniedException
ChannelNotBroadcastingException
GetStreamKeyResult getStreamKey(GetStreamKeyRequest getStreamKeyRequest)
Gets stream-key information for a specified ARN.
getStreamKeyRequest
- ValidationException
AccessDeniedException
ResourceNotFoundException
ImportPlaybackKeyPairResult importPlaybackKeyPair(ImportPlaybackKeyPairRequest importPlaybackKeyPairRequest)
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.
importPlaybackKeyPairRequest
- ValidationException
ConflictException
AccessDeniedException
ServiceQuotaExceededException
PendingVerificationException
ListChannelsResult listChannels(ListChannelsRequest listChannelsRequest)
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.
listChannelsRequest
- ValidationException
AccessDeniedException
ListPlaybackKeyPairsResult listPlaybackKeyPairs(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest)
Gets summary information about playback key pairs.
listPlaybackKeyPairsRequest
- ValidationException
AccessDeniedException
ListStreamKeysResult listStreamKeys(ListStreamKeysRequest listStreamKeysRequest)
Gets summary information about stream keys for the specified channel.
listStreamKeysRequest
- ValidationException
AccessDeniedException
ResourceNotFoundException
ListStreamsResult listStreams(ListStreamsRequest listStreamsRequest)
Gets summary information about live streams in your account, in the AWS region where the API request is processed.
listStreamsRequest
- AccessDeniedException
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
listTagsForResourceRequest
- InternalServerException
ValidationException
ResourceNotFoundException
PutMetadataResult putMetadata(PutMetadataRequest putMetadataRequest)
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.
putMetadataRequest
- ThrottlingException
ResourceNotFoundException
ChannelNotBroadcastingException
ValidationException
AccessDeniedException
StopStreamResult stopStream(StopStreamRequest stopStreamRequest)
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.
stopStreamRequest
- ResourceNotFoundException
ChannelNotBroadcastingException
ValidationException
AccessDeniedException
StreamUnavailableException
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds or updates tags for the AWS resource with the specified ARN.
tagResourceRequest
- InternalServerException
ValidationException
ResourceNotFoundException
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the resource with the specified ARN.
untagResourceRequest
- InternalServerException
ValidationException
ResourceNotFoundException
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.
updateChannelRequest
- ValidationException
AccessDeniedException
ResourceNotFoundException
ConflictException
PendingVerificationException
void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.