@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface IvsAsyncClient extends SdkClient
builder()
method.
Introduction
The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an AWS EventBridge 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.
Recording configuration — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration. See the Recording Configuration 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, Playback Key Pairs, and Recording Configurations.
Authentication versus Authorization
Note the differences between these concepts:
Authentication is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.
Authorization is about granting permissions. You need to be authorized to view Amazon IVS private channels. (Private channels are channels that are enabled for "playback authorization.")
Authentication
All Amazon IVS API requests must be authenticated with a signature. The AWS Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS API directly, it’s your responsibility to sign the requests.
You generate a signature using valid AWS credentials that have permission to perform the requested action. For
example, you must sign PutMetadata requests with a signature generated from an IAM user account that has the
ivs:PutMetadata permission.
For more information:
Authentication and generating signatures — See Authenticating Requests (AWS Signature Version 4) in the AWS General Reference.
Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
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 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 Conflict Exception).
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 the active stream of the specified channel. A maximum of 5 requests per second per channel is 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.)
PlaybackKeyPair Endpoints
For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
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 private channels (channels enabled for playback authorization).
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 private 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.
RecordingConfiguration Endpoints
CreateRecordingConfiguration — Creates a new recording configuration, used to enable recording to Amazon S3.
GetRecordingConfiguration — Gets the recording-configuration metadata for the specified ARN.
ListRecordingConfigurations — Gets summary information about all recording configurations in your account, in the AWS region where the API request is processed.
DeleteRecordingConfiguration — Deletes the recording configuration for the specified ARN.
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 |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<BatchGetChannelResponse> |
batchGetChannel(BatchGetChannelRequest batchGetChannelRequest)
Performs GetChannel on multiple ARNs simultaneously.
|
default CompletableFuture<BatchGetChannelResponse> |
batchGetChannel(Consumer<BatchGetChannelRequest.Builder> batchGetChannelRequest)
Performs GetChannel on multiple ARNs simultaneously.
|
default CompletableFuture<BatchGetStreamKeyResponse> |
batchGetStreamKey(BatchGetStreamKeyRequest batchGetStreamKeyRequest)
Performs GetStreamKey on multiple ARNs simultaneously.
|
default CompletableFuture<BatchGetStreamKeyResponse> |
batchGetStreamKey(Consumer<BatchGetStreamKeyRequest.Builder> batchGetStreamKeyRequest)
Performs GetStreamKey on multiple ARNs simultaneously.
|
static IvsAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
IvsAsyncClient. |
static IvsAsyncClient |
create()
Create a
IvsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateChannelResponse> |
createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest)
Creates a new channel and an associated stream key to start streaming.
|
default CompletableFuture<CreateChannelResponse> |
createChannel(CreateChannelRequest createChannelRequest)
Creates a new channel and an associated stream key to start streaming.
|
default CompletableFuture<CreateRecordingConfigurationResponse> |
createRecordingConfiguration(Consumer<CreateRecordingConfigurationRequest.Builder> createRecordingConfigurationRequest)
Creates a new recording configuration, used to enable recording to Amazon S3.
|
default CompletableFuture<CreateRecordingConfigurationResponse> |
createRecordingConfiguration(CreateRecordingConfigurationRequest createRecordingConfigurationRequest)
Creates a new recording configuration, used to enable recording to Amazon S3.
|
default CompletableFuture<CreateStreamKeyResponse> |
createStreamKey(Consumer<CreateStreamKeyRequest.Builder> createStreamKeyRequest)
Creates a stream key, used to initiate a stream, for the specified channel ARN.
|
default CompletableFuture<CreateStreamKeyResponse> |
createStreamKey(CreateStreamKeyRequest createStreamKeyRequest)
Creates a stream key, used to initiate a stream, for the specified channel ARN.
|
default CompletableFuture<DeleteChannelResponse> |
deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest)
Deletes the specified channel and its associated stream keys.
|
default CompletableFuture<DeleteChannelResponse> |
deleteChannel(DeleteChannelRequest deleteChannelRequest)
Deletes the specified channel and its associated stream keys.
|
default CompletableFuture<DeletePlaybackKeyPairResponse> |
deletePlaybackKeyPair(Consumer<DeletePlaybackKeyPairRequest.Builder> deletePlaybackKeyPairRequest)
Deletes a specified authorization key pair.
|
default CompletableFuture<DeletePlaybackKeyPairResponse> |
deletePlaybackKeyPair(DeletePlaybackKeyPairRequest deletePlaybackKeyPairRequest)
Deletes a specified authorization key pair.
|
default CompletableFuture<DeleteRecordingConfigurationResponse> |
deleteRecordingConfiguration(Consumer<DeleteRecordingConfigurationRequest.Builder> deleteRecordingConfigurationRequest)
Deletes the recording configuration for the specified ARN.
|
default CompletableFuture<DeleteRecordingConfigurationResponse> |
deleteRecordingConfiguration(DeleteRecordingConfigurationRequest deleteRecordingConfigurationRequest)
Deletes the recording configuration for the specified ARN.
|
default CompletableFuture<DeleteStreamKeyResponse> |
deleteStreamKey(Consumer<DeleteStreamKeyRequest.Builder> deleteStreamKeyRequest)
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
|
default CompletableFuture<DeleteStreamKeyResponse> |
deleteStreamKey(DeleteStreamKeyRequest deleteStreamKeyRequest)
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
|
default CompletableFuture<GetChannelResponse> |
getChannel(Consumer<GetChannelRequest.Builder> getChannelRequest)
Gets the channel configuration for the specified channel ARN.
|
default CompletableFuture<GetChannelResponse> |
getChannel(GetChannelRequest getChannelRequest)
Gets the channel configuration for the specified channel ARN.
|
default CompletableFuture<GetPlaybackKeyPairResponse> |
getPlaybackKeyPair(Consumer<GetPlaybackKeyPairRequest.Builder> getPlaybackKeyPairRequest)
Gets a specified playback authorization key pair and returns the
arn and fingerprint. |
default CompletableFuture<GetPlaybackKeyPairResponse> |
getPlaybackKeyPair(GetPlaybackKeyPairRequest getPlaybackKeyPairRequest)
Gets a specified playback authorization key pair and returns the
arn and fingerprint. |
default CompletableFuture<GetRecordingConfigurationResponse> |
getRecordingConfiguration(Consumer<GetRecordingConfigurationRequest.Builder> getRecordingConfigurationRequest)
Gets the recording configuration for the specified ARN.
|
default CompletableFuture<GetRecordingConfigurationResponse> |
getRecordingConfiguration(GetRecordingConfigurationRequest getRecordingConfigurationRequest)
Gets the recording configuration for the specified ARN.
|
default CompletableFuture<GetStreamResponse> |
getStream(Consumer<GetStreamRequest.Builder> getStreamRequest)
Gets information about the active (live) stream on a specified channel.
|
default CompletableFuture<GetStreamResponse> |
getStream(GetStreamRequest getStreamRequest)
Gets information about the active (live) stream on a specified channel.
|
default CompletableFuture<GetStreamKeyResponse> |
getStreamKey(Consumer<GetStreamKeyRequest.Builder> getStreamKeyRequest)
Gets stream-key information for a specified ARN.
|
default CompletableFuture<GetStreamKeyResponse> |
getStreamKey(GetStreamKeyRequest getStreamKeyRequest)
Gets stream-key information for a specified ARN.
|
default CompletableFuture<ImportPlaybackKeyPairResponse> |
importPlaybackKeyPair(Consumer<ImportPlaybackKeyPairRequest.Builder> importPlaybackKeyPairRequest)
Imports the public portion of a new key pair and returns its
arn and fingerprint. |
default CompletableFuture<ImportPlaybackKeyPairResponse> |
importPlaybackKeyPair(ImportPlaybackKeyPairRequest importPlaybackKeyPairRequest)
Imports the public portion of a new key pair and returns its
arn and fingerprint. |
default CompletableFuture<ListChannelsResponse> |
listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
Gets summary information about all channels in your account, in the AWS region where the API request is
processed.
|
default CompletableFuture<ListChannelsResponse> |
listChannels(ListChannelsRequest listChannelsRequest)
Gets summary information about all channels in your account, in the AWS region where the API request is
processed.
|
default ListChannelsPublisher |
listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
Gets summary information about all channels in your account, in the AWS region where the API request is
processed.
|
default ListChannelsPublisher |
listChannelsPaginator(ListChannelsRequest listChannelsRequest)
Gets summary information about all channels in your account, in the AWS region where the API request is
processed.
|
default CompletableFuture<ListPlaybackKeyPairsResponse> |
listPlaybackKeyPairs(Consumer<ListPlaybackKeyPairsRequest.Builder> listPlaybackKeyPairsRequest)
Gets summary information about playback key pairs.
|
default CompletableFuture<ListPlaybackKeyPairsResponse> |
listPlaybackKeyPairs(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest)
Gets summary information about playback key pairs.
|
default ListPlaybackKeyPairsPublisher |
listPlaybackKeyPairsPaginator(Consumer<ListPlaybackKeyPairsRequest.Builder> listPlaybackKeyPairsRequest)
Gets summary information about playback key pairs.
|
default ListPlaybackKeyPairsPublisher |
listPlaybackKeyPairsPaginator(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest)
Gets summary information about playback key pairs.
|
default CompletableFuture<ListRecordingConfigurationsResponse> |
listRecordingConfigurations(Consumer<ListRecordingConfigurationsRequest.Builder> listRecordingConfigurationsRequest)
Gets summary information about all recording configurations in your account, in the AWS region where the API
request is processed.
|
default CompletableFuture<ListRecordingConfigurationsResponse> |
listRecordingConfigurations(ListRecordingConfigurationsRequest listRecordingConfigurationsRequest)
Gets summary information about all recording configurations in your account, in the AWS region where the API
request is processed.
|
default ListRecordingConfigurationsPublisher |
listRecordingConfigurationsPaginator(Consumer<ListRecordingConfigurationsRequest.Builder> listRecordingConfigurationsRequest)
Gets summary information about all recording configurations in your account, in the AWS region where the API
request is processed.
|
default ListRecordingConfigurationsPublisher |
listRecordingConfigurationsPaginator(ListRecordingConfigurationsRequest listRecordingConfigurationsRequest)
Gets summary information about all recording configurations in your account, in the AWS region where the API
request is processed.
|
default CompletableFuture<ListStreamKeysResponse> |
listStreamKeys(Consumer<ListStreamKeysRequest.Builder> listStreamKeysRequest)
Gets summary information about stream keys for the specified channel.
|
default CompletableFuture<ListStreamKeysResponse> |
listStreamKeys(ListStreamKeysRequest listStreamKeysRequest)
Gets summary information about stream keys for the specified channel.
|
default ListStreamKeysPublisher |
listStreamKeysPaginator(Consumer<ListStreamKeysRequest.Builder> listStreamKeysRequest)
Gets summary information about stream keys for the specified channel.
|
default ListStreamKeysPublisher |
listStreamKeysPaginator(ListStreamKeysRequest listStreamKeysRequest)
Gets summary information about stream keys for the specified channel.
|
default CompletableFuture<ListStreamsResponse> |
listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
Gets summary information about live streams in your account, in the AWS region where the API request is
processed.
|
default CompletableFuture<ListStreamsResponse> |
listStreams(ListStreamsRequest listStreamsRequest)
Gets summary information about live streams in your account, in the AWS region where the API request is
processed.
|
default ListStreamsPublisher |
listStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
Gets summary information about live streams in your account, in the AWS region where the API request is
processed.
|
default ListStreamsPublisher |
listStreamsPaginator(ListStreamsRequest listStreamsRequest)
Gets summary information about live streams in your account, in the AWS region where the API request is
processed.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
|
default ListTagsForResourcePublisher |
listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
|
default ListTagsForResourcePublisher |
listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
|
default CompletableFuture<PutMetadataResponse> |
putMetadata(Consumer<PutMetadataRequest.Builder> putMetadataRequest)
Inserts metadata into the active stream of the specified channel.
|
default CompletableFuture<PutMetadataResponse> |
putMetadata(PutMetadataRequest putMetadataRequest)
Inserts metadata into the active stream of the specified channel.
|
default CompletableFuture<StopStreamResponse> |
stopStream(Consumer<StopStreamRequest.Builder> stopStreamRequest)
Disconnects the incoming RTMPS stream for the specified channel.
|
default CompletableFuture<StopStreamResponse> |
stopStream(StopStreamRequest stopStreamRequest)
Disconnects the incoming RTMPS stream for the specified channel.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds or updates tags for the AWS resource with the specified ARN.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Adds or updates tags for the AWS resource with the specified ARN.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from the resource with the specified ARN.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the resource with the specified ARN.
|
default CompletableFuture<UpdateChannelResponse> |
updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest)
Updates a channel's configuration.
|
default CompletableFuture<UpdateChannelResponse> |
updateChannel(UpdateChannelRequest updateChannelRequest)
Updates a channel's configuration.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static IvsAsyncClient create()
IvsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static IvsAsyncClientBuilder builder()
IvsAsyncClient.default CompletableFuture<BatchGetChannelResponse> batchGetChannel(BatchGetChannelRequest batchGetChannelRequest)
Performs GetChannel on multiple ARNs simultaneously.
batchGetChannelRequest - default CompletableFuture<BatchGetChannelResponse> batchGetChannel(Consumer<BatchGetChannelRequest.Builder> batchGetChannelRequest)
Performs GetChannel on multiple ARNs simultaneously.
This is a convenience which creates an instance of the BatchGetChannelRequest.Builder avoiding the need
to create one manually via BatchGetChannelRequest.builder()
batchGetChannelRequest - A Consumer that will call methods on BatchGetChannelRequest.Builder to create a request.default CompletableFuture<BatchGetStreamKeyResponse> batchGetStreamKey(BatchGetStreamKeyRequest batchGetStreamKeyRequest)
Performs GetStreamKey on multiple ARNs simultaneously.
batchGetStreamKeyRequest - default CompletableFuture<BatchGetStreamKeyResponse> batchGetStreamKey(Consumer<BatchGetStreamKeyRequest.Builder> batchGetStreamKeyRequest)
Performs GetStreamKey on multiple ARNs simultaneously.
This is a convenience which creates an instance of the BatchGetStreamKeyRequest.Builder avoiding the need
to create one manually via BatchGetStreamKeyRequest.builder()
batchGetStreamKeyRequest - A Consumer that will call methods on BatchGetStreamKeyRequest.Builder to create a request.default CompletableFuture<CreateChannelResponse> createChannel(CreateChannelRequest createChannelRequest)
Creates a new channel and an associated stream key to start streaming.
createChannelRequest - default CompletableFuture<CreateChannelResponse> createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest)
Creates a new channel and an associated stream key to start streaming.
This is a convenience which creates an instance of the CreateChannelRequest.Builder avoiding the need to
create one manually via CreateChannelRequest.builder()
createChannelRequest - A Consumer that will call methods on CreateChannelRequest.Builder to create a request.default CompletableFuture<CreateRecordingConfigurationResponse> createRecordingConfiguration(CreateRecordingConfigurationRequest createRecordingConfigurationRequest)
Creates a new recording configuration, used to enable recording to Amazon S3.
Known issue: In the us-east-1 region, if you use the AWS 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.
createRecordingConfigurationRequest - default CompletableFuture<CreateRecordingConfigurationResponse> createRecordingConfiguration(Consumer<CreateRecordingConfigurationRequest.Builder> createRecordingConfigurationRequest)
Creates a new recording configuration, used to enable recording to Amazon S3.
Known issue: In the us-east-1 region, if you use the AWS 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.
This is a convenience which creates an instance of the CreateRecordingConfigurationRequest.Builder
avoiding the need to create one manually via CreateRecordingConfigurationRequest.builder()
createRecordingConfigurationRequest - A Consumer that will call methods on CreateRecordingConfigurationRequest.Builder to create
a request.default CompletableFuture<CreateStreamKeyResponse> 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 - default CompletableFuture<CreateStreamKeyResponse> createStreamKey(Consumer<CreateStreamKeyRequest.Builder> 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.
This is a convenience which creates an instance of the CreateStreamKeyRequest.Builder avoiding the need
to create one manually via CreateStreamKeyRequest.builder()
createStreamKeyRequest - A Consumer that will call methods on CreateStreamKeyRequest.Builder to create a request.default CompletableFuture<DeleteChannelResponse> deleteChannel(DeleteChannelRequest deleteChannelRequest)
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 was changed from Live to Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)
deleteChannelRequest - default CompletableFuture<DeleteChannelResponse> deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest)
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 was changed from Live to Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)
This is a convenience which creates an instance of the DeleteChannelRequest.Builder avoiding the need to
create one manually via DeleteChannelRequest.builder()
deleteChannelRequest - A Consumer that will call methods on DeleteChannelRequest.Builder to create a request.default CompletableFuture<DeletePlaybackKeyPairResponse> deletePlaybackKeyPair(DeletePlaybackKeyPairRequest deletePlaybackKeyPairRequest)
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.
deletePlaybackKeyPairRequest - default CompletableFuture<DeletePlaybackKeyPairResponse> deletePlaybackKeyPair(Consumer<DeletePlaybackKeyPairRequest.Builder> deletePlaybackKeyPairRequest)
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.
This is a convenience which creates an instance of the DeletePlaybackKeyPairRequest.Builder avoiding the
need to create one manually via DeletePlaybackKeyPairRequest.builder()
deletePlaybackKeyPairRequest - A Consumer that will call methods on DeletePlaybackKeyPairRequest.Builder to create a
request.default CompletableFuture<DeleteRecordingConfigurationResponse> deleteRecordingConfiguration(DeleteRecordingConfigurationRequest deleteRecordingConfigurationRequest)
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.
deleteRecordingConfigurationRequest - default CompletableFuture<DeleteRecordingConfigurationResponse> deleteRecordingConfiguration(Consumer<DeleteRecordingConfigurationRequest.Builder> deleteRecordingConfigurationRequest)
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.
This is a convenience which creates an instance of the DeleteRecordingConfigurationRequest.Builder
avoiding the need to create one manually via DeleteRecordingConfigurationRequest.builder()
deleteRecordingConfigurationRequest - A Consumer that will call methods on DeleteRecordingConfigurationRequest.Builder to create
a request.default CompletableFuture<DeleteStreamKeyResponse> deleteStreamKey(DeleteStreamKeyRequest deleteStreamKeyRequest)
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
deleteStreamKeyRequest - default CompletableFuture<DeleteStreamKeyResponse> deleteStreamKey(Consumer<DeleteStreamKeyRequest.Builder> deleteStreamKeyRequest)
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
This is a convenience which creates an instance of the DeleteStreamKeyRequest.Builder avoiding the need
to create one manually via DeleteStreamKeyRequest.builder()
deleteStreamKeyRequest - A Consumer that will call methods on DeleteStreamKeyRequest.Builder to create a request.default CompletableFuture<GetChannelResponse> getChannel(GetChannelRequest getChannelRequest)
Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
getChannelRequest - default CompletableFuture<GetChannelResponse> getChannel(Consumer<GetChannelRequest.Builder> getChannelRequest)
Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
This is a convenience which creates an instance of the GetChannelRequest.Builder avoiding the need to
create one manually via GetChannelRequest.builder()
getChannelRequest - A Consumer that will call methods on GetChannelRequest.Builder to create a request.default CompletableFuture<GetPlaybackKeyPairResponse> 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 private channels. For more information, see Setting Up Private Channels in
the Amazon IVS User Guide.
getPlaybackKeyPairRequest - default CompletableFuture<GetPlaybackKeyPairResponse> getPlaybackKeyPair(Consumer<GetPlaybackKeyPairRequest.Builder> 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 private channels. For more information, see Setting Up Private Channels in
the Amazon IVS User Guide.
This is a convenience which creates an instance of the GetPlaybackKeyPairRequest.Builder avoiding the
need to create one manually via GetPlaybackKeyPairRequest.builder()
getPlaybackKeyPairRequest - A Consumer that will call methods on GetPlaybackKeyPairRequest.Builder to create a
request.default CompletableFuture<GetRecordingConfigurationResponse> getRecordingConfiguration(GetRecordingConfigurationRequest getRecordingConfigurationRequest)
Gets the recording configuration for the specified ARN.
getRecordingConfigurationRequest - default CompletableFuture<GetRecordingConfigurationResponse> getRecordingConfiguration(Consumer<GetRecordingConfigurationRequest.Builder> getRecordingConfigurationRequest)
Gets the recording configuration for the specified ARN.
This is a convenience which creates an instance of the GetRecordingConfigurationRequest.Builder avoiding
the need to create one manually via GetRecordingConfigurationRequest.builder()
getRecordingConfigurationRequest - A Consumer that will call methods on GetRecordingConfigurationRequest.Builder to create a
request.default CompletableFuture<GetStreamResponse> getStream(GetStreamRequest getStreamRequest)
Gets information about the active (live) stream on a specified channel.
getStreamRequest - default CompletableFuture<GetStreamResponse> getStream(Consumer<GetStreamRequest.Builder> getStreamRequest)
Gets information about the active (live) stream on a specified channel.
This is a convenience which creates an instance of the GetStreamRequest.Builder avoiding the need to
create one manually via GetStreamRequest.builder()
getStreamRequest - A Consumer that will call methods on GetStreamRequest.Builder to create a request.default CompletableFuture<GetStreamKeyResponse> getStreamKey(GetStreamKeyRequest getStreamKeyRequest)
Gets stream-key information for a specified ARN.
getStreamKeyRequest - default CompletableFuture<GetStreamKeyResponse> getStreamKey(Consumer<GetStreamKeyRequest.Builder> getStreamKeyRequest)
Gets stream-key information for a specified ARN.
This is a convenience which creates an instance of the GetStreamKeyRequest.Builder avoiding the need to
create one manually via GetStreamKeyRequest.builder()
getStreamKeyRequest - A Consumer that will call methods on GetStreamKeyRequest.Builder to create a request.default CompletableFuture<ImportPlaybackKeyPairResponse> 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
private channels. For more information, see Setting Up Private Channels in
the Amazon IVS User Guide.
importPlaybackKeyPairRequest - default CompletableFuture<ImportPlaybackKeyPairResponse> importPlaybackKeyPair(Consumer<ImportPlaybackKeyPairRequest.Builder> 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
private channels. For more information, see Setting Up Private Channels in
the Amazon IVS User Guide.
This is a convenience which creates an instance of the ImportPlaybackKeyPairRequest.Builder avoiding the
need to create one manually via ImportPlaybackKeyPairRequest.builder()
importPlaybackKeyPairRequest - A Consumer that will call methods on ImportPlaybackKeyPairRequest.Builder to create a
request.default CompletableFuture<ListChannelsResponse> 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 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).
listChannelsRequest - default CompletableFuture<ListChannelsResponse> listChannels(Consumer<ListChannelsRequest.Builder> 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 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).
This is a convenience which creates an instance of the ListChannelsRequest.Builder avoiding the need to
create one manually via ListChannelsRequest.builder()
listChannelsRequest - A Consumer that will call methods on ListChannelsRequest.Builder to create a request.default ListChannelsPublisher listChannelsPaginator(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 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).
This is a variant of listChannels(software.amazon.awssdk.services.ivs.model.ListChannelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivs.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivs.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivs.model.ListChannelsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivs.model.ListChannelsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannels(software.amazon.awssdk.services.ivs.model.ListChannelsRequest) operation.
listChannelsRequest - default ListChannelsPublisher listChannelsPaginator(Consumer<ListChannelsRequest.Builder> 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 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).
This is a variant of listChannels(software.amazon.awssdk.services.ivs.model.ListChannelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivs.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivs.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivs.model.ListChannelsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivs.model.ListChannelsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannels(software.amazon.awssdk.services.ivs.model.ListChannelsRequest) operation.
This is a convenience which creates an instance of the ListChannelsRequest.Builder avoiding the need to
create one manually via ListChannelsRequest.builder()
listChannelsRequest - A Consumer that will call methods on ListChannelsRequest.Builder to create a request.default CompletableFuture<ListPlaybackKeyPairsResponse> listPlaybackKeyPairs(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest)
Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
listPlaybackKeyPairsRequest - default CompletableFuture<ListPlaybackKeyPairsResponse> listPlaybackKeyPairs(Consumer<ListPlaybackKeyPairsRequest.Builder> listPlaybackKeyPairsRequest)
Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
This is a convenience which creates an instance of the ListPlaybackKeyPairsRequest.Builder avoiding the
need to create one manually via ListPlaybackKeyPairsRequest.builder()
listPlaybackKeyPairsRequest - A Consumer that will call methods on ListPlaybackKeyPairsRequest.Builder to create a
request.default ListPlaybackKeyPairsPublisher listPlaybackKeyPairsPaginator(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest)
Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
This is a variant of
listPlaybackKeyPairs(software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivs.paginators.ListPlaybackKeyPairsPublisher publisher = client.listPlaybackKeyPairsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivs.paginators.ListPlaybackKeyPairsPublisher publisher = client.listPlaybackKeyPairsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPlaybackKeyPairs(software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsRequest)
operation.
listPlaybackKeyPairsRequest - default ListPlaybackKeyPairsPublisher listPlaybackKeyPairsPaginator(Consumer<ListPlaybackKeyPairsRequest.Builder> listPlaybackKeyPairsRequest)
Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
This is a variant of
listPlaybackKeyPairs(software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivs.paginators.ListPlaybackKeyPairsPublisher publisher = client.listPlaybackKeyPairsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivs.paginators.ListPlaybackKeyPairsPublisher publisher = client.listPlaybackKeyPairsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPlaybackKeyPairs(software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsRequest)
operation.
This is a convenience which creates an instance of the ListPlaybackKeyPairsRequest.Builder avoiding the
need to create one manually via ListPlaybackKeyPairsRequest.builder()
listPlaybackKeyPairsRequest - A Consumer that will call methods on ListPlaybackKeyPairsRequest.Builder to create a
request.default CompletableFuture<ListRecordingConfigurationsResponse> listRecordingConfigurations(ListRecordingConfigurationsRequest listRecordingConfigurationsRequest)
Gets summary information about all recording configurations in your account, in the AWS region where the API request is processed.
listRecordingConfigurationsRequest - default CompletableFuture<ListRecordingConfigurationsResponse> listRecordingConfigurations(Consumer<ListRecordingConfigurationsRequest.Builder> listRecordingConfigurationsRequest)
Gets summary information about all recording configurations in your account, in the AWS region where the API request is processed.
This is a convenience which creates an instance of the ListRecordingConfigurationsRequest.Builder
avoiding the need to create one manually via ListRecordingConfigurationsRequest.builder()
listRecordingConfigurationsRequest - A Consumer that will call methods on ListRecordingConfigurationsRequest.Builder to create
a request.default ListRecordingConfigurationsPublisher listRecordingConfigurationsPaginator(ListRecordingConfigurationsRequest listRecordingConfigurationsRequest)
Gets summary information about all recording configurations in your account, in the AWS region where the API request is processed.
This is a variant of
listRecordingConfigurations(software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivs.paginators.ListRecordingConfigurationsPublisher publisher = client.listRecordingConfigurationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivs.paginators.ListRecordingConfigurationsPublisher publisher = client.listRecordingConfigurationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRecordingConfigurations(software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsRequest)
operation.
listRecordingConfigurationsRequest - default ListRecordingConfigurationsPublisher listRecordingConfigurationsPaginator(Consumer<ListRecordingConfigurationsRequest.Builder> listRecordingConfigurationsRequest)
Gets summary information about all recording configurations in your account, in the AWS region where the API request is processed.
This is a variant of
listRecordingConfigurations(software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivs.paginators.ListRecordingConfigurationsPublisher publisher = client.listRecordingConfigurationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivs.paginators.ListRecordingConfigurationsPublisher publisher = client.listRecordingConfigurationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRecordingConfigurations(software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsRequest)
operation.
This is a convenience which creates an instance of the ListRecordingConfigurationsRequest.Builder
avoiding the need to create one manually via ListRecordingConfigurationsRequest.builder()
listRecordingConfigurationsRequest - A Consumer that will call methods on ListRecordingConfigurationsRequest.Builder to create
a request.default CompletableFuture<ListStreamKeysResponse> listStreamKeys(ListStreamKeysRequest listStreamKeysRequest)
Gets summary information about stream keys for the specified channel.
listStreamKeysRequest - default CompletableFuture<ListStreamKeysResponse> listStreamKeys(Consumer<ListStreamKeysRequest.Builder> listStreamKeysRequest)
Gets summary information about stream keys for the specified channel.
This is a convenience which creates an instance of the ListStreamKeysRequest.Builder avoiding the need to
create one manually via ListStreamKeysRequest.builder()
listStreamKeysRequest - A Consumer that will call methods on ListStreamKeysRequest.Builder to create a request.default ListStreamKeysPublisher listStreamKeysPaginator(ListStreamKeysRequest listStreamKeysRequest)
Gets summary information about stream keys for the specified channel.
This is a variant of listStreamKeys(software.amazon.awssdk.services.ivs.model.ListStreamKeysRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivs.paginators.ListStreamKeysPublisher publisher = client.listStreamKeysPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivs.paginators.ListStreamKeysPublisher publisher = client.listStreamKeysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivs.model.ListStreamKeysResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivs.model.ListStreamKeysResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreamKeys(software.amazon.awssdk.services.ivs.model.ListStreamKeysRequest) operation.
listStreamKeysRequest - default ListStreamKeysPublisher listStreamKeysPaginator(Consumer<ListStreamKeysRequest.Builder> listStreamKeysRequest)
Gets summary information about stream keys for the specified channel.
This is a variant of listStreamKeys(software.amazon.awssdk.services.ivs.model.ListStreamKeysRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivs.paginators.ListStreamKeysPublisher publisher = client.listStreamKeysPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivs.paginators.ListStreamKeysPublisher publisher = client.listStreamKeysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivs.model.ListStreamKeysResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivs.model.ListStreamKeysResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreamKeys(software.amazon.awssdk.services.ivs.model.ListStreamKeysRequest) operation.
This is a convenience which creates an instance of the ListStreamKeysRequest.Builder avoiding the need to
create one manually via ListStreamKeysRequest.builder()
listStreamKeysRequest - A Consumer that will call methods on ListStreamKeysRequest.Builder to create a request.default CompletableFuture<ListStreamsResponse> listStreams(ListStreamsRequest listStreamsRequest)
Gets summary information about live streams in your account, in the AWS region where the API request is processed.
listStreamsRequest - default CompletableFuture<ListStreamsResponse> listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
Gets summary information about live streams in your account, in the AWS region where the API request is processed.
This is a convenience which creates an instance of the ListStreamsRequest.Builder avoiding the need to
create one manually via ListStreamsRequest.builder()
listStreamsRequest - A Consumer that will call methods on ListStreamsRequest.Builder to create a request.default ListStreamsPublisher listStreamsPaginator(ListStreamsRequest listStreamsRequest)
Gets summary information about live streams in your account, in the AWS region where the API request is processed.
This is a variant of listStreams(software.amazon.awssdk.services.ivs.model.ListStreamsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivs.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivs.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivs.model.ListStreamsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivs.model.ListStreamsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.ivs.model.ListStreamsRequest) operation.
listStreamsRequest - default ListStreamsPublisher listStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
Gets summary information about live streams in your account, in the AWS region where the API request is processed.
This is a variant of listStreams(software.amazon.awssdk.services.ivs.model.ListStreamsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivs.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivs.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivs.model.ListStreamsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivs.model.ListStreamsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.ivs.model.ListStreamsRequest) operation.
This is a convenience which creates an instance of the ListStreamsRequest.Builder avoiding the need to
create one manually via ListStreamsRequest.builder()
listStreamsRequest - A Consumer that will call methods on ListStreamsRequest.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.ivs.model.ListTagsForResourceRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivs.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivs.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivs.model.ListTagsForResourceResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivs.model.ListTagsForResourceResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.ivs.model.ListTagsForResourceRequest) operation.
listTagsForResourceRequest - default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.ivs.model.ListTagsForResourceRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ivs.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ivs.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivs.model.ListTagsForResourceResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ivs.model.ListTagsForResourceResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.ivs.model.ListTagsForResourceRequest) operation.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<PutMetadataResponse> putMetadata(PutMetadataRequest putMetadataRequest)
Inserts metadata into the active stream of the specified channel. A maximum of 5 requests per second per channel is 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.) Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.
putMetadataRequest - default CompletableFuture<PutMetadataResponse> putMetadata(Consumer<PutMetadataRequest.Builder> putMetadataRequest)
Inserts metadata into the active stream of the specified channel. A maximum of 5 requests per second per channel is 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.) Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.
This is a convenience which creates an instance of the PutMetadataRequest.Builder avoiding the need to
create one manually via PutMetadataRequest.builder()
putMetadataRequest - A Consumer that will call methods on PutMetadataRequest.Builder to create a request.default CompletableFuture<StopStreamResponse> 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 - default CompletableFuture<StopStreamResponse> stopStream(Consumer<StopStreamRequest.Builder> 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.
This is a convenience which creates an instance of the StopStreamRequest.Builder avoiding the need to
create one manually via StopStreamRequest.builder()
stopStreamRequest - A Consumer that will call methods on StopStreamRequest.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds or updates tags for the AWS resource with the specified ARN.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds or updates tags for the AWS resource with the specified ARN.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the resource with the specified ARN.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from the resource with the specified ARN.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateChannelResponse> 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 - default CompletableFuture<UpdateChannelResponse> updateChannel(Consumer<UpdateChannelRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateChannelRequest.Builder avoiding the need to
create one manually via UpdateChannelRequest.builder()
updateChannelRequest - A Consumer that will call methods on UpdateChannelRequest.Builder to create a request.