@Generated(value="software.amazon.awssdk:codegen") public interface IvsClient extends SdkClient
builder() method.
Introduction
The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
The API is an AWS regional service, currently in these regions: us-west-2, us-east-1, and eu-west-1.
All API request parameters and URLs are case sensitive.
For a summary of notable documentation changes in each release, see Document History.
Service Endpoints
The following are the Amazon IVS service endpoints (all HTTPS):
Region name: US West (Oregon)
Region: us-west-2
Endpoint: ivs.us-west-2.amazonaws.com
Region name: US East (Virginia)
Region: us-east-1
Endpoint: ivs.us-east-1.amazonaws.com
Region name: EU West (Dublin)
Region: eu-west-1
Endpoint: ivs.eu-west-1.amazonaws.com
Allowed Header Values
Accept: application/json
Accept-Encoding: gzip, deflate
Content-Type: application/json
Resources
The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS):
Channel — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream. See the Channel endpoints for more information.
Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. See the StreamKey endpoints for more information. Treat the stream key like a secret, since it allows anyone to stream to the channel.
Playback key pair — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token. See the PlaybackKeyPair endpoints for more information.
Recording configuration — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration. See the Recording Configuration endpoints for more information.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value,
both set by you. For example, you might set a tag as topic:nature to label a particular video category.
See Tagging AWS Resources for more
information, including restrictions that apply to tags.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations.
Authentication versus Authorization
Note the differences between these concepts:
Authentication is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.
Authorization is about granting permissions. You need to be authorized to view Amazon IVS private channels. (Private channels are channels that are enabled for "playback authorization.")
Authentication
All Amazon IVS API requests must be authenticated with a signature. The AWS Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS API directly, it’s your responsibility to sign the requests.
You generate a signature using valid AWS credentials that have permission to perform the requested action. For
example, you must sign PutMetadata requests with a signature generated from an IAM user account that has the
ivs:PutMetadata permission.
For more information:
Authentication and generating signatures — See Authenticating Requests (AWS Signature Version 4) in the AWS General Reference.
Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
Channel Endpoints
CreateChannel — Creates a new channel and an associated stream key to start streaming.
GetChannel — Gets the channel configuration for the specified channel ARN (Amazon Resource Name).
BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously.
ListChannels — Gets summary information about all channels in your account, in the AWS region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 Conflict Exception).
UpdateChannel — Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.
DeleteChannel — Deletes the specified channel.
StreamKey Endpoints
CreateStreamKey — Creates a stream key, used to initiate a stream, for the specified channel ARN.
GetStreamKey — Gets stream key information for the specified ARN.
BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously.
ListStreamKeys — Gets summary information about stream keys for the specified channel.
DeleteStreamKey — Deletes the stream key for the specified ARN, so it can no longer be used to stream.
Stream Endpoints
GetStream — Gets information about the active (live) stream on a specified channel.
ListStreams — Gets summary information about live streams in your account, in the AWS region where the API request is processed.
StopStream — Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.
PutMetadata — Inserts metadata into the active stream of the specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.)
PlaybackKeyPair Endpoints
For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
ImportPlaybackKeyPair — Imports the public portion of a new key pair and returns its arn and
fingerprint. The privateKey can then be used to generate viewer authorization tokens, to
grant viewers access to private channels (channels enabled for playback authorization).
GetPlaybackKeyPair — Gets a specified playback authorization key pair and returns the arn and
fingerprint. The privateKey held by the caller can be used to generate viewer authorization
tokens, to grant viewers access to private channels.
ListPlaybackKeyPairs — Gets summary information about playback key pairs.
DeletePlaybackKeyPair — Deletes a specified authorization key pair. This invalidates future viewer tokens
generated using the key pair’s privateKey.
RecordingConfiguration Endpoints
CreateRecordingConfiguration — Creates a new recording configuration, used to enable recording to Amazon S3.
GetRecordingConfiguration — Gets the recording-configuration metadata for the specified ARN.
ListRecordingConfigurations — Gets summary information about all recording configurations in your account, in the AWS region where the API request is processed.
DeleteRecordingConfiguration — Deletes the recording configuration for the specified ARN.
AWS Tags Endpoints
TagResource — Adds or updates tags for the AWS resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.
ListTagsForResource — Gets information about AWS tags for the specified ARN.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default BatchGetChannelResponse |
batchGetChannel(BatchGetChannelRequest batchGetChannelRequest)
Performs GetChannel on multiple ARNs simultaneously.
|
default BatchGetChannelResponse |
batchGetChannel(Consumer<BatchGetChannelRequest.Builder> batchGetChannelRequest)
Performs GetChannel on multiple ARNs simultaneously.
|
default BatchGetStreamKeyResponse |
batchGetStreamKey(BatchGetStreamKeyRequest batchGetStreamKeyRequest)
Performs GetStreamKey on multiple ARNs simultaneously.
|
default BatchGetStreamKeyResponse |
batchGetStreamKey(Consumer<BatchGetStreamKeyRequest.Builder> batchGetStreamKeyRequest)
Performs GetStreamKey on multiple ARNs simultaneously.
|
static IvsClientBuilder |
builder()
Create a builder that can be used to configure and create a
IvsClient. |
static IvsClient |
create()
Create a
IvsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateChannelResponse |
createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest)
Creates a new channel and an associated stream key to start streaming.
|
default CreateChannelResponse |
createChannel(CreateChannelRequest createChannelRequest)
Creates a new channel and an associated stream key to start streaming.
|
default CreateRecordingConfigurationResponse |
createRecordingConfiguration(Consumer<CreateRecordingConfigurationRequest.Builder> createRecordingConfigurationRequest)
Creates a new recording configuration, used to enable recording to Amazon S3.
|
default CreateRecordingConfigurationResponse |
createRecordingConfiguration(CreateRecordingConfigurationRequest createRecordingConfigurationRequest)
Creates a new recording configuration, used to enable recording to Amazon S3.
|
default CreateStreamKeyResponse |
createStreamKey(Consumer<CreateStreamKeyRequest.Builder> createStreamKeyRequest)
Creates a stream key, used to initiate a stream, for the specified channel ARN.
|
default CreateStreamKeyResponse |
createStreamKey(CreateStreamKeyRequest createStreamKeyRequest)
Creates a stream key, used to initiate a stream, for the specified channel ARN.
|
default DeleteChannelResponse |
deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest)
Deletes the specified channel and its associated stream keys.
|
default DeleteChannelResponse |
deleteChannel(DeleteChannelRequest deleteChannelRequest)
Deletes the specified channel and its associated stream keys.
|
default DeletePlaybackKeyPairResponse |
deletePlaybackKeyPair(Consumer<DeletePlaybackKeyPairRequest.Builder> deletePlaybackKeyPairRequest)
Deletes a specified authorization key pair.
|
default DeletePlaybackKeyPairResponse |
deletePlaybackKeyPair(DeletePlaybackKeyPairRequest deletePlaybackKeyPairRequest)
Deletes a specified authorization key pair.
|
default DeleteRecordingConfigurationResponse |
deleteRecordingConfiguration(Consumer<DeleteRecordingConfigurationRequest.Builder> deleteRecordingConfigurationRequest)
Deletes the recording configuration for the specified ARN.
|
default DeleteRecordingConfigurationResponse |
deleteRecordingConfiguration(DeleteRecordingConfigurationRequest deleteRecordingConfigurationRequest)
Deletes the recording configuration for the specified ARN.
|
default DeleteStreamKeyResponse |
deleteStreamKey(Consumer<DeleteStreamKeyRequest.Builder> deleteStreamKeyRequest)
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
|
default DeleteStreamKeyResponse |
deleteStreamKey(DeleteStreamKeyRequest deleteStreamKeyRequest)
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
|
default GetChannelResponse |
getChannel(Consumer<GetChannelRequest.Builder> getChannelRequest)
Gets the channel configuration for the specified channel ARN.
|
default GetChannelResponse |
getChannel(GetChannelRequest getChannelRequest)
Gets the channel configuration for the specified channel ARN.
|
default GetPlaybackKeyPairResponse |
getPlaybackKeyPair(Consumer<GetPlaybackKeyPairRequest.Builder> getPlaybackKeyPairRequest)
Gets a specified playback authorization key pair and returns the
arn and fingerprint. |
default GetPlaybackKeyPairResponse |
getPlaybackKeyPair(GetPlaybackKeyPairRequest getPlaybackKeyPairRequest)
Gets a specified playback authorization key pair and returns the
arn and fingerprint. |
default GetRecordingConfigurationResponse |
getRecordingConfiguration(Consumer<GetRecordingConfigurationRequest.Builder> getRecordingConfigurationRequest)
Gets the recording configuration for the specified ARN.
|
default GetRecordingConfigurationResponse |
getRecordingConfiguration(GetRecordingConfigurationRequest getRecordingConfigurationRequest)
Gets the recording configuration for the specified ARN.
|
default GetStreamResponse |
getStream(Consumer<GetStreamRequest.Builder> getStreamRequest)
Gets information about the active (live) stream on a specified channel.
|
default GetStreamResponse |
getStream(GetStreamRequest getStreamRequest)
Gets information about the active (live) stream on a specified channel.
|
default GetStreamKeyResponse |
getStreamKey(Consumer<GetStreamKeyRequest.Builder> getStreamKeyRequest)
Gets stream-key information for a specified ARN.
|
default GetStreamKeyResponse |
getStreamKey(GetStreamKeyRequest getStreamKeyRequest)
Gets stream-key information for a specified ARN.
|
default ImportPlaybackKeyPairResponse |
importPlaybackKeyPair(Consumer<ImportPlaybackKeyPairRequest.Builder> importPlaybackKeyPairRequest)
Imports the public portion of a new key pair and returns its
arn and fingerprint. |
default ImportPlaybackKeyPairResponse |
importPlaybackKeyPair(ImportPlaybackKeyPairRequest importPlaybackKeyPairRequest)
Imports the public portion of a new key pair and returns its
arn and fingerprint. |
default ListChannelsResponse |
listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
Gets summary information about all channels in your account, in the AWS region where the API request is
processed.
|
default ListChannelsResponse |
listChannels(ListChannelsRequest listChannelsRequest)
Gets summary information about all channels in your account, in the AWS region where the API request is
processed.
|
default ListChannelsIterable |
listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
Gets summary information about all channels in your account, in the AWS region where the API request is
processed.
|
default ListChannelsIterable |
listChannelsPaginator(ListChannelsRequest listChannelsRequest)
Gets summary information about all channels in your account, in the AWS region where the API request is
processed.
|
default ListPlaybackKeyPairsResponse |
listPlaybackKeyPairs(Consumer<ListPlaybackKeyPairsRequest.Builder> listPlaybackKeyPairsRequest)
Gets summary information about playback key pairs.
|
default ListPlaybackKeyPairsResponse |
listPlaybackKeyPairs(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest)
Gets summary information about playback key pairs.
|
default ListPlaybackKeyPairsIterable |
listPlaybackKeyPairsPaginator(Consumer<ListPlaybackKeyPairsRequest.Builder> listPlaybackKeyPairsRequest)
Gets summary information about playback key pairs.
|
default ListPlaybackKeyPairsIterable |
listPlaybackKeyPairsPaginator(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest)
Gets summary information about playback key pairs.
|
default ListRecordingConfigurationsResponse |
listRecordingConfigurations(Consumer<ListRecordingConfigurationsRequest.Builder> listRecordingConfigurationsRequest)
Gets summary information about all recording configurations in your account, in the AWS region where the API
request is processed.
|
default ListRecordingConfigurationsResponse |
listRecordingConfigurations(ListRecordingConfigurationsRequest listRecordingConfigurationsRequest)
Gets summary information about all recording configurations in your account, in the AWS region where the API
request is processed.
|
default ListRecordingConfigurationsIterable |
listRecordingConfigurationsPaginator(Consumer<ListRecordingConfigurationsRequest.Builder> listRecordingConfigurationsRequest)
Gets summary information about all recording configurations in your account, in the AWS region where the API
request is processed.
|
default ListRecordingConfigurationsIterable |
listRecordingConfigurationsPaginator(ListRecordingConfigurationsRequest listRecordingConfigurationsRequest)
Gets summary information about all recording configurations in your account, in the AWS region where the API
request is processed.
|
default ListStreamKeysResponse |
listStreamKeys(Consumer<ListStreamKeysRequest.Builder> listStreamKeysRequest)
Gets summary information about stream keys for the specified channel.
|
default ListStreamKeysResponse |
listStreamKeys(ListStreamKeysRequest listStreamKeysRequest)
Gets summary information about stream keys for the specified channel.
|
default ListStreamKeysIterable |
listStreamKeysPaginator(Consumer<ListStreamKeysRequest.Builder> listStreamKeysRequest)
Gets summary information about stream keys for the specified channel.
|
default ListStreamKeysIterable |
listStreamKeysPaginator(ListStreamKeysRequest listStreamKeysRequest)
Gets summary information about stream keys for the specified channel.
|
default ListStreamsResponse |
listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
Gets summary information about live streams in your account, in the AWS region where the API request is
processed.
|
default ListStreamsResponse |
listStreams(ListStreamsRequest listStreamsRequest)
Gets summary information about live streams in your account, in the AWS region where the API request is
processed.
|
default ListStreamsIterable |
listStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
Gets summary information about live streams in your account, in the AWS region where the API request is
processed.
|
default ListStreamsIterable |
listStreamsPaginator(ListStreamsRequest listStreamsRequest)
Gets summary information about live streams in your account, in the AWS region where the API request is
processed.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
|
default ListTagsForResourceIterable |
listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
|
default ListTagsForResourceIterable |
listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Gets information about AWS tags for the specified ARN.
|
default PutMetadataResponse |
putMetadata(Consumer<PutMetadataRequest.Builder> putMetadataRequest)
Inserts metadata into the active stream of the specified channel.
|
default PutMetadataResponse |
putMetadata(PutMetadataRequest putMetadataRequest)
Inserts metadata into the active stream of the specified channel.
|
static ServiceMetadata |
serviceMetadata() |
default StopStreamResponse |
stopStream(Consumer<StopStreamRequest.Builder> stopStreamRequest)
Disconnects the incoming RTMPS stream for the specified channel.
|
default StopStreamResponse |
stopStream(StopStreamRequest stopStreamRequest)
Disconnects the incoming RTMPS stream for the specified channel.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds or updates tags for the AWS resource with the specified ARN.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds or updates tags for the AWS resource with the specified ARN.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from the resource with the specified ARN.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the resource with the specified ARN.
|
default UpdateChannelResponse |
updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest)
Updates a channel's configuration.
|
default UpdateChannelResponse |
updateChannel(UpdateChannelRequest updateChannelRequest)
Updates a channel's configuration.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static IvsClient create()
IvsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static IvsClientBuilder builder()
IvsClient.default BatchGetChannelResponse batchGetChannel(BatchGetChannelRequest batchGetChannelRequest) throws AwsServiceException, SdkClientException, IvsException
Performs GetChannel on multiple ARNs simultaneously.
batchGetChannelRequest - 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.AwsServiceExceptiondefault BatchGetChannelResponse batchGetChannel(Consumer<BatchGetChannelRequest.Builder> batchGetChannelRequest) throws AwsServiceException, SdkClientException, IvsException
Performs GetChannel on multiple ARNs simultaneously.
This is a convenience which creates an instance of the BatchGetChannelRequest.Builder avoiding the need
to create one manually via BatchGetChannelRequest.builder()
batchGetChannelRequest - A Consumer that will call methods on BatchGetChannelRequest.Builder to create a request.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.AwsServiceExceptiondefault BatchGetStreamKeyResponse batchGetStreamKey(BatchGetStreamKeyRequest batchGetStreamKeyRequest) throws AwsServiceException, SdkClientException, IvsException
Performs GetStreamKey on multiple ARNs simultaneously.
batchGetStreamKeyRequest - 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.AwsServiceExceptiondefault BatchGetStreamKeyResponse batchGetStreamKey(Consumer<BatchGetStreamKeyRequest.Builder> batchGetStreamKeyRequest) throws AwsServiceException, SdkClientException, IvsException
Performs GetStreamKey on multiple ARNs simultaneously.
This is a convenience which creates an instance of the BatchGetStreamKeyRequest.Builder avoiding the need
to create one manually via BatchGetStreamKeyRequest.builder()
batchGetStreamKeyRequest - A Consumer that will call methods on BatchGetStreamKeyRequest.Builder to create a request.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.AwsServiceExceptiondefault CreateChannelResponse createChannel(CreateChannelRequest createChannelRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ServiceQuotaExceededException, PendingVerificationException, AwsServiceException, SdkClientException, IvsException
Creates a new channel and an associated stream key to start streaming.
createChannelRequest - ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionServiceQuotaExceededExceptionPendingVerificationExceptionSdkException - 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.AwsServiceExceptiondefault CreateChannelResponse createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ServiceQuotaExceededException, PendingVerificationException, AwsServiceException, SdkClientException, IvsException
Creates a new channel and an associated stream key to start streaming.
This is a convenience which creates an instance of the CreateChannelRequest.Builder avoiding the need to
create one manually via CreateChannelRequest.builder()
createChannelRequest - A Consumer that will call methods on CreateChannelRequest.Builder to create a request.ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionServiceQuotaExceededExceptionPendingVerificationExceptionSdkException - 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.AwsServiceExceptiondefault CreateRecordingConfigurationResponse createRecordingConfiguration(CreateRecordingConfigurationRequest createRecordingConfigurationRequest) throws AccessDeniedException, ConflictException, InternalServerException, PendingVerificationException, ServiceQuotaExceededException, ValidationException, AwsServiceException, SdkClientException, IvsException
Creates a new recording configuration, used to enable recording to Amazon S3.
Known issue: In the us-east-1 region, if you use the AWS CLI to create a recording configuration, it
returns success even if the S3 bucket is in a different region. In this case, the state of the
recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the
CLI correctly returns failure if the bucket is in a different region.)
Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.
createRecordingConfigurationRequest - AccessDeniedExceptionConflictExceptionInternalServerExceptionPendingVerificationExceptionServiceQuotaExceededExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault CreateRecordingConfigurationResponse createRecordingConfiguration(Consumer<CreateRecordingConfigurationRequest.Builder> createRecordingConfigurationRequest) throws AccessDeniedException, ConflictException, InternalServerException, PendingVerificationException, ServiceQuotaExceededException, ValidationException, AwsServiceException, SdkClientException, IvsException
Creates a new recording configuration, used to enable recording to Amazon S3.
Known issue: In the us-east-1 region, if you use the AWS CLI to create a recording configuration, it
returns success even if the S3 bucket is in a different region. In this case, the state of the
recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the
CLI correctly returns failure if the bucket is in a different region.)
Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.
This is a convenience which creates an instance of the CreateRecordingConfigurationRequest.Builder
avoiding the need to create one manually via CreateRecordingConfigurationRequest.builder()
createRecordingConfigurationRequest - A Consumer that will call methods on CreateRecordingConfigurationRequest.Builder to create
a request.AccessDeniedExceptionConflictExceptionInternalServerExceptionPendingVerificationExceptionServiceQuotaExceededExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault CreateStreamKeyResponse createStreamKey(CreateStreamKeyRequest createStreamKeyRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ServiceQuotaExceededException, PendingVerificationException, AwsServiceException, SdkClientException, IvsException
Creates a stream key, used to initiate a stream, for the specified channel ARN.
Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.
createStreamKeyRequest - ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionServiceQuotaExceededExceptionPendingVerificationExceptionSdkException - 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.AwsServiceExceptiondefault CreateStreamKeyResponse createStreamKey(Consumer<CreateStreamKeyRequest.Builder> createStreamKeyRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ServiceQuotaExceededException, PendingVerificationException, AwsServiceException, SdkClientException, IvsException
Creates a stream key, used to initiate a stream, for the specified channel ARN.
Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.
This is a convenience which creates an instance of the CreateStreamKeyRequest.Builder avoiding the need
to create one manually via CreateStreamKeyRequest.builder()
createStreamKeyRequest - A Consumer that will call methods on CreateStreamKeyRequest.Builder to create a request.ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionServiceQuotaExceededExceptionPendingVerificationExceptionSdkException - 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.AwsServiceExceptiondefault DeleteChannelResponse deleteChannel(DeleteChannelRequest deleteChannelRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ConflictException, PendingVerificationException, AwsServiceException, SdkClientException, IvsException
Deletes the specified channel and its associated stream keys.
If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state was changed from Live to Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)
deleteChannelRequest - ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionConflictExceptionPendingVerificationExceptionSdkException - 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.AwsServiceExceptiondefault DeleteChannelResponse deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ConflictException, PendingVerificationException, AwsServiceException, SdkClientException, IvsException
Deletes the specified channel and its associated stream keys.
If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state was changed from Live to Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)
This is a convenience which creates an instance of the DeleteChannelRequest.Builder avoiding the need to
create one manually via DeleteChannelRequest.builder()
deleteChannelRequest - A Consumer that will call methods on DeleteChannelRequest.Builder to create a request.ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionConflictExceptionPendingVerificationExceptionSdkException - 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.AwsServiceExceptiondefault DeletePlaybackKeyPairResponse deletePlaybackKeyPair(DeletePlaybackKeyPairRequest deletePlaybackKeyPairRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, PendingVerificationException, AwsServiceException, SdkClientException, IvsException
Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s
privateKey. For more information, see Setting Up Private Channels in
the Amazon IVS User Guide.
deletePlaybackKeyPairRequest - ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionPendingVerificationExceptionSdkException - 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.AwsServiceExceptiondefault DeletePlaybackKeyPairResponse deletePlaybackKeyPair(Consumer<DeletePlaybackKeyPairRequest.Builder> deletePlaybackKeyPairRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, PendingVerificationException, AwsServiceException, SdkClientException, IvsException
Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s
privateKey. For more information, see Setting Up Private Channels in
the Amazon IVS User Guide.
This is a convenience which creates an instance of the DeletePlaybackKeyPairRequest.Builder avoiding the
need to create one manually via DeletePlaybackKeyPairRequest.builder()
deletePlaybackKeyPairRequest - A Consumer that will call methods on DeletePlaybackKeyPairRequest.Builder to create a
request.ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionPendingVerificationExceptionSdkException - 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.AwsServiceExceptiondefault DeleteRecordingConfigurationResponse deleteRecordingConfiguration(DeleteRecordingConfigurationRequest deleteRecordingConfigurationRequest) throws AccessDeniedException, ConflictException, InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, IvsException
Deletes the recording configuration for the specified ARN.
If you try to delete a recording configuration that is associated with a channel, you will get an error (409
ConflictException). To avoid this, for all channels that reference the recording configuration, first use
UpdateChannel to set the recordingConfigurationArn field to an empty string, then use
DeleteRecordingConfiguration.
deleteRecordingConfigurationRequest - AccessDeniedExceptionConflictExceptionInternalServerExceptionResourceNotFoundExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault DeleteRecordingConfigurationResponse deleteRecordingConfiguration(Consumer<DeleteRecordingConfigurationRequest.Builder> deleteRecordingConfigurationRequest) throws AccessDeniedException, ConflictException, InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, IvsException
Deletes the recording configuration for the specified ARN.
If you try to delete a recording configuration that is associated with a channel, you will get an error (409
ConflictException). To avoid this, for all channels that reference the recording configuration, first use
UpdateChannel to set the recordingConfigurationArn field to an empty string, then use
DeleteRecordingConfiguration.
This is a convenience which creates an instance of the DeleteRecordingConfigurationRequest.Builder
avoiding the need to create one manually via DeleteRecordingConfigurationRequest.builder()
deleteRecordingConfigurationRequest - A Consumer that will call methods on DeleteRecordingConfigurationRequest.Builder to create
a request.AccessDeniedExceptionConflictExceptionInternalServerExceptionResourceNotFoundExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault DeleteStreamKeyResponse deleteStreamKey(DeleteStreamKeyRequest deleteStreamKeyRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, PendingVerificationException, AwsServiceException, SdkClientException, IvsException
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
deleteStreamKeyRequest - ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionPendingVerificationExceptionSdkException - 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.AwsServiceExceptiondefault DeleteStreamKeyResponse deleteStreamKey(Consumer<DeleteStreamKeyRequest.Builder> deleteStreamKeyRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, PendingVerificationException, AwsServiceException, SdkClientException, IvsException
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
This is a convenience which creates an instance of the DeleteStreamKeyRequest.Builder avoiding the need
to create one manually via DeleteStreamKeyRequest.builder()
deleteStreamKeyRequest - A Consumer that will call methods on DeleteStreamKeyRequest.Builder to create a request.ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionPendingVerificationExceptionSdkException - 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.AwsServiceExceptiondefault GetChannelResponse getChannel(GetChannelRequest getChannelRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, IvsException
Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
getChannelRequest - ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionSdkException - 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.AwsServiceExceptiondefault GetChannelResponse getChannel(Consumer<GetChannelRequest.Builder> getChannelRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, IvsException
Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
This is a convenience which creates an instance of the GetChannelRequest.Builder avoiding the need to
create one manually via GetChannelRequest.builder()
getChannelRequest - A Consumer that will call methods on GetChannelRequest.Builder to create a request.ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionSdkException - 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.AwsServiceExceptiondefault GetPlaybackKeyPairResponse getPlaybackKeyPair(GetPlaybackKeyPairRequest getPlaybackKeyPairRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, IvsException
Gets a specified playback authorization key pair and returns the arn and fingerprint.
The privateKey held by the caller can be used to generate viewer authorization tokens, to grant
viewers access to private channels. For more information, see Setting Up Private Channels in
the Amazon IVS User Guide.
getPlaybackKeyPairRequest - ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionSdkException - 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.AwsServiceExceptiondefault GetPlaybackKeyPairResponse getPlaybackKeyPair(Consumer<GetPlaybackKeyPairRequest.Builder> getPlaybackKeyPairRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, IvsException
Gets a specified playback authorization key pair and returns the arn and fingerprint.
The privateKey held by the caller can be used to generate viewer authorization tokens, to grant
viewers access to private channels. For more information, see Setting Up Private Channels in
the Amazon IVS User Guide.
This is a convenience which creates an instance of the GetPlaybackKeyPairRequest.Builder avoiding the
need to create one manually via GetPlaybackKeyPairRequest.builder()
getPlaybackKeyPairRequest - A Consumer that will call methods on GetPlaybackKeyPairRequest.Builder to create a
request.ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionSdkException - 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.AwsServiceExceptiondefault GetRecordingConfigurationResponse getRecordingConfiguration(GetRecordingConfigurationRequest getRecordingConfigurationRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, IvsException
Gets the recording configuration for the specified ARN.
getRecordingConfigurationRequest - AccessDeniedExceptionInternalServerExceptionResourceNotFoundExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault GetRecordingConfigurationResponse getRecordingConfiguration(Consumer<GetRecordingConfigurationRequest.Builder> getRecordingConfigurationRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, IvsException
Gets the recording configuration for the specified ARN.
This is a convenience which creates an instance of the GetRecordingConfigurationRequest.Builder avoiding
the need to create one manually via GetRecordingConfigurationRequest.builder()
getRecordingConfigurationRequest - A Consumer that will call methods on GetRecordingConfigurationRequest.Builder to create a
request.AccessDeniedExceptionInternalServerExceptionResourceNotFoundExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault GetStreamResponse getStream(GetStreamRequest getStreamRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, ChannelNotBroadcastingException, AwsServiceException, SdkClientException, IvsException
Gets information about the active (live) stream on a specified channel.
getStreamRequest - ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionChannelNotBroadcastingExceptionSdkException - 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.AwsServiceExceptiondefault GetStreamResponse getStream(Consumer<GetStreamRequest.Builder> getStreamRequest) throws ResourceNotFoundException, ValidationException, AccessDeniedException, ChannelNotBroadcastingException, AwsServiceException, SdkClientException, IvsException
Gets information about the active (live) stream on a specified channel.
This is a convenience which creates an instance of the GetStreamRequest.Builder avoiding the need to
create one manually via GetStreamRequest.builder()
getStreamRequest - A Consumer that will call methods on GetStreamRequest.Builder to create a request.ResourceNotFoundExceptionValidationExceptionAccessDeniedExceptionChannelNotBroadcastingExceptionSdkException - 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.AwsServiceExceptiondefault GetStreamKeyResponse getStreamKey(GetStreamKeyRequest getStreamKeyRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, IvsException
Gets stream-key information for a specified ARN.
getStreamKeyRequest - ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionSdkException - 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.AwsServiceExceptiondefault GetStreamKeyResponse getStreamKey(Consumer<GetStreamKeyRequest.Builder> getStreamKeyRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, IvsException
Gets stream-key information for a specified ARN.
This is a convenience which creates an instance of the GetStreamKeyRequest.Builder avoiding the need to
create one manually via GetStreamKeyRequest.builder()
getStreamKeyRequest - A Consumer that will call methods on GetStreamKeyRequest.Builder to create a request.ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionSdkException - 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.AwsServiceExceptiondefault ImportPlaybackKeyPairResponse importPlaybackKeyPair(ImportPlaybackKeyPairRequest importPlaybackKeyPairRequest) throws ValidationException, ConflictException, AccessDeniedException, ServiceQuotaExceededException, PendingVerificationException, AwsServiceException, SdkClientException, IvsException
Imports the public portion of a new key pair and returns its arn and fingerprint. The
privateKey can then be used to generate viewer authorization tokens, to grant viewers access to
private channels. For more information, see Setting Up Private Channels in
the Amazon IVS User Guide.
importPlaybackKeyPairRequest - ValidationExceptionConflictExceptionAccessDeniedExceptionServiceQuotaExceededExceptionPendingVerificationExceptionSdkException - 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.AwsServiceExceptiondefault ImportPlaybackKeyPairResponse importPlaybackKeyPair(Consumer<ImportPlaybackKeyPairRequest.Builder> importPlaybackKeyPairRequest) throws ValidationException, ConflictException, AccessDeniedException, ServiceQuotaExceededException, PendingVerificationException, AwsServiceException, SdkClientException, IvsException
Imports the public portion of a new key pair and returns its arn and fingerprint. The
privateKey can then be used to generate viewer authorization tokens, to grant viewers access to
private channels. For more information, see Setting Up Private Channels in
the Amazon IVS User Guide.
This is a convenience which creates an instance of the ImportPlaybackKeyPairRequest.Builder avoiding the
need to create one manually via ImportPlaybackKeyPairRequest.builder()
importPlaybackKeyPairRequest - A Consumer that will call methods on ImportPlaybackKeyPairRequest.Builder to create a
request.ValidationExceptionConflictExceptionAccessDeniedExceptionServiceQuotaExceededExceptionPendingVerificationExceptionSdkException - 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.AwsServiceExceptiondefault ListChannelsResponse listChannels(ListChannelsRequest listChannelsRequest) throws ValidationException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, IvsException
Gets summary information about all channels in your account, in the AWS region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).
listChannelsRequest - ValidationExceptionAccessDeniedExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault ListChannelsResponse listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest) throws ValidationException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, IvsException
Gets summary information about all channels in your account, in the AWS region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).
This is a convenience which creates an instance of the ListChannelsRequest.Builder avoiding the need to
create one manually via ListChannelsRequest.builder()
listChannelsRequest - A Consumer that will call methods on ListChannelsRequest.Builder to create a request.ValidationExceptionAccessDeniedExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault ListChannelsIterable listChannelsPaginator(ListChannelsRequest listChannelsRequest) throws ValidationException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, IvsException
Gets summary information about all channels in your account, in the AWS region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).
This is a variant of listChannels(software.amazon.awssdk.services.ivs.model.ListChannelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ivs.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ivs.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
for (software.amazon.awssdk.services.ivs.model.ListChannelsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ivs.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannels(software.amazon.awssdk.services.ivs.model.ListChannelsRequest) operation.
listChannelsRequest - ValidationExceptionAccessDeniedExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault ListChannelsIterable listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest) throws ValidationException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, IvsException
Gets summary information about all channels in your account, in the AWS region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).
This is a variant of listChannels(software.amazon.awssdk.services.ivs.model.ListChannelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ivs.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ivs.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
for (software.amazon.awssdk.services.ivs.model.ListChannelsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ivs.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannels(software.amazon.awssdk.services.ivs.model.ListChannelsRequest) operation.
This is a convenience which creates an instance of the ListChannelsRequest.Builder avoiding the need to
create one manually via ListChannelsRequest.builder()
listChannelsRequest - A Consumer that will call methods on ListChannelsRequest.Builder to create a request.ValidationExceptionAccessDeniedExceptionConflictExceptionSdkException - 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.AwsServiceExceptiondefault ListPlaybackKeyPairsResponse listPlaybackKeyPairs(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsException
Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
listPlaybackKeyPairsRequest - ValidationExceptionAccessDeniedExceptionSdkException - 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.AwsServiceExceptiondefault ListPlaybackKeyPairsResponse listPlaybackKeyPairs(Consumer<ListPlaybackKeyPairsRequest.Builder> listPlaybackKeyPairsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsException
Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
This is a convenience which creates an instance of the ListPlaybackKeyPairsRequest.Builder avoiding the
need to create one manually via ListPlaybackKeyPairsRequest.builder()
listPlaybackKeyPairsRequest - A Consumer that will call methods on ListPlaybackKeyPairsRequest.Builder to create a
request.ValidationExceptionAccessDeniedExceptionSdkException - 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.AwsServiceExceptiondefault ListPlaybackKeyPairsIterable listPlaybackKeyPairsPaginator(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsException
Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
This is a variant of
listPlaybackKeyPairs(software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ivs.paginators.ListPlaybackKeyPairsIterable responses = client.listPlaybackKeyPairsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ivs.paginators.ListPlaybackKeyPairsIterable responses = client
.listPlaybackKeyPairsPaginator(request);
for (software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ivs.paginators.ListPlaybackKeyPairsIterable responses = client.listPlaybackKeyPairsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPlaybackKeyPairs(software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsRequest)
operation.
listPlaybackKeyPairsRequest - ValidationExceptionAccessDeniedExceptionSdkException - 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.AwsServiceExceptiondefault ListPlaybackKeyPairsIterable listPlaybackKeyPairsPaginator(Consumer<ListPlaybackKeyPairsRequest.Builder> listPlaybackKeyPairsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsException
Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
This is a variant of
listPlaybackKeyPairs(software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ivs.paginators.ListPlaybackKeyPairsIterable responses = client.listPlaybackKeyPairsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ivs.paginators.ListPlaybackKeyPairsIterable responses = client
.listPlaybackKeyPairsPaginator(request);
for (software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ivs.paginators.ListPlaybackKeyPairsIterable responses = client.listPlaybackKeyPairsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPlaybackKeyPairs(software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsRequest)
operation.
This is a convenience which creates an instance of the ListPlaybackKeyPairsRequest.Builder avoiding the
need to create one manually via ListPlaybackKeyPairsRequest.builder()
listPlaybackKeyPairsRequest - A Consumer that will call methods on ListPlaybackKeyPairsRequest.Builder to create a
request.ValidationExceptionAccessDeniedExceptionSdkException - 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.AwsServiceExceptiondefault ListRecordingConfigurationsResponse listRecordingConfigurations(ListRecordingConfigurationsRequest listRecordingConfigurationsRequest) throws AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IvsException
Gets summary information about all recording configurations in your account, in the AWS region where the API request is processed.
listRecordingConfigurationsRequest - AccessDeniedExceptionInternalServerExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault ListRecordingConfigurationsResponse listRecordingConfigurations(Consumer<ListRecordingConfigurationsRequest.Builder> listRecordingConfigurationsRequest) throws AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IvsException
Gets summary information about all recording configurations in your account, in the AWS region where the API request is processed.
This is a convenience which creates an instance of the ListRecordingConfigurationsRequest.Builder
avoiding the need to create one manually via ListRecordingConfigurationsRequest.builder()
listRecordingConfigurationsRequest - A Consumer that will call methods on ListRecordingConfigurationsRequest.Builder to create
a request.AccessDeniedExceptionInternalServerExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault ListRecordingConfigurationsIterable listRecordingConfigurationsPaginator(ListRecordingConfigurationsRequest listRecordingConfigurationsRequest) throws AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IvsException
Gets summary information about all recording configurations in your account, in the AWS region where the API request is processed.
This is a variant of
listRecordingConfigurations(software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ivs.paginators.ListRecordingConfigurationsIterable responses = client.listRecordingConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ivs.paginators.ListRecordingConfigurationsIterable responses = client
.listRecordingConfigurationsPaginator(request);
for (software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ivs.paginators.ListRecordingConfigurationsIterable responses = client.listRecordingConfigurationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRecordingConfigurations(software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsRequest)
operation.
listRecordingConfigurationsRequest - AccessDeniedExceptionInternalServerExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault ListRecordingConfigurationsIterable listRecordingConfigurationsPaginator(Consumer<ListRecordingConfigurationsRequest.Builder> listRecordingConfigurationsRequest) throws AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IvsException
Gets summary information about all recording configurations in your account, in the AWS region where the API request is processed.
This is a variant of
listRecordingConfigurations(software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ivs.paginators.ListRecordingConfigurationsIterable responses = client.listRecordingConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ivs.paginators.ListRecordingConfigurationsIterable responses = client
.listRecordingConfigurationsPaginator(request);
for (software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ivs.paginators.ListRecordingConfigurationsIterable responses = client.listRecordingConfigurationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRecordingConfigurations(software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsRequest)
operation.
This is a convenience which creates an instance of the ListRecordingConfigurationsRequest.Builder
avoiding the need to create one manually via ListRecordingConfigurationsRequest.builder()
listRecordingConfigurationsRequest - A Consumer that will call methods on ListRecordingConfigurationsRequest.Builder to create
a request.AccessDeniedExceptionInternalServerExceptionValidationExceptionSdkException - 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.AwsServiceExceptiondefault ListStreamKeysResponse listStreamKeys(ListStreamKeysRequest listStreamKeysRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, IvsException
Gets summary information about stream keys for the specified channel.
listStreamKeysRequest - ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionSdkException - 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.AwsServiceExceptiondefault ListStreamKeysResponse listStreamKeys(Consumer<ListStreamKeysRequest.Builder> listStreamKeysRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, IvsException
Gets summary information about stream keys for the specified channel.
This is a convenience which creates an instance of the ListStreamKeysRequest.Builder avoiding the need to
create one manually via ListStreamKeysRequest.builder()
listStreamKeysRequest - A Consumer that will call methods on ListStreamKeysRequest.Builder to create a request.ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionSdkException - 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.AwsServiceExceptiondefault ListStreamKeysIterable listStreamKeysPaginator(ListStreamKeysRequest listStreamKeysRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, IvsException
Gets summary information about stream keys for the specified channel.
This is a variant of listStreamKeys(software.amazon.awssdk.services.ivs.model.ListStreamKeysRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ivs.paginators.ListStreamKeysIterable responses = client.listStreamKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ivs.paginators.ListStreamKeysIterable responses = client.listStreamKeysPaginator(request);
for (software.amazon.awssdk.services.ivs.model.ListStreamKeysResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ivs.paginators.ListStreamKeysIterable responses = client.listStreamKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreamKeys(software.amazon.awssdk.services.ivs.model.ListStreamKeysRequest) operation.
listStreamKeysRequest - ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionSdkException - 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.AwsServiceExceptiondefault ListStreamKeysIterable listStreamKeysPaginator(Consumer<ListStreamKeysRequest.Builder> listStreamKeysRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, IvsException
Gets summary information about stream keys for the specified channel.
This is a variant of listStreamKeys(software.amazon.awssdk.services.ivs.model.ListStreamKeysRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ivs.paginators.ListStreamKeysIterable responses = client.listStreamKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ivs.paginators.ListStreamKeysIterable responses = client.listStreamKeysPaginator(request);
for (software.amazon.awssdk.services.ivs.model.ListStreamKeysResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ivs.paginators.ListStreamKeysIterable responses = client.listStreamKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreamKeys(software.amazon.awssdk.services.ivs.model.ListStreamKeysRequest) operation.
This is a convenience which creates an instance of the ListStreamKeysRequest.Builder avoiding the need to
create one manually via ListStreamKeysRequest.builder()
listStreamKeysRequest - A Consumer that will call methods on ListStreamKeysRequest.Builder to create a request.ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionSdkException - 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.AwsServiceExceptiondefault ListStreamsResponse listStreams(ListStreamsRequest listStreamsRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, IvsException
Gets summary information about live streams in your account, in the AWS region where the API request is processed.
listStreamsRequest - AccessDeniedExceptionSdkException - 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.AwsServiceExceptiondefault ListStreamsResponse listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, IvsException
Gets summary information about live streams in your account, in the AWS region where the API request is processed.
This is a convenience which creates an instance of the ListStreamsRequest.Builder avoiding the need to
create one manually via ListStreamsRequest.builder()
listStreamsRequest - A Consumer that will call methods on ListStreamsRequest.Builder to create a request.AccessDeniedExceptionSdkException - 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.AwsServiceExceptiondefault ListStreamsIterable listStreamsPaginator(ListStreamsRequest listStreamsRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, IvsException
Gets summary information about live streams in your account, in the AWS region where the API request is processed.
This is a variant of listStreams(software.amazon.awssdk.services.ivs.model.ListStreamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ivs.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ivs.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
for (software.amazon.awssdk.services.ivs.model.ListStreamsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ivs.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.ivs.model.ListStreamsRequest) operation.
listStreamsRequest - AccessDeniedExceptionSdkException - 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.AwsServiceExceptiondefault ListStreamsIterable listStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, IvsException
Gets summary information about live streams in your account, in the AWS region where the API request is processed.
This is a variant of listStreams(software.amazon.awssdk.services.ivs.model.ListStreamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ivs.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ivs.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
for (software.amazon.awssdk.services.ivs.model.ListStreamsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ivs.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.ivs.model.ListStreamsRequest) operation.
This is a convenience which creates an instance of the ListStreamsRequest.Builder avoiding the need to
create one manually via ListStreamsRequest.builder()
listStreamsRequest - A Consumer that will call methods on ListStreamsRequest.Builder to create a request.AccessDeniedExceptionSdkException - 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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IvsException
Gets information about AWS tags for the specified ARN.
listTagsForResourceRequest - InternalServerExceptionValidationExceptionResourceNotFoundExceptionSdkException - 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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IvsException
Gets information about AWS tags for the specified ARN.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.InternalServerExceptionValidationExceptionResourceNotFoundExceptionSdkException - 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.AwsServiceExceptiondefault ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IvsException
Gets information about AWS tags for the specified ARN.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.ivs.model.ListTagsForResourceRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ivs.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ivs.paginators.ListTagsForResourceIterable responses = client
.listTagsForResourcePaginator(request);
for (software.amazon.awssdk.services.ivs.model.ListTagsForResourceResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ivs.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.ivs.model.ListTagsForResourceRequest) operation.
listTagsForResourceRequest - InternalServerExceptionValidationExceptionResourceNotFoundExceptionSdkException - 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.AwsServiceExceptiondefault ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IvsException
Gets information about AWS tags for the specified ARN.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.ivs.model.ListTagsForResourceRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ivs.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ivs.paginators.ListTagsForResourceIterable responses = client
.listTagsForResourcePaginator(request);
for (software.amazon.awssdk.services.ivs.model.ListTagsForResourceResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ivs.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.ivs.model.ListTagsForResourceRequest) operation.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.InternalServerExceptionValidationExceptionResourceNotFoundExceptionSdkException - 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.AwsServiceExceptiondefault PutMetadataResponse putMetadata(PutMetadataRequest putMetadataRequest) throws ThrottlingException, ResourceNotFoundException, ChannelNotBroadcastingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsException
Inserts metadata into the active stream of the specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.
putMetadataRequest - ThrottlingExceptionResourceNotFoundExceptionChannelNotBroadcastingExceptionValidationExceptionAccessDeniedExceptionSdkException - 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.AwsServiceExceptiondefault PutMetadataResponse putMetadata(Consumer<PutMetadataRequest.Builder> putMetadataRequest) throws ThrottlingException, ResourceNotFoundException, ChannelNotBroadcastingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, IvsException
Inserts metadata into the active stream of the specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.
This is a convenience which creates an instance of the PutMetadataRequest.Builder avoiding the need to
create one manually via PutMetadataRequest.builder()
putMetadataRequest - A Consumer that will call methods on PutMetadataRequest.Builder to create a request.ThrottlingExceptionResourceNotFoundExceptionChannelNotBroadcastingExceptionValidationExceptionAccessDeniedExceptionSdkException - 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.AwsServiceExceptiondefault StopStreamResponse stopStream(StopStreamRequest stopStreamRequest) throws ResourceNotFoundException, ChannelNotBroadcastingException, ValidationException, AccessDeniedException, StreamUnavailableException, AwsServiceException, SdkClientException, IvsException
Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.
Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream
permanently, you may want to first revoke the streamKey attached to the channel.
stopStreamRequest - ResourceNotFoundExceptionChannelNotBroadcastingExceptionValidationExceptionAccessDeniedExceptionStreamUnavailableExceptionSdkException - 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.AwsServiceExceptiondefault StopStreamResponse stopStream(Consumer<StopStreamRequest.Builder> stopStreamRequest) throws ResourceNotFoundException, ChannelNotBroadcastingException, ValidationException, AccessDeniedException, StreamUnavailableException, AwsServiceException, SdkClientException, IvsException
Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.
Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream
permanently, you may want to first revoke the streamKey attached to the channel.
This is a convenience which creates an instance of the StopStreamRequest.Builder avoiding the need to
create one manually via StopStreamRequest.builder()
stopStreamRequest - A Consumer that will call methods on StopStreamRequest.Builder to create a request.ResourceNotFoundExceptionChannelNotBroadcastingExceptionValidationExceptionAccessDeniedExceptionStreamUnavailableExceptionSdkException - 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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IvsException
Adds or updates tags for the AWS resource with the specified ARN.
tagResourceRequest - InternalServerExceptionValidationExceptionResourceNotFoundExceptionSdkException - 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.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IvsException
Adds or updates tags for the AWS resource with the specified ARN.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.InternalServerExceptionValidationExceptionResourceNotFoundExceptionSdkException - 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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IvsException
Removes tags from the resource with the specified ARN.
untagResourceRequest - InternalServerExceptionValidationExceptionResourceNotFoundExceptionSdkException - 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.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IvsException
Removes tags from the resource with the specified ARN.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.InternalServerExceptionValidationExceptionResourceNotFoundExceptionSdkException - 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.AwsServiceExceptiondefault UpdateChannelResponse updateChannel(UpdateChannelRequest updateChannelRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ConflictException, PendingVerificationException, AwsServiceException, SdkClientException, IvsException
Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.
updateChannelRequest - ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionConflictExceptionPendingVerificationExceptionSdkException - 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.AwsServiceExceptiondefault UpdateChannelResponse updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ConflictException, PendingVerificationException, AwsServiceException, SdkClientException, IvsException
Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.
This is a convenience which creates an instance of the UpdateChannelRequest.Builder avoiding the need to
create one manually via UpdateChannelRequest.builder()
updateChannelRequest - A Consumer that will call methods on UpdateChannelRequest.Builder to create a request.ValidationExceptionAccessDeniedExceptionResourceNotFoundExceptionConflictExceptionPendingVerificationExceptionSdkException - 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.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()