Interface IvsAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Introduction
The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
The API is an Amazon Web Services regional service. For a list of supported regions and Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the Amazon Web Services General Reference.
All API request parameters and URLs are case sensitive.
For a summary of notable documentation changes in each release, see Document History.
Allowed Header Values
-
Accept:
application/json -
Accept-Encoding:
gzip, deflate -
Content-Type:
application/json
Resources
The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS):
-
Channel — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream. See the Channel endpoints for more information.
-
Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. See the StreamKey endpoints for more information. Treat the stream key like a secret, since it allows anyone to stream to the channel.
-
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.
-
Playback restriction policy — Restricts playback by countries and/or origin sites. See the Playback Restriction Policy endpoints for more information.
Tagging
A tag is a metadata label that you assign to an Amazon Web Services 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 Amazon Web
Services Resources for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your Amazon Web Services 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.
At most 50 tags can be applied to a resource.
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. Your IAM roles need to have permissions for Amazon IVS API requests. In addition, authorization is needed 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 Amazon Web Services 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 Amazon Web Services credentials that have permission to perform the requested
action. For example, you must sign PutMetadata requests with a signature generated from a user account that has the
ivs:PutMetadata
permission.
For more information:
-
Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.
-
Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
Amazon Resource Names (ARNs)
ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the AWS General Reference.
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.
-
BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously.
-
ListChannels — 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 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.
Playback Restriction Policy Endpoints
-
CreatePlaybackRestrictionPolicy — Creates a new playback restriction policy, for constraining playback by countries and/or origins.
-
DeletePlaybackRestrictionPolicy — Deletes the specified playback restriction policy
-
GetPlaybackRestrictionPolicy — Gets the specified playback restriction policy.
-
ListPlaybackRestrictionPolicies — Gets summary information about playback restriction policies.
-
UpdatePlaybackRestrictionPolicy — Updates a specified playback restriction policy.
Private Channel 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
andfingerprint
. TheprivateKey
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
andfingerprint
. TheprivateKey
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
. -
StartViewerSessionRevocation — 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.
-
BatchStartViewerSessionRevocation — Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
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 Amazon Web Services region where the API request is processed.
-
DeleteRecordingConfiguration — Deletes the recording configuration for the specified ARN.
Stream Endpoints
-
GetStream — Gets information about the active (live) stream on a specified channel.
-
GetStreamSession — Gets metadata on a specified stream.
-
ListStreams — Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
-
ListStreamSessions — 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.
-
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. 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.
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.
Amazon Web Services Tags Endpoints
-
TagResource — Adds or updates tags for the Amazon Web Services resource with the specified ARN.
-
UntagResource — Removes tags from the resource with the specified ARN.
-
ListTagsForResource — Gets information about Amazon Web Services tags for the specified ARN.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault CompletableFuture
<BatchGetChannelResponse> batchGetChannel
(Consumer<BatchGetChannelRequest.Builder> batchGetChannelRequest) Performs GetChannel on multiple ARNs simultaneously.default CompletableFuture
<BatchGetChannelResponse> batchGetChannel
(BatchGetChannelRequest batchGetChannelRequest) Performs GetChannel on multiple ARNs simultaneously.batchGetStreamKey
(Consumer<BatchGetStreamKeyRequest.Builder> batchGetStreamKeyRequest) Performs GetStreamKey on multiple ARNs simultaneously.batchGetStreamKey
(BatchGetStreamKeyRequest batchGetStreamKeyRequest) Performs GetStreamKey on multiple ARNs simultaneously.batchStartViewerSessionRevocation
(Consumer<BatchStartViewerSessionRevocationRequest.Builder> batchStartViewerSessionRevocationRequest) Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.batchStartViewerSessionRevocation
(BatchStartViewerSessionRevocationRequest batchStartViewerSessionRevocationRequest) Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.static IvsAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aIvsAsyncClient
.static IvsAsyncClient
create()
Create aIvsAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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.createPlaybackRestrictionPolicy
(Consumer<CreatePlaybackRestrictionPolicyRequest.Builder> createPlaybackRestrictionPolicyRequest) Creates a new playback restriction policy, for constraining playback by countries and/or origins.createPlaybackRestrictionPolicy
(CreatePlaybackRestrictionPolicyRequest createPlaybackRestrictionPolicyRequest) Creates a new playback restriction policy, for constraining playback by countries and/or origins.createRecordingConfiguration
(Consumer<CreateRecordingConfigurationRequest.Builder> createRecordingConfigurationRequest) Creates a new recording configuration, used to enable recording to Amazon S3.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.deletePlaybackKeyPair
(Consumer<DeletePlaybackKeyPairRequest.Builder> deletePlaybackKeyPairRequest) Deletes a specified authorization key pair.deletePlaybackKeyPair
(DeletePlaybackKeyPairRequest deletePlaybackKeyPairRequest) Deletes a specified authorization key pair.deletePlaybackRestrictionPolicy
(Consumer<DeletePlaybackRestrictionPolicyRequest.Builder> deletePlaybackRestrictionPolicyRequest) Deletes the specified playback restriction policy.deletePlaybackRestrictionPolicy
(DeletePlaybackRestrictionPolicyRequest deletePlaybackRestrictionPolicyRequest) Deletes the specified playback restriction policy.deleteRecordingConfiguration
(Consumer<DeleteRecordingConfigurationRequest.Builder> deleteRecordingConfigurationRequest) Deletes the recording configuration for the specified ARN.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.getPlaybackKeyPair
(Consumer<GetPlaybackKeyPairRequest.Builder> getPlaybackKeyPairRequest) Gets a specified playback authorization key pair and returns thearn
andfingerprint
.getPlaybackKeyPair
(GetPlaybackKeyPairRequest getPlaybackKeyPairRequest) Gets a specified playback authorization key pair and returns thearn
andfingerprint
.getPlaybackRestrictionPolicy
(Consumer<GetPlaybackRestrictionPolicyRequest.Builder> getPlaybackRestrictionPolicyRequest) Gets the specified playback restriction policy.getPlaybackRestrictionPolicy
(GetPlaybackRestrictionPolicyRequest getPlaybackRestrictionPolicyRequest) Gets the specified playback restriction policy.getRecordingConfiguration
(Consumer<GetRecordingConfigurationRequest.Builder> getRecordingConfigurationRequest) Gets the recording configuration for the specified ARN.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.getStreamSession
(Consumer<GetStreamSessionRequest.Builder> getStreamSessionRequest) Gets metadata on a specified stream.getStreamSession
(GetStreamSessionRequest getStreamSessionRequest) Gets metadata on a specified stream.importPlaybackKeyPair
(Consumer<ImportPlaybackKeyPairRequest.Builder> importPlaybackKeyPairRequest) Imports the public portion of a new key pair and returns itsarn
andfingerprint
.importPlaybackKeyPair
(ImportPlaybackKeyPairRequest importPlaybackKeyPairRequest) Imports the public portion of a new key pair and returns itsarn
andfingerprint
.default CompletableFuture
<ListChannelsResponse> listChannels
(Consumer<ListChannelsRequest.Builder> listChannelsRequest) Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed.default CompletableFuture
<ListChannelsResponse> listChannels
(ListChannelsRequest listChannelsRequest) Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed.default ListChannelsPublisher
listChannelsPaginator
(Consumer<ListChannelsRequest.Builder> listChannelsRequest) This is a variant oflistChannels(software.amazon.awssdk.services.ivs.model.ListChannelsRequest)
operation.default ListChannelsPublisher
listChannelsPaginator
(ListChannelsRequest listChannelsRequest) This is a variant oflistChannels(software.amazon.awssdk.services.ivs.model.ListChannelsRequest)
operation.listPlaybackKeyPairs
(Consumer<ListPlaybackKeyPairsRequest.Builder> listPlaybackKeyPairsRequest) Gets summary information about playback key pairs.listPlaybackKeyPairs
(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest) Gets summary information about playback key pairs.default ListPlaybackKeyPairsPublisher
listPlaybackKeyPairsPaginator
(Consumer<ListPlaybackKeyPairsRequest.Builder> listPlaybackKeyPairsRequest) This is a variant oflistPlaybackKeyPairs(software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsRequest)
operation.default ListPlaybackKeyPairsPublisher
listPlaybackKeyPairsPaginator
(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest) This is a variant oflistPlaybackKeyPairs(software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsRequest)
operation.listPlaybackRestrictionPolicies
(Consumer<ListPlaybackRestrictionPoliciesRequest.Builder> listPlaybackRestrictionPoliciesRequest) Gets summary information about playback restriction policies.listPlaybackRestrictionPolicies
(ListPlaybackRestrictionPoliciesRequest listPlaybackRestrictionPoliciesRequest) Gets summary information about playback restriction policies.listPlaybackRestrictionPoliciesPaginator
(Consumer<ListPlaybackRestrictionPoliciesRequest.Builder> listPlaybackRestrictionPoliciesRequest) This is a variant oflistPlaybackRestrictionPolicies(software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesRequest)
operation.listPlaybackRestrictionPoliciesPaginator
(ListPlaybackRestrictionPoliciesRequest listPlaybackRestrictionPoliciesRequest) This is a variant oflistPlaybackRestrictionPolicies(software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesRequest)
operation.listRecordingConfigurations
(Consumer<ListRecordingConfigurationsRequest.Builder> listRecordingConfigurationsRequest) Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.listRecordingConfigurations
(ListRecordingConfigurationsRequest listRecordingConfigurationsRequest) Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.listRecordingConfigurationsPaginator
(Consumer<ListRecordingConfigurationsRequest.Builder> listRecordingConfigurationsRequest) This is a variant oflistRecordingConfigurations(software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsRequest)
operation.listRecordingConfigurationsPaginator
(ListRecordingConfigurationsRequest listRecordingConfigurationsRequest) This is a variant oflistRecordingConfigurations(software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsRequest)
operation.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) This is a variant oflistStreamKeys(software.amazon.awssdk.services.ivs.model.ListStreamKeysRequest)
operation.default ListStreamKeysPublisher
listStreamKeysPaginator
(ListStreamKeysRequest listStreamKeysRequest) This is a variant oflistStreamKeys(software.amazon.awssdk.services.ivs.model.ListStreamKeysRequest)
operation.default CompletableFuture
<ListStreamsResponse> listStreams
(Consumer<ListStreamsRequest.Builder> listStreamsRequest) Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.default CompletableFuture
<ListStreamsResponse> listStreams
(ListStreamsRequest listStreamsRequest) Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.listStreamSessions
(Consumer<ListStreamSessionsRequest.Builder> listStreamSessionsRequest) 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
(ListStreamSessionsRequest listStreamSessionsRequest) 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.default ListStreamSessionsPublisher
listStreamSessionsPaginator
(Consumer<ListStreamSessionsRequest.Builder> listStreamSessionsRequest) This is a variant oflistStreamSessions(software.amazon.awssdk.services.ivs.model.ListStreamSessionsRequest)
operation.default ListStreamSessionsPublisher
listStreamSessionsPaginator
(ListStreamSessionsRequest listStreamSessionsRequest) This is a variant oflistStreamSessions(software.amazon.awssdk.services.ivs.model.ListStreamSessionsRequest)
operation.default ListStreamsPublisher
listStreamsPaginator
(Consumer<ListStreamsRequest.Builder> listStreamsRequest) This is a variant oflistStreams(software.amazon.awssdk.services.ivs.model.ListStreamsRequest)
operation.default ListStreamsPublisher
listStreamsPaginator
(ListStreamsRequest listStreamsRequest) This is a variant oflistStreams(software.amazon.awssdk.services.ivs.model.ListStreamsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets information about Amazon Web Services tags for the specified ARN.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Gets information about Amazon Web Services 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 IvsServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartViewerSessionRevocation
(Consumer<StartViewerSessionRevocationRequest.Builder> startViewerSessionRevocationRequest) Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID.startViewerSessionRevocation
(StartViewerSessionRevocationRequest startViewerSessionRevocationRequest) Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID.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 Amazon Web Services resource with the specified ARN.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds or updates tags for the Amazon Web Services 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.updatePlaybackRestrictionPolicy
(Consumer<UpdatePlaybackRestrictionPolicyRequest.Builder> updatePlaybackRestrictionPolicyRequest) Updates a specified playback restriction policy.updatePlaybackRestrictionPolicy
(UpdatePlaybackRestrictionPolicyRequest updatePlaybackRestrictionPolicyRequest) Updates a specified playback restriction policy.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchGetChannel
default CompletableFuture<BatchGetChannelResponse> batchGetChannel(BatchGetChannelRequest batchGetChannelRequest) Performs GetChannel on multiple ARNs simultaneously.
- Parameters:
batchGetChannelRequest
-- Returns:
- A Java Future containing the result of the BatchGetChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetChannel
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 viaBatchGetChannelRequest.builder()
- Parameters:
batchGetChannelRequest
- AConsumer
that will call methods onBatchGetChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchGetChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetStreamKey
default CompletableFuture<BatchGetStreamKeyResponse> batchGetStreamKey(BatchGetStreamKeyRequest batchGetStreamKeyRequest) Performs GetStreamKey on multiple ARNs simultaneously.
- Parameters:
batchGetStreamKeyRequest
-- Returns:
- A Java Future containing the result of the BatchGetStreamKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetStreamKey
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 viaBatchGetStreamKeyRequest.builder()
- Parameters:
batchGetStreamKeyRequest
- AConsumer
that will call methods onBatchGetStreamKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchGetStreamKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchStartViewerSessionRevocation
default CompletableFuture<BatchStartViewerSessionRevocationResponse> batchStartViewerSessionRevocation(BatchStartViewerSessionRevocationRequest batchStartViewerSessionRevocationRequest) Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
- Parameters:
batchStartViewerSessionRevocationRequest
-- Returns:
- A Java Future containing the result of the BatchStartViewerSessionRevocation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- PendingVerificationException
- ThrottlingException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchStartViewerSessionRevocation
default CompletableFuture<BatchStartViewerSessionRevocationResponse> batchStartViewerSessionRevocation(Consumer<BatchStartViewerSessionRevocationRequest.Builder> batchStartViewerSessionRevocationRequest) Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
This is a convenience which creates an instance of the
BatchStartViewerSessionRevocationRequest.Builder
avoiding the need to create one manually viaBatchStartViewerSessionRevocationRequest.builder()
- Parameters:
batchStartViewerSessionRevocationRequest
- AConsumer
that will call methods onBatchStartViewerSessionRevocationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchStartViewerSessionRevocation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- PendingVerificationException
- ThrottlingException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createChannel
default CompletableFuture<CreateChannelResponse> createChannel(CreateChannelRequest createChannelRequest) Creates a new channel and an associated stream key to start streaming.
- Parameters:
createChannelRequest
-- Returns:
- A Java Future containing the result of the CreateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- ServiceQuotaExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createChannel
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 viaCreateChannelRequest.builder()
- Parameters:
createChannelRequest
- AConsumer
that will call methods onCreateChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- ServiceQuotaExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPlaybackRestrictionPolicy
default CompletableFuture<CreatePlaybackRestrictionPolicyResponse> createPlaybackRestrictionPolicy(CreatePlaybackRestrictionPolicyRequest createPlaybackRestrictionPolicyRequest) Creates a new playback restriction policy, for constraining playback by countries and/or origins.
- Parameters:
createPlaybackRestrictionPolicyRequest
-- Returns:
- A Java Future containing the result of the CreatePlaybackRestrictionPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- PendingVerificationException
- ThrottlingException
- ServiceQuotaExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPlaybackRestrictionPolicy
default CompletableFuture<CreatePlaybackRestrictionPolicyResponse> createPlaybackRestrictionPolicy(Consumer<CreatePlaybackRestrictionPolicyRequest.Builder> createPlaybackRestrictionPolicyRequest) Creates a new playback restriction policy, for constraining playback by countries and/or origins.
This is a convenience which creates an instance of the
CreatePlaybackRestrictionPolicyRequest.Builder
avoiding the need to create one manually viaCreatePlaybackRestrictionPolicyRequest.builder()
- Parameters:
createPlaybackRestrictionPolicyRequest
- AConsumer
that will call methods onCreatePlaybackRestrictionPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePlaybackRestrictionPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- PendingVerificationException
- ThrottlingException
- ServiceQuotaExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRecordingConfiguration
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 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 isCREATE_FAILED
(instead ofACTIVE
). (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.
- Parameters:
createRecordingConfigurationRequest
-- Returns:
- A Java Future containing the result of the CreateRecordingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- ConflictException
- ServiceQuotaExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRecordingConfiguration
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 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 isCREATE_FAILED
(instead ofACTIVE
). (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 viaCreateRecordingConfigurationRequest.builder()
- Parameters:
createRecordingConfigurationRequest
- AConsumer
that will call methods onCreateRecordingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRecordingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- ConflictException
- ServiceQuotaExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStreamKey
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.
- Parameters:
createStreamKeyRequest
-- Returns:
- A Java Future containing the result of the CreateStreamKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- ServiceQuotaExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStreamKey
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 viaCreateStreamKeyRequest.builder()
- Parameters:
createStreamKeyRequest
- AConsumer
that will call methods onCreateStreamKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateStreamKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- ServiceQuotaExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannel
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 is no longer Live), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)
- Parameters:
deleteChannelRequest
-- Returns:
- A Java Future containing the result of the DeleteChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannel
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 is no longer Live), 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 viaDeleteChannelRequest.builder()
- Parameters:
deleteChannelRequest
- AConsumer
that will call methods onDeleteChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePlaybackKeyPair
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.- Parameters:
deletePlaybackKeyPairRequest
-- Returns:
- A Java Future containing the result of the DeletePlaybackKeyPair operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePlaybackKeyPair
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 viaDeletePlaybackKeyPairRequest.builder()
- Parameters:
deletePlaybackKeyPairRequest
- AConsumer
that will call methods onDeletePlaybackKeyPairRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePlaybackKeyPair operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePlaybackRestrictionPolicy
default CompletableFuture<DeletePlaybackRestrictionPolicyResponse> deletePlaybackRestrictionPolicy(DeletePlaybackRestrictionPolicyRequest deletePlaybackRestrictionPolicyRequest) Deletes the specified playback restriction policy.
- Parameters:
deletePlaybackRestrictionPolicyRequest
-- Returns:
- A Java Future containing the result of the DeletePlaybackRestrictionPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePlaybackRestrictionPolicy
default CompletableFuture<DeletePlaybackRestrictionPolicyResponse> deletePlaybackRestrictionPolicy(Consumer<DeletePlaybackRestrictionPolicyRequest.Builder> deletePlaybackRestrictionPolicyRequest) Deletes the specified playback restriction policy.
This is a convenience which creates an instance of the
DeletePlaybackRestrictionPolicyRequest.Builder
avoiding the need to create one manually viaDeletePlaybackRestrictionPolicyRequest.builder()
- Parameters:
deletePlaybackRestrictionPolicyRequest
- AConsumer
that will call methods onDeletePlaybackRestrictionPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePlaybackRestrictionPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRecordingConfiguration
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.- Parameters:
deleteRecordingConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteRecordingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- InternalServerException
- AccessDeniedException
- ValidationException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRecordingConfiguration
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 viaDeleteRecordingConfigurationRequest.builder()
- Parameters:
deleteRecordingConfigurationRequest
- AConsumer
that will call methods onDeleteRecordingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRecordingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- InternalServerException
- AccessDeniedException
- ValidationException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStreamKey
default CompletableFuture<DeleteStreamKeyResponse> deleteStreamKey(DeleteStreamKeyRequest deleteStreamKeyRequest) Deletes the stream key for the specified ARN, so it can no longer be used to stream.
- Parameters:
deleteStreamKeyRequest
-- Returns:
- A Java Future containing the result of the DeleteStreamKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStreamKey
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 viaDeleteStreamKeyRequest.builder()
- Parameters:
deleteStreamKeyRequest
- AConsumer
that will call methods onDeleteStreamKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteStreamKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChannel
Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
- Parameters:
getChannelRequest
-- Returns:
- A Java Future containing the result of the GetChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChannel
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 viaGetChannelRequest.builder()
- Parameters:
getChannelRequest
- AConsumer
that will call methods onGetChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPlaybackKeyPair
default CompletableFuture<GetPlaybackKeyPairResponse> getPlaybackKeyPair(GetPlaybackKeyPairRequest getPlaybackKeyPairRequest) Gets a specified playback authorization key pair and returns the
arn
andfingerprint
. TheprivateKey
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.- Parameters:
getPlaybackKeyPairRequest
-- Returns:
- A Java Future containing the result of the GetPlaybackKeyPair operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPlaybackKeyPair
default CompletableFuture<GetPlaybackKeyPairResponse> getPlaybackKeyPair(Consumer<GetPlaybackKeyPairRequest.Builder> getPlaybackKeyPairRequest) Gets a specified playback authorization key pair and returns the
arn
andfingerprint
. TheprivateKey
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 viaGetPlaybackKeyPairRequest.builder()
- Parameters:
getPlaybackKeyPairRequest
- AConsumer
that will call methods onGetPlaybackKeyPairRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPlaybackKeyPair operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPlaybackRestrictionPolicy
default CompletableFuture<GetPlaybackRestrictionPolicyResponse> getPlaybackRestrictionPolicy(GetPlaybackRestrictionPolicyRequest getPlaybackRestrictionPolicyRequest) Gets the specified playback restriction policy.
- Parameters:
getPlaybackRestrictionPolicyRequest
-- Returns:
- A Java Future containing the result of the GetPlaybackRestrictionPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPlaybackRestrictionPolicy
default CompletableFuture<GetPlaybackRestrictionPolicyResponse> getPlaybackRestrictionPolicy(Consumer<GetPlaybackRestrictionPolicyRequest.Builder> getPlaybackRestrictionPolicyRequest) Gets the specified playback restriction policy.
This is a convenience which creates an instance of the
GetPlaybackRestrictionPolicyRequest.Builder
avoiding the need to create one manually viaGetPlaybackRestrictionPolicyRequest.builder()
- Parameters:
getPlaybackRestrictionPolicyRequest
- AConsumer
that will call methods onGetPlaybackRestrictionPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPlaybackRestrictionPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRecordingConfiguration
default CompletableFuture<GetRecordingConfigurationResponse> getRecordingConfiguration(GetRecordingConfigurationRequest getRecordingConfigurationRequest) Gets the recording configuration for the specified ARN.
- Parameters:
getRecordingConfigurationRequest
-- Returns:
- A Java Future containing the result of the GetRecordingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- InternalServerException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRecordingConfiguration
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 viaGetRecordingConfigurationRequest.builder()
- Parameters:
getRecordingConfigurationRequest
- AConsumer
that will call methods onGetRecordingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRecordingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- InternalServerException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStream
Gets information about the active (live) stream on a specified channel.
- Parameters:
getStreamRequest
-- Returns:
- A Java Future containing the result of the GetStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- ChannelNotBroadcastingException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStream
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 viaGetStreamRequest.builder()
- Parameters:
getStreamRequest
- AConsumer
that will call methods onGetStreamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- ChannelNotBroadcastingException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStreamKey
default CompletableFuture<GetStreamKeyResponse> getStreamKey(GetStreamKeyRequest getStreamKeyRequest) Gets stream-key information for a specified ARN.
- Parameters:
getStreamKeyRequest
-- Returns:
- A Java Future containing the result of the GetStreamKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStreamKey
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 viaGetStreamKeyRequest.builder()
- Parameters:
getStreamKeyRequest
- AConsumer
that will call methods onGetStreamKeyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetStreamKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStreamSession
default CompletableFuture<GetStreamSessionResponse> getStreamSession(GetStreamSessionRequest getStreamSessionRequest) Gets metadata on a specified stream.
- Parameters:
getStreamSessionRequest
-- Returns:
- A Java Future containing the result of the GetStreamSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStreamSession
default CompletableFuture<GetStreamSessionResponse> getStreamSession(Consumer<GetStreamSessionRequest.Builder> getStreamSessionRequest) Gets metadata on a specified stream.
This is a convenience which creates an instance of the
GetStreamSessionRequest.Builder
avoiding the need to create one manually viaGetStreamSessionRequest.builder()
- Parameters:
getStreamSessionRequest
- AConsumer
that will call methods onGetStreamSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetStreamSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importPlaybackKeyPair
default CompletableFuture<ImportPlaybackKeyPairResponse> importPlaybackKeyPair(ImportPlaybackKeyPairRequest importPlaybackKeyPairRequest) Imports the public portion of a new key pair and returns its
arn
andfingerprint
. TheprivateKey
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.- Parameters:
importPlaybackKeyPairRequest
-- Returns:
- A Java Future containing the result of the ImportPlaybackKeyPair operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- PendingVerificationException
- ConflictException
- ServiceQuotaExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importPlaybackKeyPair
default CompletableFuture<ImportPlaybackKeyPairResponse> importPlaybackKeyPair(Consumer<ImportPlaybackKeyPairRequest.Builder> importPlaybackKeyPairRequest) Imports the public portion of a new key pair and returns its
arn
andfingerprint
. TheprivateKey
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 viaImportPlaybackKeyPairRequest.builder()
- Parameters:
importPlaybackKeyPairRequest
- AConsumer
that will call methods onImportPlaybackKeyPairRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ImportPlaybackKeyPair operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- PendingVerificationException
- ConflictException
- ServiceQuotaExceededException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannels
default CompletableFuture<ListChannelsResponse> listChannels(ListChannelsRequest listChannelsRequest) 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).
- Parameters:
listChannelsRequest
-- Returns:
- A Java Future containing the result of the ListChannels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannels
default CompletableFuture<ListChannelsResponse> listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest) 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).
This is a convenience which creates an instance of the
ListChannelsRequest.Builder
avoiding the need to create one manually viaListChannelsRequest.builder()
- Parameters:
listChannelsRequest
- AConsumer
that will call methods onListChannelsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelsPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.ivs.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listChannelsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelsPaginator
default ListChannelsPublisher listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.ivs.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListChannelsRequest.builder()
- Parameters:
listChannelsRequest
- AConsumer
that will call methods onListChannelsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPlaybackKeyPairs
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.
- Parameters:
listPlaybackKeyPairsRequest
-- Returns:
- A Java Future containing the result of the ListPlaybackKeyPairs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPlaybackKeyPairs
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 viaListPlaybackKeyPairsRequest.builder()
- Parameters:
listPlaybackKeyPairsRequest
- AConsumer
that will call methods onListPlaybackKeyPairsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPlaybackKeyPairs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPlaybackKeyPairsPaginator
default ListPlaybackKeyPairsPublisher listPlaybackKeyPairsPaginator(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.ivs.paginators.ListPlaybackKeyPairsPublisher publisher = client.listPlaybackKeyPairsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listPlaybackKeyPairsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPlaybackKeyPairsPaginator
default ListPlaybackKeyPairsPublisher listPlaybackKeyPairsPaginator(Consumer<ListPlaybackKeyPairsRequest.Builder> listPlaybackKeyPairsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.ivs.paginators.ListPlaybackKeyPairsPublisher publisher = client.listPlaybackKeyPairsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListPlaybackKeyPairsRequest.builder()
- Parameters:
listPlaybackKeyPairsRequest
- AConsumer
that will call methods onListPlaybackKeyPairsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPlaybackRestrictionPolicies
default CompletableFuture<ListPlaybackRestrictionPoliciesResponse> listPlaybackRestrictionPolicies(ListPlaybackRestrictionPoliciesRequest listPlaybackRestrictionPoliciesRequest) Gets summary information about playback restriction policies.
- Parameters:
listPlaybackRestrictionPoliciesRequest
-- Returns:
- A Java Future containing the result of the ListPlaybackRestrictionPolicies operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- PendingVerificationException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPlaybackRestrictionPolicies
default CompletableFuture<ListPlaybackRestrictionPoliciesResponse> listPlaybackRestrictionPolicies(Consumer<ListPlaybackRestrictionPoliciesRequest.Builder> listPlaybackRestrictionPoliciesRequest) Gets summary information about playback restriction policies.
This is a convenience which creates an instance of the
ListPlaybackRestrictionPoliciesRequest.Builder
avoiding the need to create one manually viaListPlaybackRestrictionPoliciesRequest.builder()
- Parameters:
listPlaybackRestrictionPoliciesRequest
- AConsumer
that will call methods onListPlaybackRestrictionPoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPlaybackRestrictionPolicies operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- PendingVerificationException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPlaybackRestrictionPoliciesPaginator
default ListPlaybackRestrictionPoliciesPublisher listPlaybackRestrictionPoliciesPaginator(ListPlaybackRestrictionPoliciesRequest listPlaybackRestrictionPoliciesRequest) This is a variant of
listPlaybackRestrictionPolicies(software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.ivs.paginators.ListPlaybackRestrictionPoliciesPublisher publisher = client.listPlaybackRestrictionPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ivs.paginators.ListPlaybackRestrictionPoliciesPublisher publisher = client.listPlaybackRestrictionPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesResponse response) { //... }; });
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
listPlaybackRestrictionPolicies(software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesRequest)
operation.- Parameters:
listPlaybackRestrictionPoliciesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- PendingVerificationException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPlaybackRestrictionPoliciesPaginator
default ListPlaybackRestrictionPoliciesPublisher listPlaybackRestrictionPoliciesPaginator(Consumer<ListPlaybackRestrictionPoliciesRequest.Builder> listPlaybackRestrictionPoliciesRequest) This is a variant of
listPlaybackRestrictionPolicies(software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.ivs.paginators.ListPlaybackRestrictionPoliciesPublisher publisher = client.listPlaybackRestrictionPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ivs.paginators.ListPlaybackRestrictionPoliciesPublisher publisher = client.listPlaybackRestrictionPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesResponse response) { //... }; });
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
listPlaybackRestrictionPolicies(software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesRequest)
operation.
This is a convenience which creates an instance of the
ListPlaybackRestrictionPoliciesRequest.Builder
avoiding the need to create one manually viaListPlaybackRestrictionPoliciesRequest.builder()
- Parameters:
listPlaybackRestrictionPoliciesRequest
- AConsumer
that will call methods onListPlaybackRestrictionPoliciesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- PendingVerificationException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRecordingConfigurations
default CompletableFuture<ListRecordingConfigurationsResponse> listRecordingConfigurations(ListRecordingConfigurationsRequest listRecordingConfigurationsRequest) Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
- Parameters:
listRecordingConfigurationsRequest
-- Returns:
- A Java Future containing the result of the ListRecordingConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRecordingConfigurations
default CompletableFuture<ListRecordingConfigurationsResponse> listRecordingConfigurations(Consumer<ListRecordingConfigurationsRequest.Builder> listRecordingConfigurationsRequest) Gets summary information about all recording configurations in your account, in the Amazon Web Services 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 viaListRecordingConfigurationsRequest.builder()
- Parameters:
listRecordingConfigurationsRequest
- AConsumer
that will call methods onListRecordingConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRecordingConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRecordingConfigurationsPaginator
default ListRecordingConfigurationsPublisher listRecordingConfigurationsPaginator(ListRecordingConfigurationsRequest listRecordingConfigurationsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.ivs.paginators.ListRecordingConfigurationsPublisher publisher = client.listRecordingConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listRecordingConfigurationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRecordingConfigurationsPaginator
default ListRecordingConfigurationsPublisher listRecordingConfigurationsPaginator(Consumer<ListRecordingConfigurationsRequest.Builder> listRecordingConfigurationsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.ivs.paginators.ListRecordingConfigurationsPublisher publisher = client.listRecordingConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListRecordingConfigurationsRequest.builder()
- Parameters:
listRecordingConfigurationsRequest
- AConsumer
that will call methods onListRecordingConfigurationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamKeys
default CompletableFuture<ListStreamKeysResponse> listStreamKeys(ListStreamKeysRequest listStreamKeysRequest) Gets summary information about stream keys for the specified channel.
- Parameters:
listStreamKeysRequest
-- Returns:
- A Java Future containing the result of the ListStreamKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamKeys
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 viaListStreamKeysRequest.builder()
- Parameters:
listStreamKeysRequest
- AConsumer
that will call methods onListStreamKeysRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStreamKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamKeysPaginator
default ListStreamKeysPublisher listStreamKeysPaginator(ListStreamKeysRequest listStreamKeysRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.ivs.paginators.ListStreamKeysPublisher publisher = client.listStreamKeysPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listStreamKeysRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamKeysPaginator
default ListStreamKeysPublisher listStreamKeysPaginator(Consumer<ListStreamKeysRequest.Builder> listStreamKeysRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.ivs.paginators.ListStreamKeysPublisher publisher = client.listStreamKeysPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListStreamKeysRequest.builder()
- Parameters:
listStreamKeysRequest
- AConsumer
that will call methods onListStreamKeysRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamSessions
default CompletableFuture<ListStreamSessionsResponse> listStreamSessions(ListStreamSessionsRequest listStreamSessionsRequest) 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.
- Parameters:
listStreamSessionsRequest
-- Returns:
- A Java Future containing the result of the ListStreamSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamSessions
default CompletableFuture<ListStreamSessionsResponse> listStreamSessions(Consumer<ListStreamSessionsRequest.Builder> listStreamSessionsRequest) 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.
This is a convenience which creates an instance of the
ListStreamSessionsRequest.Builder
avoiding the need to create one manually viaListStreamSessionsRequest.builder()
- Parameters:
listStreamSessionsRequest
- AConsumer
that will call methods onListStreamSessionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStreamSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamSessionsPaginator
default ListStreamSessionsPublisher listStreamSessionsPaginator(ListStreamSessionsRequest listStreamSessionsRequest) This is a variant of
listStreamSessions(software.amazon.awssdk.services.ivs.model.ListStreamSessionsRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.ivs.paginators.ListStreamSessionsPublisher publisher = client.listStreamSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ivs.paginators.ListStreamSessionsPublisher publisher = client.listStreamSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivs.model.ListStreamSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ivs.model.ListStreamSessionsResponse response) { //... }; });
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
listStreamSessions(software.amazon.awssdk.services.ivs.model.ListStreamSessionsRequest)
operation.- Parameters:
listStreamSessionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamSessionsPaginator
default ListStreamSessionsPublisher listStreamSessionsPaginator(Consumer<ListStreamSessionsRequest.Builder> listStreamSessionsRequest) This is a variant of
listStreamSessions(software.amazon.awssdk.services.ivs.model.ListStreamSessionsRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.ivs.paginators.ListStreamSessionsPublisher publisher = client.listStreamSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ivs.paginators.ListStreamSessionsPublisher publisher = client.listStreamSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ivs.model.ListStreamSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ivs.model.ListStreamSessionsResponse response) { //... }; });
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
listStreamSessions(software.amazon.awssdk.services.ivs.model.ListStreamSessionsRequest)
operation.
This is a convenience which creates an instance of the
ListStreamSessionsRequest.Builder
avoiding the need to create one manually viaListStreamSessionsRequest.builder()
- Parameters:
listStreamSessionsRequest
- AConsumer
that will call methods onListStreamSessionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreams
Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
- Parameters:
listStreamsRequest
-- Returns:
- A Java Future containing the result of the ListStreams operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreams
default CompletableFuture<ListStreamsResponse> listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest) Gets summary information about live streams in your account, in the Amazon Web Services 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 viaListStreamsRequest.builder()
- Parameters:
listStreamsRequest
- AConsumer
that will call methods onListStreamsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStreams operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamsPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.ivs.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listStreamsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listStreamsPaginator
default ListStreamsPublisher listStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.ivs.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListStreamsRequest.builder()
- Parameters:
listStreamsRequest
- AConsumer
that will call methods onListStreamsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccessDeniedException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Gets information about Amazon Web Services tags for the specified ARN.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- InternalServerException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Gets information about Amazon Web Services tags for the specified ARN.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- InternalServerException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putMetadata
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.
- Parameters:
putMetadataRequest
-- Returns:
- A Java Future containing the result of the PutMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- ChannelNotBroadcastingException
- ThrottlingException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putMetadata
default CompletableFuture<PutMetadataResponse> putMetadata(Consumer<PutMetadataRequest.Builder> putMetadataRequest) 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.
This is a convenience which creates an instance of the
PutMetadataRequest.Builder
avoiding the need to create one manually viaPutMetadataRequest.builder()
- Parameters:
putMetadataRequest
- AConsumer
that will call methods onPutMetadataRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- ChannelNotBroadcastingException
- ThrottlingException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startViewerSessionRevocation
default CompletableFuture<StartViewerSessionRevocationResponse> startViewerSessionRevocation(StartViewerSessionRevocationRequest startViewerSessionRevocationRequest) 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.
- Parameters:
startViewerSessionRevocationRequest
-- Returns:
- A Java Future containing the result of the StartViewerSessionRevocation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- InternalServerException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- ThrottlingException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startViewerSessionRevocation
default CompletableFuture<StartViewerSessionRevocationResponse> startViewerSessionRevocation(Consumer<StartViewerSessionRevocationRequest.Builder> startViewerSessionRevocationRequest) 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.
This is a convenience which creates an instance of the
StartViewerSessionRevocationRequest.Builder
avoiding the need to create one manually viaStartViewerSessionRevocationRequest.builder()
- Parameters:
startViewerSessionRevocationRequest
- AConsumer
that will call methods onStartViewerSessionRevocationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartViewerSessionRevocation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- InternalServerException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- ThrottlingException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopStream
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.- Parameters:
stopStreamRequest
-- Returns:
- A Java Future containing the result of the StopStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- ChannelNotBroadcastingException
- StreamUnavailableException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopStream
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 viaStopStreamRequest.builder()
- Parameters:
stopStreamRequest
- AConsumer
that will call methods onStopStreamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- ChannelNotBroadcastingException
- StreamUnavailableException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds or updates tags for the Amazon Web Services resource with the specified ARN.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- InternalServerException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or updates tags for the Amazon Web Services resource with the specified ARN.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- InternalServerException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from the resource with the specified ARN.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- InternalServerException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- InternalServerException
- ValidationException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChannel
default CompletableFuture<UpdateChannelResponse> updateChannel(UpdateChannelRequest updateChannelRequest) 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.
- Parameters:
updateChannelRequest
-- Returns:
- A Java Future containing the result of the UpdateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChannel
default CompletableFuture<UpdateChannelResponse> updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest) 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.
This is a convenience which creates an instance of the
UpdateChannelRequest.Builder
avoiding the need to create one manually viaUpdateChannelRequest.builder()
- Parameters:
updateChannelRequest
- AConsumer
that will call methods onUpdateChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePlaybackRestrictionPolicy
default CompletableFuture<UpdatePlaybackRestrictionPolicyResponse> updatePlaybackRestrictionPolicy(UpdatePlaybackRestrictionPolicyRequest updatePlaybackRestrictionPolicyRequest) Updates a specified playback restriction policy.
- Parameters:
updatePlaybackRestrictionPolicyRequest
-- Returns:
- A Java Future containing the result of the UpdatePlaybackRestrictionPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePlaybackRestrictionPolicy
default CompletableFuture<UpdatePlaybackRestrictionPolicyResponse> updatePlaybackRestrictionPolicy(Consumer<UpdatePlaybackRestrictionPolicyRequest.Builder> updatePlaybackRestrictionPolicyRequest) Updates a specified playback restriction policy.
This is a convenience which creates an instance of the
UpdatePlaybackRestrictionPolicyRequest.Builder
avoiding the need to create one manually viaUpdatePlaybackRestrictionPolicyRequest.builder()
- Parameters:
updatePlaybackRestrictionPolicyRequest
- AConsumer
that will call methods onUpdatePlaybackRestrictionPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePlaybackRestrictionPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException
- AccessDeniedException
- ValidationException
- PendingVerificationException
- ConflictException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IvsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aIvsAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aIvsAsyncClient
.
-