@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonIVS extends Object implements AmazonIVS
AmazonIVS
. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
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.
|
BatchStartViewerSessionRevocationResult |
batchStartViewerSessionRevocation(BatchStartViewerSessionRevocationRequest request)
Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
|
CreateChannelResult |
createChannel(CreateChannelRequest request)
Creates a new channel and an associated stream key to start streaming.
|
CreatePlaybackRestrictionPolicyResult |
createPlaybackRestrictionPolicy(CreatePlaybackRestrictionPolicyRequest request)
Creates a new playback restriction policy, for constraining playback by countries and/or origins.
|
CreateRecordingConfigurationResult |
createRecordingConfiguration(CreateRecordingConfigurationRequest request)
Creates a new recording configuration, used to enable recording to Amazon S3.
|
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.
|
DeletePlaybackRestrictionPolicyResult |
deletePlaybackRestrictionPolicy(DeletePlaybackRestrictionPolicyRequest request)
Deletes the specified playback restriction policy.
|
DeleteRecordingConfigurationResult |
deleteRecordingConfiguration(DeleteRecordingConfigurationRequest request)
Deletes the recording configuration for the specified ARN.
|
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 . |
GetPlaybackRestrictionPolicyResult |
getPlaybackRestrictionPolicy(GetPlaybackRestrictionPolicyRequest request)
Gets the specified playback restriction policy.
|
GetRecordingConfigurationResult |
getRecordingConfiguration(GetRecordingConfigurationRequest request)
Gets the recording configuration for the specified ARN.
|
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.
|
GetStreamSessionResult |
getStreamSession(GetStreamSessionRequest request)
Gets metadata on a specified stream.
|
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 Amazon Web Services region where the API
request is processed.
|
ListPlaybackKeyPairsResult |
listPlaybackKeyPairs(ListPlaybackKeyPairsRequest request)
Gets summary information about playback key pairs.
|
ListPlaybackRestrictionPoliciesResult |
listPlaybackRestrictionPolicies(ListPlaybackRestrictionPoliciesRequest request)
Gets summary information about playback restriction policies.
|
ListRecordingConfigurationsResult |
listRecordingConfigurations(ListRecordingConfigurationsRequest request)
Gets summary information about all recording configurations in your account, in the Amazon Web Services region
where the API request is processed.
|
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 Amazon Web Services region where the API
request is processed.
|
ListStreamSessionsResult |
listStreamSessions(ListStreamSessionsRequest request)
Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where
the API request is processed.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Gets information about Amazon Web Services tags for the specified ARN.
|
PutMetadataResult |
putMetadata(PutMetadataRequest request)
Inserts metadata into the active stream of the specified channel.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartViewerSessionRevocationResult |
startViewerSessionRevocation(StartViewerSessionRevocationRequest request)
Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID.
|
StopStreamResult |
stopStream(StopStreamRequest request)
Disconnects the incoming RTMPS stream for the specified channel.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds or updates tags for the Amazon Web Services 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.
|
UpdatePlaybackRestrictionPolicyResult |
updatePlaybackRestrictionPolicy(UpdatePlaybackRestrictionPolicyRequest request)
Updates a specified playback restriction policy.
|
public BatchGetChannelResult batchGetChannel(BatchGetChannelRequest request)
AmazonIVS
Performs GetChannel on multiple ARNs simultaneously.
batchGetChannel
in interface AmazonIVS
public BatchGetStreamKeyResult batchGetStreamKey(BatchGetStreamKeyRequest request)
AmazonIVS
Performs GetStreamKey on multiple ARNs simultaneously.
batchGetStreamKey
in interface AmazonIVS
public BatchStartViewerSessionRevocationResult batchStartViewerSessionRevocation(BatchStartViewerSessionRevocationRequest request)
AmazonIVS
Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
batchStartViewerSessionRevocation
in interface AmazonIVS
public CreateChannelResult createChannel(CreateChannelRequest request)
AmazonIVS
Creates a new channel and an associated stream key to start streaming.
createChannel
in interface AmazonIVS
public CreatePlaybackRestrictionPolicyResult createPlaybackRestrictionPolicy(CreatePlaybackRestrictionPolicyRequest request)
AmazonIVS
Creates a new playback restriction policy, for constraining playback by countries and/or origins.
createPlaybackRestrictionPolicy
in interface AmazonIVS
public CreateRecordingConfigurationResult createRecordingConfiguration(CreateRecordingConfigurationRequest request)
AmazonIVS
Creates a new recording configuration, used to enable recording to Amazon S3.
Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording
configuration, it returns success even if the S3 bucket is in a different region. In this case, the
state
of the recording configuration is CREATE_FAILED
(instead of ACTIVE
).
(In other regions, the CLI correctly returns failure if the bucket is in a different region.)
Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.
createRecordingConfiguration
in interface AmazonIVS
public CreateStreamKeyResult createStreamKey(CreateStreamKeyRequest request)
AmazonIVS
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.
createStreamKey
in interface AmazonIVS
public DeleteChannelResult deleteChannel(DeleteChannelRequest request)
AmazonIVS
Deletes the specified channel and its associated stream keys.
If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state is no longer Live), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)
deleteChannel
in interface AmazonIVS
public DeletePlaybackKeyPairResult deletePlaybackKeyPair(DeletePlaybackKeyPairRequest request)
AmazonIVS
Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s
privateKey
. For more information, see Setting Up Private Channels in
the Amazon IVS User Guide.
deletePlaybackKeyPair
in interface AmazonIVS
public DeletePlaybackRestrictionPolicyResult deletePlaybackRestrictionPolicy(DeletePlaybackRestrictionPolicyRequest request)
AmazonIVS
Deletes the specified playback restriction policy.
deletePlaybackRestrictionPolicy
in interface AmazonIVS
public DeleteRecordingConfigurationResult deleteRecordingConfiguration(DeleteRecordingConfigurationRequest request)
AmazonIVS
Deletes the recording configuration for the specified ARN.
If you try to delete a recording configuration that is associated with a channel, you will get an error (409
ConflictException). To avoid this, for all channels that reference the recording configuration, first use
UpdateChannel to set the recordingConfigurationArn
field to an empty string, then use
DeleteRecordingConfiguration.
deleteRecordingConfiguration
in interface AmazonIVS
public DeleteStreamKeyResult deleteStreamKey(DeleteStreamKeyRequest request)
AmazonIVS
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
deleteStreamKey
in interface AmazonIVS
public GetChannelResult getChannel(GetChannelRequest request)
AmazonIVS
Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
getChannel
in interface AmazonIVS
public GetPlaybackKeyPairResult getPlaybackKeyPair(GetPlaybackKeyPairRequest request)
AmazonIVS
Gets a specified playback authorization key pair and returns the arn
and fingerprint
.
The privateKey
held by the caller can be used to generate viewer authorization tokens, to grant
viewers access to private channels. For more information, see Setting Up Private Channels in
the Amazon IVS User Guide.
getPlaybackKeyPair
in interface AmazonIVS
public GetPlaybackRestrictionPolicyResult getPlaybackRestrictionPolicy(GetPlaybackRestrictionPolicyRequest request)
AmazonIVS
Gets the specified playback restriction policy.
getPlaybackRestrictionPolicy
in interface AmazonIVS
public GetRecordingConfigurationResult getRecordingConfiguration(GetRecordingConfigurationRequest request)
AmazonIVS
Gets the recording configuration for the specified ARN.
getRecordingConfiguration
in interface AmazonIVS
public GetStreamResult getStream(GetStreamRequest request)
AmazonIVS
Gets information about the active (live) stream on a specified channel.
getStream
in interface AmazonIVS
public GetStreamKeyResult getStreamKey(GetStreamKeyRequest request)
AmazonIVS
Gets stream-key information for a specified ARN.
getStreamKey
in interface AmazonIVS
public GetStreamSessionResult getStreamSession(GetStreamSessionRequest request)
AmazonIVS
Gets metadata on a specified stream.
getStreamSession
in interface AmazonIVS
public ImportPlaybackKeyPairResult importPlaybackKeyPair(ImportPlaybackKeyPairRequest request)
AmazonIVS
Imports the public portion of a new key pair and returns its arn
and fingerprint
. The
privateKey
can then be used to generate viewer authorization tokens, to grant viewers access to
private channels. For more information, see Setting Up Private Channels in
the Amazon IVS User Guide.
importPlaybackKeyPair
in interface AmazonIVS
public ListChannelsResult listChannels(ListChannelsRequest request)
AmazonIVS
Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).
listChannels
in interface AmazonIVS
public ListPlaybackKeyPairsResult listPlaybackKeyPairs(ListPlaybackKeyPairsRequest request)
AmazonIVS
Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
listPlaybackKeyPairs
in interface AmazonIVS
public ListPlaybackRestrictionPoliciesResult listPlaybackRestrictionPolicies(ListPlaybackRestrictionPoliciesRequest request)
AmazonIVS
Gets summary information about playback restriction policies.
listPlaybackRestrictionPolicies
in interface AmazonIVS
public ListRecordingConfigurationsResult listRecordingConfigurations(ListRecordingConfigurationsRequest request)
AmazonIVS
Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
listRecordingConfigurations
in interface AmazonIVS
public ListStreamKeysResult listStreamKeys(ListStreamKeysRequest request)
AmazonIVS
Gets summary information about stream keys for the specified channel.
listStreamKeys
in interface AmazonIVS
public ListStreamSessionsResult listStreamSessions(ListStreamSessionsRequest request)
AmazonIVS
Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.
listStreamSessions
in interface AmazonIVS
public ListStreamsResult listStreams(ListStreamsRequest request)
AmazonIVS
Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
listStreams
in interface AmazonIVS
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonIVS
Gets information about Amazon Web Services tags for the specified ARN.
listTagsForResource
in interface AmazonIVS
public PutMetadataResult putMetadata(PutMetadataRequest request)
AmazonIVS
Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.
putMetadata
in interface AmazonIVS
public StartViewerSessionRevocationResult startViewerSessionRevocation(StartViewerSessionRevocationRequest request)
AmazonIVS
Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and including that version. For instructions on associating a viewer ID with a viewer session, see Setting Up Private Channels.
startViewerSessionRevocation
in interface AmazonIVS
public StopStreamResult stopStream(StopStreamRequest request)
AmazonIVS
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.
stopStream
in interface AmazonIVS
public TagResourceResult tagResource(TagResourceRequest request)
AmazonIVS
Adds or updates tags for the Amazon Web Services resource with the specified ARN.
tagResource
in interface AmazonIVS
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonIVS
Removes tags from the resource with the specified ARN.
untagResource
in interface AmazonIVS
public UpdateChannelResult updateChannel(UpdateChannelRequest request)
AmazonIVS
Updates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the changes to take effect.
updateChannel
in interface AmazonIVS
public UpdatePlaybackRestrictionPolicyResult updatePlaybackRestrictionPolicy(UpdatePlaybackRestrictionPolicyRequest request)
AmazonIVS
Updates a specified playback restriction policy.
updatePlaybackRestrictionPolicy
in interface AmazonIVS
public void shutdown()
AmazonIVS
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonIVS
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.
getCachedResponseMetadata
in interface AmazonIVS
request
- The originally executed request.