software.amazon.awssdk.services.ivs.IvsClient Maven / Gradle / Ivy
Show all versions of ivs Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.ivs;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.ivs.model.AccessDeniedException;
import software.amazon.awssdk.services.ivs.model.BatchGetChannelRequest;
import software.amazon.awssdk.services.ivs.model.BatchGetChannelResponse;
import software.amazon.awssdk.services.ivs.model.BatchGetStreamKeyRequest;
import software.amazon.awssdk.services.ivs.model.BatchGetStreamKeyResponse;
import software.amazon.awssdk.services.ivs.model.BatchStartViewerSessionRevocationRequest;
import software.amazon.awssdk.services.ivs.model.BatchStartViewerSessionRevocationResponse;
import software.amazon.awssdk.services.ivs.model.ChannelNotBroadcastingException;
import software.amazon.awssdk.services.ivs.model.ConflictException;
import software.amazon.awssdk.services.ivs.model.CreateChannelRequest;
import software.amazon.awssdk.services.ivs.model.CreateChannelResponse;
import software.amazon.awssdk.services.ivs.model.CreatePlaybackRestrictionPolicyRequest;
import software.amazon.awssdk.services.ivs.model.CreatePlaybackRestrictionPolicyResponse;
import software.amazon.awssdk.services.ivs.model.CreateRecordingConfigurationRequest;
import software.amazon.awssdk.services.ivs.model.CreateRecordingConfigurationResponse;
import software.amazon.awssdk.services.ivs.model.CreateStreamKeyRequest;
import software.amazon.awssdk.services.ivs.model.CreateStreamKeyResponse;
import software.amazon.awssdk.services.ivs.model.DeleteChannelRequest;
import software.amazon.awssdk.services.ivs.model.DeleteChannelResponse;
import software.amazon.awssdk.services.ivs.model.DeletePlaybackKeyPairRequest;
import software.amazon.awssdk.services.ivs.model.DeletePlaybackKeyPairResponse;
import software.amazon.awssdk.services.ivs.model.DeletePlaybackRestrictionPolicyRequest;
import software.amazon.awssdk.services.ivs.model.DeletePlaybackRestrictionPolicyResponse;
import software.amazon.awssdk.services.ivs.model.DeleteRecordingConfigurationRequest;
import software.amazon.awssdk.services.ivs.model.DeleteRecordingConfigurationResponse;
import software.amazon.awssdk.services.ivs.model.DeleteStreamKeyRequest;
import software.amazon.awssdk.services.ivs.model.DeleteStreamKeyResponse;
import software.amazon.awssdk.services.ivs.model.GetChannelRequest;
import software.amazon.awssdk.services.ivs.model.GetChannelResponse;
import software.amazon.awssdk.services.ivs.model.GetPlaybackKeyPairRequest;
import software.amazon.awssdk.services.ivs.model.GetPlaybackKeyPairResponse;
import software.amazon.awssdk.services.ivs.model.GetPlaybackRestrictionPolicyRequest;
import software.amazon.awssdk.services.ivs.model.GetPlaybackRestrictionPolicyResponse;
import software.amazon.awssdk.services.ivs.model.GetRecordingConfigurationRequest;
import software.amazon.awssdk.services.ivs.model.GetRecordingConfigurationResponse;
import software.amazon.awssdk.services.ivs.model.GetStreamKeyRequest;
import software.amazon.awssdk.services.ivs.model.GetStreamKeyResponse;
import software.amazon.awssdk.services.ivs.model.GetStreamRequest;
import software.amazon.awssdk.services.ivs.model.GetStreamResponse;
import software.amazon.awssdk.services.ivs.model.GetStreamSessionRequest;
import software.amazon.awssdk.services.ivs.model.GetStreamSessionResponse;
import software.amazon.awssdk.services.ivs.model.ImportPlaybackKeyPairRequest;
import software.amazon.awssdk.services.ivs.model.ImportPlaybackKeyPairResponse;
import software.amazon.awssdk.services.ivs.model.InternalServerException;
import software.amazon.awssdk.services.ivs.model.IvsException;
import software.amazon.awssdk.services.ivs.model.ListChannelsRequest;
import software.amazon.awssdk.services.ivs.model.ListChannelsResponse;
import software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsRequest;
import software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsResponse;
import software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesRequest;
import software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesResponse;
import software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsRequest;
import software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsResponse;
import software.amazon.awssdk.services.ivs.model.ListStreamKeysRequest;
import software.amazon.awssdk.services.ivs.model.ListStreamKeysResponse;
import software.amazon.awssdk.services.ivs.model.ListStreamSessionsRequest;
import software.amazon.awssdk.services.ivs.model.ListStreamSessionsResponse;
import software.amazon.awssdk.services.ivs.model.ListStreamsRequest;
import software.amazon.awssdk.services.ivs.model.ListStreamsResponse;
import software.amazon.awssdk.services.ivs.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.ivs.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.ivs.model.PendingVerificationException;
import software.amazon.awssdk.services.ivs.model.PutMetadataRequest;
import software.amazon.awssdk.services.ivs.model.PutMetadataResponse;
import software.amazon.awssdk.services.ivs.model.ResourceNotFoundException;
import software.amazon.awssdk.services.ivs.model.ServiceQuotaExceededException;
import software.amazon.awssdk.services.ivs.model.StartViewerSessionRevocationRequest;
import software.amazon.awssdk.services.ivs.model.StartViewerSessionRevocationResponse;
import software.amazon.awssdk.services.ivs.model.StopStreamRequest;
import software.amazon.awssdk.services.ivs.model.StopStreamResponse;
import software.amazon.awssdk.services.ivs.model.StreamUnavailableException;
import software.amazon.awssdk.services.ivs.model.TagResourceRequest;
import software.amazon.awssdk.services.ivs.model.TagResourceResponse;
import software.amazon.awssdk.services.ivs.model.ThrottlingException;
import software.amazon.awssdk.services.ivs.model.UntagResourceRequest;
import software.amazon.awssdk.services.ivs.model.UntagResourceResponse;
import software.amazon.awssdk.services.ivs.model.UpdateChannelRequest;
import software.amazon.awssdk.services.ivs.model.UpdateChannelResponse;
import software.amazon.awssdk.services.ivs.model.UpdatePlaybackRestrictionPolicyRequest;
import software.amazon.awssdk.services.ivs.model.UpdatePlaybackRestrictionPolicyResponse;
import software.amazon.awssdk.services.ivs.model.ValidationException;
import software.amazon.awssdk.services.ivs.paginators.ListChannelsIterable;
import software.amazon.awssdk.services.ivs.paginators.ListPlaybackKeyPairsIterable;
import software.amazon.awssdk.services.ivs.paginators.ListPlaybackRestrictionPoliciesIterable;
import software.amazon.awssdk.services.ivs.paginators.ListRecordingConfigurationsIterable;
import software.amazon.awssdk.services.ivs.paginators.ListStreamKeysIterable;
import software.amazon.awssdk.services.ivs.paginators.ListStreamSessionsIterable;
import software.amazon.awssdk.services.ivs.paginators.ListStreamsIterable;
/**
* Service client for accessing Amazon IVS. This can be created using the static {@link #builder()} method.
*
*
* Introduction
*
*
* The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web
* Services EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
*
*
* The API is an Amazon Web Services regional service. For a list of supported regions and Amazon IVS HTTPS service
* endpoints, see the Amazon IVS page in the
* Amazon Web Services General Reference.
*
*
* All API request parameters and URLs are case sensitive.
*
*
* For a summary of notable documentation changes in each release, see Document History.
*
*
* Allowed Header Values
*
*
* -
*
* Accept: application/json
*
*
* -
*
* Accept-Encoding: gzip, deflate
*
*
* -
*
* Content-Type: application/json
*
*
*
*
* Key Concepts
*
*
* -
*
* 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.
*
*
* -
*
* Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize
* streaming. 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.
*
*
* -
*
* 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.
*
*
* -
*
* Playback restriction policy — Restricts playback by countries and/or origin sites.
*
*
*
*
* For more information about your IVS live stream, also see Getting Started with IVS
* Low-Latency Streaming.
*
*
* Tagging
*
*
* A tag is a metadata label that you assign to an Amazon Web Services resource. A tag comprises a key and
* a value, both set by you. For example, you might set a tag as topic:nature to label a particular
* video category. See Best practices and
* strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions
* that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond
* what is documented there.
*
*
* Tags can help you identify and organize your Amazon Web Services resources. For example, you can use the same tag for
* different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
*
*
* The Amazon IVS API has these tag-related operations: TagResource, UntagResource, and
* ListTagsForResource. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and
* Recording Configurations.
*
*
* At most 50 tags can be applied to a resource.
*
*
* Authentication versus Authorization
*
*
* Note the differences between these concepts:
*
*
* -
*
* Authentication is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.
*
*
* -
*
* Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS API
* requests. In addition, authorization is needed to view Amazon IVS private channels.
* (Private channels are channels that are enabled for "playback authorization.")
*
*
*
*
* Authentication
*
*
* All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services Command-Line Interface
* (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application
* calls the Amazon IVS API directly, it’s your responsibility to sign the requests.
*
*
* You generate a signature using valid Amazon Web Services credentials that have permission to perform the requested
* action. For example, you must sign PutMetadata requests with a signature generated from a user account that has the
* ivs:PutMetadata permission.
*
*
* For more information:
*
*
* -
*
* Authentication and generating signatures — See Authenticating Requests
* (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.
*
*
* -
*
* Managing Amazon IVS permissions — See Identity and Access Management on the
* Security page of the Amazon IVS User Guide.
*
*
*
*
* Amazon Resource Names (ARNs)
*
*
* ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all
* of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Names in the
* AWS General Reference.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface IvsClient extends AwsClient {
String SERVICE_NAME = "ivs";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "ivs";
/**
*
* Performs GetChannel on multiple ARNs simultaneously.
*
*
* @param batchGetChannelRequest
* @return Result of the BatchGetChannel operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.BatchGetChannel
* @see AWS API
* Documentation
*/
default BatchGetChannelResponse batchGetChannel(BatchGetChannelRequest batchGetChannelRequest) throws AwsServiceException,
SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Performs GetChannel on multiple ARNs simultaneously.
*
*
*
* This is a convenience which creates an instance of the {@link BatchGetChannelRequest.Builder} avoiding the need
* to create one manually via {@link BatchGetChannelRequest#builder()}
*
*
* @param batchGetChannelRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.BatchGetChannelRequest.Builder} to create a request.
* @return Result of the BatchGetChannel operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.BatchGetChannel
* @see AWS API
* Documentation
*/
default BatchGetChannelResponse batchGetChannel(Consumer batchGetChannelRequest)
throws AwsServiceException, SdkClientException, IvsException {
return batchGetChannel(BatchGetChannelRequest.builder().applyMutation(batchGetChannelRequest).build());
}
/**
*
* Performs GetStreamKey on multiple ARNs simultaneously.
*
*
* @param batchGetStreamKeyRequest
* @return Result of the BatchGetStreamKey operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.BatchGetStreamKey
* @see AWS API
* Documentation
*/
default BatchGetStreamKeyResponse batchGetStreamKey(BatchGetStreamKeyRequest batchGetStreamKeyRequest)
throws AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Performs GetStreamKey on multiple ARNs simultaneously.
*
*
*
* This is a convenience which creates an instance of the {@link BatchGetStreamKeyRequest.Builder} avoiding the need
* to create one manually via {@link BatchGetStreamKeyRequest#builder()}
*
*
* @param batchGetStreamKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.BatchGetStreamKeyRequest.Builder} to create a request.
* @return Result of the BatchGetStreamKey operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.BatchGetStreamKey
* @see AWS API
* Documentation
*/
default BatchGetStreamKeyResponse batchGetStreamKey(Consumer batchGetStreamKeyRequest)
throws AwsServiceException, SdkClientException, IvsException {
return batchGetStreamKey(BatchGetStreamKeyRequest.builder().applyMutation(batchGetStreamKeyRequest).build());
}
/**
*
* Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
*
*
* @param batchStartViewerSessionRevocationRequest
* @return Result of the BatchStartViewerSessionRevocation operation returned by the service.
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ThrottlingException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.BatchStartViewerSessionRevocation
* @see AWS API Documentation
*/
default BatchStartViewerSessionRevocationResponse batchStartViewerSessionRevocation(
BatchStartViewerSessionRevocationRequest batchStartViewerSessionRevocationRequest) throws AccessDeniedException,
ValidationException, PendingVerificationException, ThrottlingException, AwsServiceException, SdkClientException,
IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
*
*
*
* This is a convenience which creates an instance of the {@link BatchStartViewerSessionRevocationRequest.Builder}
* avoiding the need to create one manually via {@link BatchStartViewerSessionRevocationRequest#builder()}
*
*
* @param batchStartViewerSessionRevocationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.BatchStartViewerSessionRevocationRequest.Builder} to
* create a request.
* @return Result of the BatchStartViewerSessionRevocation operation returned by the service.
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ThrottlingException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.BatchStartViewerSessionRevocation
* @see AWS API Documentation
*/
default BatchStartViewerSessionRevocationResponse batchStartViewerSessionRevocation(
Consumer batchStartViewerSessionRevocationRequest)
throws AccessDeniedException, ValidationException, PendingVerificationException, ThrottlingException,
AwsServiceException, SdkClientException, IvsException {
return batchStartViewerSessionRevocation(BatchStartViewerSessionRevocationRequest.builder()
.applyMutation(batchStartViewerSessionRevocationRequest).build());
}
/**
*
* Creates a new channel and an associated stream key to start streaming.
*
*
* @param createChannelRequest
* @return Result of the CreateChannel operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ServiceQuotaExceededException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.CreateChannel
* @see AWS API
* Documentation
*/
default CreateChannelResponse createChannel(CreateChannelRequest createChannelRequest) throws ResourceNotFoundException,
AccessDeniedException, ValidationException, PendingVerificationException, ServiceQuotaExceededException,
AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new channel and an associated stream key to start streaming.
*
*
*
* This is a convenience which creates an instance of the {@link CreateChannelRequest.Builder} avoiding the need to
* create one manually via {@link CreateChannelRequest#builder()}
*
*
* @param createChannelRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.CreateChannelRequest.Builder} to create a request.
* @return Result of the CreateChannel operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ServiceQuotaExceededException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.CreateChannel
* @see AWS API
* Documentation
*/
default CreateChannelResponse createChannel(Consumer createChannelRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, PendingVerificationException,
ServiceQuotaExceededException, AwsServiceException, SdkClientException, IvsException {
return createChannel(CreateChannelRequest.builder().applyMutation(createChannelRequest).build());
}
/**
*
* Creates a new playback restriction policy, for constraining playback by countries and/or origins.
*
*
* @param createPlaybackRestrictionPolicyRequest
* @return Result of the CreatePlaybackRestrictionPolicy operation returned by the service.
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ThrottlingException
* @throws ServiceQuotaExceededException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.CreatePlaybackRestrictionPolicy
* @see AWS API Documentation
*/
default CreatePlaybackRestrictionPolicyResponse createPlaybackRestrictionPolicy(
CreatePlaybackRestrictionPolicyRequest createPlaybackRestrictionPolicyRequest) throws AccessDeniedException,
ValidationException, PendingVerificationException, ThrottlingException, ServiceQuotaExceededException,
AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new playback restriction policy, for constraining playback by countries and/or origins.
*
*
*
* This is a convenience which creates an instance of the {@link CreatePlaybackRestrictionPolicyRequest.Builder}
* avoiding the need to create one manually via {@link CreatePlaybackRestrictionPolicyRequest#builder()}
*
*
* @param createPlaybackRestrictionPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.CreatePlaybackRestrictionPolicyRequest.Builder} to create
* a request.
* @return Result of the CreatePlaybackRestrictionPolicy operation returned by the service.
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ThrottlingException
* @throws ServiceQuotaExceededException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.CreatePlaybackRestrictionPolicy
* @see AWS API Documentation
*/
default CreatePlaybackRestrictionPolicyResponse createPlaybackRestrictionPolicy(
Consumer createPlaybackRestrictionPolicyRequest)
throws AccessDeniedException, ValidationException, PendingVerificationException, ThrottlingException,
ServiceQuotaExceededException, AwsServiceException, SdkClientException, IvsException {
return createPlaybackRestrictionPolicy(CreatePlaybackRestrictionPolicyRequest.builder()
.applyMutation(createPlaybackRestrictionPolicyRequest).build());
}
/**
*
* Creates a new recording configuration, used to enable recording to Amazon S3.
*
*
* Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording
* configuration, it returns success even if the S3 bucket is in a different region. In this case, the
* state of the recording configuration is CREATE_FAILED (instead of ACTIVE).
* (In other regions, the CLI correctly returns failure if the bucket is in a different region.)
*
*
* Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create
* a recording configuration in a different region as your S3 bucket, delete that recording configuration and create
* a new one with an S3 bucket from the correct region.
*
*
* @param createRecordingConfigurationRequest
* @return Result of the CreateRecordingConfiguration operation returned by the service.
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ConflictException
* @throws ServiceQuotaExceededException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.CreateRecordingConfiguration
* @see AWS API Documentation
*/
default CreateRecordingConfigurationResponse createRecordingConfiguration(
CreateRecordingConfigurationRequest createRecordingConfigurationRequest) throws InternalServerException,
AccessDeniedException, ValidationException, PendingVerificationException, ConflictException,
ServiceQuotaExceededException, AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new recording configuration, used to enable recording to Amazon S3.
*
*
* Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording
* configuration, it returns success even if the S3 bucket is in a different region. In this case, the
* state of the recording configuration is CREATE_FAILED (instead of ACTIVE).
* (In other regions, the CLI correctly returns failure if the bucket is in a different region.)
*
*
* Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create
* a recording configuration in a different region as your S3 bucket, delete that recording configuration and create
* a new one with an S3 bucket from the correct region.
*
*
*
* This is a convenience which creates an instance of the {@link CreateRecordingConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link CreateRecordingConfigurationRequest#builder()}
*
*
* @param createRecordingConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.CreateRecordingConfigurationRequest.Builder} to create a
* request.
* @return Result of the CreateRecordingConfiguration operation returned by the service.
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ConflictException
* @throws ServiceQuotaExceededException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.CreateRecordingConfiguration
* @see AWS API Documentation
*/
default CreateRecordingConfigurationResponse createRecordingConfiguration(
Consumer createRecordingConfigurationRequest)
throws InternalServerException, AccessDeniedException, ValidationException, PendingVerificationException,
ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IvsException {
return createRecordingConfiguration(CreateRecordingConfigurationRequest.builder()
.applyMutation(createRecordingConfigurationRequest).build());
}
/**
*
* 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.
*
*
* @param createStreamKeyRequest
* @return Result of the CreateStreamKey operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ServiceQuotaExceededException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.CreateStreamKey
* @see AWS API
* Documentation
*/
default CreateStreamKeyResponse createStreamKey(CreateStreamKeyRequest createStreamKeyRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, PendingVerificationException,
ServiceQuotaExceededException, AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateStreamKeyRequest.Builder} avoiding the need
* to create one manually via {@link CreateStreamKeyRequest#builder()}
*
*
* @param createStreamKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.CreateStreamKeyRequest.Builder} to create a request.
* @return Result of the CreateStreamKey operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ServiceQuotaExceededException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.CreateStreamKey
* @see AWS API
* Documentation
*/
default CreateStreamKeyResponse createStreamKey(Consumer createStreamKeyRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, PendingVerificationException,
ServiceQuotaExceededException, AwsServiceException, SdkClientException, IvsException {
return createStreamKey(CreateStreamKeyRequest.builder().applyMutation(createStreamKeyRequest).build());
}
/**
*
* Deletes the specified channel and its associated stream keys.
*
*
* If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is
* live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's
* state is no longer Live), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)
*
*
* @param deleteChannelRequest
* @return Result of the DeleteChannel operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ConflictException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.DeleteChannel
* @see AWS API
* Documentation
*/
default DeleteChannelResponse deleteChannel(DeleteChannelRequest deleteChannelRequest) throws ResourceNotFoundException,
AccessDeniedException, ValidationException, PendingVerificationException, ConflictException, AwsServiceException,
SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified channel and its associated stream keys.
*
*
* If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is
* live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's
* state is no longer Live), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)
*
*
*
* This is a convenience which creates an instance of the {@link DeleteChannelRequest.Builder} avoiding the need to
* create one manually via {@link DeleteChannelRequest#builder()}
*
*
* @param deleteChannelRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.DeleteChannelRequest.Builder} to create a request.
* @return Result of the DeleteChannel operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ConflictException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.DeleteChannel
* @see AWS API
* Documentation
*/
default DeleteChannelResponse deleteChannel(Consumer deleteChannelRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, PendingVerificationException,
ConflictException, AwsServiceException, SdkClientException, IvsException {
return deleteChannel(DeleteChannelRequest.builder().applyMutation(deleteChannelRequest).build());
}
/**
*
* 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.
*
*
* @param deletePlaybackKeyPairRequest
* @return Result of the DeletePlaybackKeyPair operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.DeletePlaybackKeyPair
* @see AWS API
* Documentation
*/
default DeletePlaybackKeyPairResponse deletePlaybackKeyPair(DeletePlaybackKeyPairRequest deletePlaybackKeyPairRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, PendingVerificationException,
AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeletePlaybackKeyPairRequest.Builder} avoiding the
* need to create one manually via {@link DeletePlaybackKeyPairRequest#builder()}
*
*
* @param deletePlaybackKeyPairRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.DeletePlaybackKeyPairRequest.Builder} to create a
* request.
* @return Result of the DeletePlaybackKeyPair operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.DeletePlaybackKeyPair
* @see AWS API
* Documentation
*/
default DeletePlaybackKeyPairResponse deletePlaybackKeyPair(
Consumer deletePlaybackKeyPairRequest) throws ResourceNotFoundException,
AccessDeniedException, ValidationException, PendingVerificationException, AwsServiceException, SdkClientException,
IvsException {
return deletePlaybackKeyPair(DeletePlaybackKeyPairRequest.builder().applyMutation(deletePlaybackKeyPairRequest).build());
}
/**
*
* Deletes the specified playback restriction policy.
*
*
* @param deletePlaybackRestrictionPolicyRequest
* @return Result of the DeletePlaybackRestrictionPolicy operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ConflictException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.DeletePlaybackRestrictionPolicy
* @see AWS API Documentation
*/
default DeletePlaybackRestrictionPolicyResponse deletePlaybackRestrictionPolicy(
DeletePlaybackRestrictionPolicyRequest deletePlaybackRestrictionPolicyRequest) throws ResourceNotFoundException,
AccessDeniedException, ValidationException, PendingVerificationException, ConflictException, AwsServiceException,
SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified playback restriction policy.
*
*
*
* This is a convenience which creates an instance of the {@link DeletePlaybackRestrictionPolicyRequest.Builder}
* avoiding the need to create one manually via {@link DeletePlaybackRestrictionPolicyRequest#builder()}
*
*
* @param deletePlaybackRestrictionPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.DeletePlaybackRestrictionPolicyRequest.Builder} to create
* a request.
* @return Result of the DeletePlaybackRestrictionPolicy operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ConflictException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.DeletePlaybackRestrictionPolicy
* @see AWS API Documentation
*/
default DeletePlaybackRestrictionPolicyResponse deletePlaybackRestrictionPolicy(
Consumer deletePlaybackRestrictionPolicyRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, PendingVerificationException,
ConflictException, AwsServiceException, SdkClientException, IvsException {
return deletePlaybackRestrictionPolicy(DeletePlaybackRestrictionPolicyRequest.builder()
.applyMutation(deletePlaybackRestrictionPolicyRequest).build());
}
/**
*
* 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.
*
*
* @param deleteRecordingConfigurationRequest
* @return Result of the DeleteRecordingConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws ConflictException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.DeleteRecordingConfiguration
* @see AWS API Documentation
*/
default DeleteRecordingConfigurationResponse deleteRecordingConfiguration(
DeleteRecordingConfigurationRequest deleteRecordingConfigurationRequest) throws ResourceNotFoundException,
InternalServerException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException,
SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteRecordingConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link DeleteRecordingConfigurationRequest#builder()}
*
*
* @param deleteRecordingConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.DeleteRecordingConfigurationRequest.Builder} to create a
* request.
* @return Result of the DeleteRecordingConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws ConflictException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.DeleteRecordingConfiguration
* @see AWS API Documentation
*/
default DeleteRecordingConfigurationResponse deleteRecordingConfiguration(
Consumer deleteRecordingConfigurationRequest)
throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException,
ConflictException, AwsServiceException, SdkClientException, IvsException {
return deleteRecordingConfiguration(DeleteRecordingConfigurationRequest.builder()
.applyMutation(deleteRecordingConfigurationRequest).build());
}
/**
*
* Deletes the stream key for the specified ARN, so it can no longer be used to stream.
*
*
* @param deleteStreamKeyRequest
* @return Result of the DeleteStreamKey operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.DeleteStreamKey
* @see AWS API
* Documentation
*/
default DeleteStreamKeyResponse deleteStreamKey(DeleteStreamKeyRequest deleteStreamKeyRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, PendingVerificationException,
AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteStreamKeyRequest.Builder} avoiding the need
* to create one manually via {@link DeleteStreamKeyRequest#builder()}
*
*
* @param deleteStreamKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.DeleteStreamKeyRequest.Builder} to create a request.
* @return Result of the DeleteStreamKey operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.DeleteStreamKey
* @see AWS API
* Documentation
*/
default DeleteStreamKeyResponse deleteStreamKey(Consumer deleteStreamKeyRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, PendingVerificationException,
AwsServiceException, SdkClientException, IvsException {
return deleteStreamKey(DeleteStreamKeyRequest.builder().applyMutation(deleteStreamKeyRequest).build());
}
/**
*
* Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
*
*
* @param getChannelRequest
* @return Result of the GetChannel operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.GetChannel
* @see AWS API
* Documentation
*/
default GetChannelResponse getChannel(GetChannelRequest getChannelRequest) throws ResourceNotFoundException,
AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
*
*
*
* This is a convenience which creates an instance of the {@link GetChannelRequest.Builder} avoiding the need to
* create one manually via {@link GetChannelRequest#builder()}
*
*
* @param getChannelRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.GetChannelRequest.Builder} to create a request.
* @return Result of the GetChannel operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.GetChannel
* @see AWS API
* Documentation
*/
default GetChannelResponse getChannel(Consumer getChannelRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException,
SdkClientException, IvsException {
return getChannel(GetChannelRequest.builder().applyMutation(getChannelRequest).build());
}
/**
*
* 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.
*
*
* @param getPlaybackKeyPairRequest
* @return Result of the GetPlaybackKeyPair operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.GetPlaybackKeyPair
* @see AWS API
* Documentation
*/
default GetPlaybackKeyPairResponse getPlaybackKeyPair(GetPlaybackKeyPairRequest getPlaybackKeyPairRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException,
SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetPlaybackKeyPairRequest.Builder} avoiding the
* need to create one manually via {@link GetPlaybackKeyPairRequest#builder()}
*
*
* @param getPlaybackKeyPairRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.GetPlaybackKeyPairRequest.Builder} to create a request.
* @return Result of the GetPlaybackKeyPair operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.GetPlaybackKeyPair
* @see AWS API
* Documentation
*/
default GetPlaybackKeyPairResponse getPlaybackKeyPair(Consumer getPlaybackKeyPairRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException,
SdkClientException, IvsException {
return getPlaybackKeyPair(GetPlaybackKeyPairRequest.builder().applyMutation(getPlaybackKeyPairRequest).build());
}
/**
*
* Gets the specified playback restriction policy.
*
*
* @param getPlaybackRestrictionPolicyRequest
* @return Result of the GetPlaybackRestrictionPolicy operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.GetPlaybackRestrictionPolicy
* @see AWS API Documentation
*/
default GetPlaybackRestrictionPolicyResponse getPlaybackRestrictionPolicy(
GetPlaybackRestrictionPolicyRequest getPlaybackRestrictionPolicyRequest) throws ResourceNotFoundException,
AccessDeniedException, ValidationException, PendingVerificationException, AwsServiceException, SdkClientException,
IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Gets the specified playback restriction policy.
*
*
*
* This is a convenience which creates an instance of the {@link GetPlaybackRestrictionPolicyRequest.Builder}
* avoiding the need to create one manually via {@link GetPlaybackRestrictionPolicyRequest#builder()}
*
*
* @param getPlaybackRestrictionPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.GetPlaybackRestrictionPolicyRequest.Builder} to create a
* request.
* @return Result of the GetPlaybackRestrictionPolicy operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.GetPlaybackRestrictionPolicy
* @see AWS API Documentation
*/
default GetPlaybackRestrictionPolicyResponse getPlaybackRestrictionPolicy(
Consumer getPlaybackRestrictionPolicyRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, PendingVerificationException,
AwsServiceException, SdkClientException, IvsException {
return getPlaybackRestrictionPolicy(GetPlaybackRestrictionPolicyRequest.builder()
.applyMutation(getPlaybackRestrictionPolicyRequest).build());
}
/**
*
* Gets the recording configuration for the specified ARN.
*
*
* @param getRecordingConfigurationRequest
* @return Result of the GetRecordingConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.GetRecordingConfiguration
* @see AWS
* API Documentation
*/
default GetRecordingConfigurationResponse getRecordingConfiguration(
GetRecordingConfigurationRequest getRecordingConfigurationRequest) throws ResourceNotFoundException,
InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException,
IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Gets the recording configuration for the specified ARN.
*
*
*
* This is a convenience which creates an instance of the {@link GetRecordingConfigurationRequest.Builder} avoiding
* the need to create one manually via {@link GetRecordingConfigurationRequest#builder()}
*
*
* @param getRecordingConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.GetRecordingConfigurationRequest.Builder} to create a
* request.
* @return Result of the GetRecordingConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.GetRecordingConfiguration
* @see AWS
* API Documentation
*/
default GetRecordingConfigurationResponse getRecordingConfiguration(
Consumer getRecordingConfigurationRequest)
throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException,
AwsServiceException, SdkClientException, IvsException {
return getRecordingConfiguration(GetRecordingConfigurationRequest.builder()
.applyMutation(getRecordingConfigurationRequest).build());
}
/**
*
* Gets information about the active (live) stream on a specified channel.
*
*
* @param getStreamRequest
* @return Result of the GetStream operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws ChannelNotBroadcastingException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.GetStream
* @see AWS API
* Documentation
*/
default GetStreamResponse getStream(GetStreamRequest getStreamRequest) throws ResourceNotFoundException,
AccessDeniedException, ValidationException, ChannelNotBroadcastingException, AwsServiceException, SdkClientException,
IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about the active (live) stream on a specified channel.
*
*
*
* This is a convenience which creates an instance of the {@link GetStreamRequest.Builder} avoiding the need to
* create one manually via {@link GetStreamRequest#builder()}
*
*
* @param getStreamRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.GetStreamRequest.Builder} to create a request.
* @return Result of the GetStream operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws ChannelNotBroadcastingException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.GetStream
* @see AWS API
* Documentation
*/
default GetStreamResponse getStream(Consumer getStreamRequest) throws ResourceNotFoundException,
AccessDeniedException, ValidationException, ChannelNotBroadcastingException, AwsServiceException, SdkClientException,
IvsException {
return getStream(GetStreamRequest.builder().applyMutation(getStreamRequest).build());
}
/**
*
* Gets stream-key information for a specified ARN.
*
*
* @param getStreamKeyRequest
* @return Result of the GetStreamKey operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.GetStreamKey
* @see AWS API
* Documentation
*/
default GetStreamKeyResponse getStreamKey(GetStreamKeyRequest getStreamKeyRequest) throws ResourceNotFoundException,
AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Gets stream-key information for a specified ARN.
*
*
*
* This is a convenience which creates an instance of the {@link GetStreamKeyRequest.Builder} avoiding the need to
* create one manually via {@link GetStreamKeyRequest#builder()}
*
*
* @param getStreamKeyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.GetStreamKeyRequest.Builder} to create a request.
* @return Result of the GetStreamKey operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.GetStreamKey
* @see AWS API
* Documentation
*/
default GetStreamKeyResponse getStreamKey(Consumer getStreamKeyRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException,
SdkClientException, IvsException {
return getStreamKey(GetStreamKeyRequest.builder().applyMutation(getStreamKeyRequest).build());
}
/**
*
* Gets metadata on a specified stream.
*
*
* @param getStreamSessionRequest
* @return Result of the GetStreamSession operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.GetStreamSession
* @see AWS API
* Documentation
*/
default GetStreamSessionResponse getStreamSession(GetStreamSessionRequest getStreamSessionRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException,
SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Gets metadata on a specified stream.
*
*
*
* This is a convenience which creates an instance of the {@link GetStreamSessionRequest.Builder} avoiding the need
* to create one manually via {@link GetStreamSessionRequest#builder()}
*
*
* @param getStreamSessionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.GetStreamSessionRequest.Builder} to create a request.
* @return Result of the GetStreamSession operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.GetStreamSession
* @see AWS API
* Documentation
*/
default GetStreamSessionResponse getStreamSession(Consumer getStreamSessionRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException,
SdkClientException, IvsException {
return getStreamSession(GetStreamSessionRequest.builder().applyMutation(getStreamSessionRequest).build());
}
/**
*
* 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.
*
*
* @param importPlaybackKeyPairRequest
* @return Result of the ImportPlaybackKeyPair operation returned by the service.
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ConflictException
* @throws ServiceQuotaExceededException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ImportPlaybackKeyPair
* @see AWS API
* Documentation
*/
default ImportPlaybackKeyPairResponse importPlaybackKeyPair(ImportPlaybackKeyPairRequest importPlaybackKeyPairRequest)
throws AccessDeniedException, ValidationException, PendingVerificationException, ConflictException,
ServiceQuotaExceededException, AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ImportPlaybackKeyPairRequest.Builder} avoiding the
* need to create one manually via {@link ImportPlaybackKeyPairRequest#builder()}
*
*
* @param importPlaybackKeyPairRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.ImportPlaybackKeyPairRequest.Builder} to create a
* request.
* @return Result of the ImportPlaybackKeyPair operation returned by the service.
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ConflictException
* @throws ServiceQuotaExceededException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ImportPlaybackKeyPair
* @see AWS API
* Documentation
*/
default ImportPlaybackKeyPairResponse importPlaybackKeyPair(
Consumer importPlaybackKeyPairRequest) throws AccessDeniedException,
ValidationException, PendingVerificationException, ConflictException, ServiceQuotaExceededException,
AwsServiceException, SdkClientException, IvsException {
return importPlaybackKeyPair(ImportPlaybackKeyPairRequest.builder().applyMutation(importPlaybackKeyPairRequest).build());
}
/**
*
* Gets summary information about all channels in your account, in the Amazon Web Services region where the API
* request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters
* are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409
* ConflictException).
*
*
* @param listChannelsRequest
* @return Result of the ListChannels operation returned by the service.
* @throws AccessDeniedException
* @throws ValidationException
* @throws ConflictException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListChannels
* @see AWS API
* Documentation
*/
default ListChannelsResponse listChannels(ListChannelsRequest listChannelsRequest) throws AccessDeniedException,
ValidationException, ConflictException, AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Gets summary information about all channels in your account, in the Amazon Web Services region where the API
* request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters
* are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409
* ConflictException).
*
*
*
* This is a convenience which creates an instance of the {@link ListChannelsRequest.Builder} avoiding the need to
* create one manually via {@link ListChannelsRequest#builder()}
*
*
* @param listChannelsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.ListChannelsRequest.Builder} to create a request.
* @return Result of the ListChannels operation returned by the service.
* @throws AccessDeniedException
* @throws ValidationException
* @throws ConflictException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListChannels
* @see AWS API
* Documentation
*/
default ListChannelsResponse listChannels(Consumer listChannelsRequest)
throws AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException,
IvsException {
return listChannels(ListChannelsRequest.builder().applyMutation(listChannelsRequest).build());
}
/**
*
* This is a variant of {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listChannels(software.amazon.awssdk.services.ivs.model.ListChannelsRequest)} operation.
*
*
* @param listChannelsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* @throws ValidationException
* @throws ConflictException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListChannels
* @see AWS API
* Documentation
*/
default ListChannelsIterable listChannelsPaginator(ListChannelsRequest listChannelsRequest) throws AccessDeniedException,
ValidationException, ConflictException, AwsServiceException, SdkClientException, IvsException {
return new ListChannelsIterable(this, listChannelsRequest);
}
/**
*
* This is a variant of {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listChannels(software.amazon.awssdk.services.ivs.model.ListChannelsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListChannelsRequest.Builder} avoiding the need to
* create one manually via {@link ListChannelsRequest#builder()}
*
*
* @param listChannelsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.ListChannelsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* @throws ValidationException
* @throws ConflictException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListChannels
* @see AWS API
* Documentation
*/
default ListChannelsIterable listChannelsPaginator(Consumer listChannelsRequest)
throws AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException,
IvsException {
return listChannelsPaginator(ListChannelsRequest.builder().applyMutation(listChannelsRequest).build());
}
/**
*
* Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in
* the Amazon IVS User Guide.
*
*
* @param listPlaybackKeyPairsRequest
* @return Result of the ListPlaybackKeyPairs operation returned by the service.
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListPlaybackKeyPairs
* @see AWS API
* Documentation
*/
default ListPlaybackKeyPairsResponse listPlaybackKeyPairs(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest)
throws AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListPlaybackKeyPairsRequest.Builder} avoiding the
* need to create one manually via {@link ListPlaybackKeyPairsRequest#builder()}
*
*
* @param listPlaybackKeyPairsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsRequest.Builder} to create a request.
* @return Result of the ListPlaybackKeyPairs operation returned by the service.
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListPlaybackKeyPairs
* @see AWS API
* Documentation
*/
default ListPlaybackKeyPairsResponse listPlaybackKeyPairs(
Consumer listPlaybackKeyPairsRequest) throws AccessDeniedException,
ValidationException, AwsServiceException, SdkClientException, IvsException {
return listPlaybackKeyPairs(ListPlaybackKeyPairsRequest.builder().applyMutation(listPlaybackKeyPairsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listPlaybackKeyPairs(software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsRequest)}
* operation.
*
*
* @param listPlaybackKeyPairsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListPlaybackKeyPairs
* @see AWS API
* Documentation
*/
default ListPlaybackKeyPairsIterable listPlaybackKeyPairsPaginator(ListPlaybackKeyPairsRequest listPlaybackKeyPairsRequest)
throws AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, IvsException {
return new ListPlaybackKeyPairsIterable(this, listPlaybackKeyPairsRequest);
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listPlaybackKeyPairs(software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListPlaybackKeyPairsRequest.Builder} avoiding the
* need to create one manually via {@link ListPlaybackKeyPairsRequest#builder()}
*
*
* @param listPlaybackKeyPairsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.ListPlaybackKeyPairsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListPlaybackKeyPairs
* @see AWS API
* Documentation
*/
default ListPlaybackKeyPairsIterable listPlaybackKeyPairsPaginator(
Consumer listPlaybackKeyPairsRequest) throws AccessDeniedException,
ValidationException, AwsServiceException, SdkClientException, IvsException {
return listPlaybackKeyPairsPaginator(ListPlaybackKeyPairsRequest.builder().applyMutation(listPlaybackKeyPairsRequest)
.build());
}
/**
*
* Gets summary information about playback restriction policies.
*
*
* @param listPlaybackRestrictionPoliciesRequest
* @return Result of the ListPlaybackRestrictionPolicies operation returned by the service.
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ConflictException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListPlaybackRestrictionPolicies
* @see AWS API Documentation
*/
default ListPlaybackRestrictionPoliciesResponse listPlaybackRestrictionPolicies(
ListPlaybackRestrictionPoliciesRequest listPlaybackRestrictionPoliciesRequest) throws AccessDeniedException,
ValidationException, PendingVerificationException, ConflictException, AwsServiceException, SdkClientException,
IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Gets summary information about playback restriction policies.
*
*
*
* This is a convenience which creates an instance of the {@link ListPlaybackRestrictionPoliciesRequest.Builder}
* avoiding the need to create one manually via {@link ListPlaybackRestrictionPoliciesRequest#builder()}
*
*
* @param listPlaybackRestrictionPoliciesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesRequest.Builder} to create
* a request.
* @return Result of the ListPlaybackRestrictionPolicies operation returned by the service.
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ConflictException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListPlaybackRestrictionPolicies
* @see AWS API Documentation
*/
default ListPlaybackRestrictionPoliciesResponse listPlaybackRestrictionPolicies(
Consumer listPlaybackRestrictionPoliciesRequest)
throws AccessDeniedException, ValidationException, PendingVerificationException, ConflictException,
AwsServiceException, SdkClientException, IvsException {
return listPlaybackRestrictionPolicies(ListPlaybackRestrictionPoliciesRequest.builder()
.applyMutation(listPlaybackRestrictionPoliciesRequest).build());
}
/**
*
* This is a variant of
* {@link #listPlaybackRestrictionPolicies(software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.ivs.paginators.ListPlaybackRestrictionPoliciesIterable responses = client.listPlaybackRestrictionPoliciesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.ivs.paginators.ListPlaybackRestrictionPoliciesIterable responses = client
* .listPlaybackRestrictionPoliciesPaginator(request);
* for (software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.ivs.paginators.ListPlaybackRestrictionPoliciesIterable responses = client.listPlaybackRestrictionPoliciesPaginator(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
* {@link #listPlaybackRestrictionPolicies(software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesRequest)}
* operation.
*
*
* @param listPlaybackRestrictionPoliciesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ConflictException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListPlaybackRestrictionPolicies
* @see AWS API Documentation
*/
default ListPlaybackRestrictionPoliciesIterable listPlaybackRestrictionPoliciesPaginator(
ListPlaybackRestrictionPoliciesRequest listPlaybackRestrictionPoliciesRequest) throws AccessDeniedException,
ValidationException, PendingVerificationException, ConflictException, AwsServiceException, SdkClientException,
IvsException {
return new ListPlaybackRestrictionPoliciesIterable(this, listPlaybackRestrictionPoliciesRequest);
}
/**
*
* This is a variant of
* {@link #listPlaybackRestrictionPolicies(software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesRequest)}
* 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
*
*
* {@code
* software.amazon.awssdk.services.ivs.paginators.ListPlaybackRestrictionPoliciesIterable responses = client.listPlaybackRestrictionPoliciesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.ivs.paginators.ListPlaybackRestrictionPoliciesIterable responses = client
* .listPlaybackRestrictionPoliciesPaginator(request);
* for (software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.ivs.paginators.ListPlaybackRestrictionPoliciesIterable responses = client.listPlaybackRestrictionPoliciesPaginator(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
* {@link #listPlaybackRestrictionPolicies(software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListPlaybackRestrictionPoliciesRequest.Builder}
* avoiding the need to create one manually via {@link ListPlaybackRestrictionPoliciesRequest#builder()}
*
*
* @param listPlaybackRestrictionPoliciesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.ListPlaybackRestrictionPoliciesRequest.Builder} to create
* a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ConflictException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListPlaybackRestrictionPolicies
* @see AWS API Documentation
*/
default ListPlaybackRestrictionPoliciesIterable listPlaybackRestrictionPoliciesPaginator(
Consumer listPlaybackRestrictionPoliciesRequest)
throws AccessDeniedException, ValidationException, PendingVerificationException, ConflictException,
AwsServiceException, SdkClientException, IvsException {
return listPlaybackRestrictionPoliciesPaginator(ListPlaybackRestrictionPoliciesRequest.builder()
.applyMutation(listPlaybackRestrictionPoliciesRequest).build());
}
/**
*
* Gets summary information about all recording configurations in your account, in the Amazon Web Services region
* where the API request is processed.
*
*
* @param listRecordingConfigurationsRequest
* @return Result of the ListRecordingConfigurations operation returned by the service.
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListRecordingConfigurations
* @see AWS API Documentation
*/
default ListRecordingConfigurationsResponse listRecordingConfigurations(
ListRecordingConfigurationsRequest listRecordingConfigurationsRequest) throws InternalServerException,
AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Gets summary information about all recording configurations in your account, in the Amazon Web Services region
* where the API request is processed.
*
*
*
* This is a convenience which creates an instance of the {@link ListRecordingConfigurationsRequest.Builder}
* avoiding the need to create one manually via {@link ListRecordingConfigurationsRequest#builder()}
*
*
* @param listRecordingConfigurationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsRequest.Builder} to create a
* request.
* @return Result of the ListRecordingConfigurations operation returned by the service.
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListRecordingConfigurations
* @see AWS API Documentation
*/
default ListRecordingConfigurationsResponse listRecordingConfigurations(
Consumer listRecordingConfigurationsRequest)
throws InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException,
IvsException {
return listRecordingConfigurations(ListRecordingConfigurationsRequest.builder()
.applyMutation(listRecordingConfigurationsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listRecordingConfigurations(software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsRequest)}
* operation.
*
*
* @param listRecordingConfigurationsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListRecordingConfigurations
* @see AWS API Documentation
*/
default ListRecordingConfigurationsIterable listRecordingConfigurationsPaginator(
ListRecordingConfigurationsRequest listRecordingConfigurationsRequest) throws InternalServerException,
AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, IvsException {
return new ListRecordingConfigurationsIterable(this, listRecordingConfigurationsRequest);
}
/**
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listRecordingConfigurations(software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListRecordingConfigurationsRequest.Builder}
* avoiding the need to create one manually via {@link ListRecordingConfigurationsRequest#builder()}
*
*
* @param listRecordingConfigurationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.ListRecordingConfigurationsRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListRecordingConfigurations
* @see AWS API Documentation
*/
default ListRecordingConfigurationsIterable listRecordingConfigurationsPaginator(
Consumer listRecordingConfigurationsRequest)
throws InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException,
IvsException {
return listRecordingConfigurationsPaginator(ListRecordingConfigurationsRequest.builder()
.applyMutation(listRecordingConfigurationsRequest).build());
}
/**
*
* Gets summary information about stream keys for the specified channel.
*
*
* @param listStreamKeysRequest
* @return Result of the ListStreamKeys operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListStreamKeys
* @see AWS API
* Documentation
*/
default ListStreamKeysResponse listStreamKeys(ListStreamKeysRequest listStreamKeysRequest) throws ResourceNotFoundException,
AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Gets summary information about stream keys for the specified channel.
*
*
*
* This is a convenience which creates an instance of the {@link ListStreamKeysRequest.Builder} avoiding the need to
* create one manually via {@link ListStreamKeysRequest#builder()}
*
*
* @param listStreamKeysRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.ListStreamKeysRequest.Builder} to create a request.
* @return Result of the ListStreamKeys operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListStreamKeys
* @see AWS API
* Documentation
*/
default ListStreamKeysResponse listStreamKeys(Consumer listStreamKeysRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException,
SdkClientException, IvsException {
return listStreamKeys(ListStreamKeysRequest.builder().applyMutation(listStreamKeysRequest).build());
}
/**
*
* This is a variant of {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listStreamKeys(software.amazon.awssdk.services.ivs.model.ListStreamKeysRequest)} operation.
*
*
* @param listStreamKeysRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListStreamKeys
* @see AWS API
* Documentation
*/
default ListStreamKeysIterable listStreamKeysPaginator(ListStreamKeysRequest listStreamKeysRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException,
SdkClientException, IvsException {
return new ListStreamKeysIterable(this, listStreamKeysRequest);
}
/**
*
* This is a variant of {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listStreamKeys(software.amazon.awssdk.services.ivs.model.ListStreamKeysRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListStreamKeysRequest.Builder} avoiding the need to
* create one manually via {@link ListStreamKeysRequest#builder()}
*
*
* @param listStreamKeysRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.ListStreamKeysRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListStreamKeys
* @see AWS API
* Documentation
*/
default ListStreamKeysIterable listStreamKeysPaginator(Consumer listStreamKeysRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException,
SdkClientException, IvsException {
return listStreamKeysPaginator(ListStreamKeysRequest.builder().applyMutation(listStreamKeysRequest).build());
}
/**
*
* Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where
* the API request is processed.
*
*
* @param listStreamSessionsRequest
* @return Result of the ListStreamSessions operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListStreamSessions
* @see AWS API
* Documentation
*/
default ListStreamSessionsResponse listStreamSessions(ListStreamSessionsRequest listStreamSessionsRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException,
SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where
* the API request is processed.
*
*
*
* This is a convenience which creates an instance of the {@link ListStreamSessionsRequest.Builder} avoiding the
* need to create one manually via {@link ListStreamSessionsRequest#builder()}
*
*
* @param listStreamSessionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.ListStreamSessionsRequest.Builder} to create a request.
* @return Result of the ListStreamSessions operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListStreamSessions
* @see AWS API
* Documentation
*/
default ListStreamSessionsResponse listStreamSessions(Consumer listStreamSessionsRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException,
SdkClientException, IvsException {
return listStreamSessions(ListStreamSessionsRequest.builder().applyMutation(listStreamSessionsRequest).build());
}
/**
*
* This is a variant of
* {@link #listStreamSessions(software.amazon.awssdk.services.ivs.model.ListStreamSessionsRequest)} 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
*
*
* {@code
* software.amazon.awssdk.services.ivs.paginators.ListStreamSessionsIterable responses = client.listStreamSessionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.ivs.paginators.ListStreamSessionsIterable responses = client
* .listStreamSessionsPaginator(request);
* for (software.amazon.awssdk.services.ivs.model.ListStreamSessionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.ivs.paginators.ListStreamSessionsIterable responses = client.listStreamSessionsPaginator(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
* {@link #listStreamSessions(software.amazon.awssdk.services.ivs.model.ListStreamSessionsRequest)} operation.
*
*
* @param listStreamSessionsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListStreamSessions
* @see AWS API
* Documentation
*/
default ListStreamSessionsIterable listStreamSessionsPaginator(ListStreamSessionsRequest listStreamSessionsRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException,
SdkClientException, IvsException {
return new ListStreamSessionsIterable(this, listStreamSessionsRequest);
}
/**
*
* This is a variant of
* {@link #listStreamSessions(software.amazon.awssdk.services.ivs.model.ListStreamSessionsRequest)} 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
*
*
* {@code
* software.amazon.awssdk.services.ivs.paginators.ListStreamSessionsIterable responses = client.listStreamSessionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.ivs.paginators.ListStreamSessionsIterable responses = client
* .listStreamSessionsPaginator(request);
* for (software.amazon.awssdk.services.ivs.model.ListStreamSessionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.ivs.paginators.ListStreamSessionsIterable responses = client.listStreamSessionsPaginator(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
* {@link #listStreamSessions(software.amazon.awssdk.services.ivs.model.ListStreamSessionsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListStreamSessionsRequest.Builder} avoiding the
* need to create one manually via {@link ListStreamSessionsRequest#builder()}
*
*
* @param listStreamSessionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.ListStreamSessionsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListStreamSessions
* @see AWS API
* Documentation
*/
default ListStreamSessionsIterable listStreamSessionsPaginator(
Consumer listStreamSessionsRequest) throws ResourceNotFoundException,
AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, IvsException {
return listStreamSessionsPaginator(ListStreamSessionsRequest.builder().applyMutation(listStreamSessionsRequest).build());
}
/**
*
* Gets summary information about live streams in your account, in the Amazon Web Services region where the API
* request is processed.
*
*
* @param listStreamsRequest
* @return Result of the ListStreams operation returned by the service.
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListStreams
* @see AWS API
* Documentation
*/
default ListStreamsResponse listStreams(ListStreamsRequest listStreamsRequest) throws AccessDeniedException,
ValidationException, AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Gets summary information about live streams in your account, in the Amazon Web Services region where the API
* request is processed.
*
*
*
* This is a convenience which creates an instance of the {@link ListStreamsRequest.Builder} avoiding the need to
* create one manually via {@link ListStreamsRequest#builder()}
*
*
* @param listStreamsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.ListStreamsRequest.Builder} to create a request.
* @return Result of the ListStreams operation returned by the service.
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListStreams
* @see AWS API
* Documentation
*/
default ListStreamsResponse listStreams(Consumer listStreamsRequest)
throws AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, IvsException {
return listStreams(ListStreamsRequest.builder().applyMutation(listStreamsRequest).build());
}
/**
*
* This is a variant of {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listStreams(software.amazon.awssdk.services.ivs.model.ListStreamsRequest)} operation.
*
*
* @param listStreamsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListStreams
* @see AWS API
* Documentation
*/
default ListStreamsIterable listStreamsPaginator(ListStreamsRequest listStreamsRequest) throws AccessDeniedException,
ValidationException, AwsServiceException, SdkClientException, IvsException {
return new ListStreamsIterable(this, listStreamsRequest);
}
/**
*
* This is a variant of {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #listStreams(software.amazon.awssdk.services.ivs.model.ListStreamsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListStreamsRequest.Builder} avoiding the need to
* create one manually via {@link ListStreamsRequest#builder()}
*
*
* @param listStreamsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.ListStreamsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListStreams
* @see AWS API
* Documentation
*/
default ListStreamsIterable listStreamsPaginator(Consumer listStreamsRequest)
throws AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, IvsException {
return listStreamsPaginator(ListStreamsRequest.builder().applyMutation(listStreamsRequest).build());
}
/**
*
* Gets information about Amazon Web Services tags for the specified ARN.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListTagsForResource
* @see AWS API
* Documentation
*/
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws ResourceNotFoundException, InternalServerException, ValidationException, AwsServiceException,
SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Gets information about Amazon Web Services tags for the specified ARN.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.ListTagsForResourceRequest.Builder} to create a request.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.ListTagsForResource
* @see AWS API
* Documentation
*/
default ListTagsForResourceResponse listTagsForResource(
Consumer listTagsForResourceRequest) throws ResourceNotFoundException,
InternalServerException, ValidationException, AwsServiceException, SdkClientException, IvsException {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are
* allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your
* data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video
* Stream in the Amazon IVS User Guide.
*
*
* @param putMetadataRequest
* @return Result of the PutMetadata operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws ChannelNotBroadcastingException
* @throws ThrottlingException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.PutMetadata
* @see AWS API
* Documentation
*/
default PutMetadataResponse putMetadata(PutMetadataRequest putMetadataRequest) throws ResourceNotFoundException,
AccessDeniedException, ValidationException, ChannelNotBroadcastingException, ThrottlingException,
AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are
* allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your
* data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video
* Stream in the Amazon IVS User Guide.
*
*
*
* This is a convenience which creates an instance of the {@link PutMetadataRequest.Builder} avoiding the need to
* create one manually via {@link PutMetadataRequest#builder()}
*
*
* @param putMetadataRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.PutMetadataRequest.Builder} to create a request.
* @return Result of the PutMetadata operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws ChannelNotBroadcastingException
* @throws ThrottlingException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.PutMetadata
* @see AWS API
* Documentation
*/
default PutMetadataResponse putMetadata(Consumer putMetadataRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, ChannelNotBroadcastingException,
ThrottlingException, AwsServiceException, SdkClientException, IvsException {
return putMetadata(PutMetadataRequest.builder().applyMutation(putMetadataRequest).build());
}
/**
*
* Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID.
* Optionally, you can provide a version to revoke viewer sessions less than and including that version. For
* instructions on associating a viewer ID with a viewer session, see Setting Up Private Channels.
*
*
* @param startViewerSessionRevocationRequest
* @return Result of the StartViewerSessionRevocation operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ThrottlingException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.StartViewerSessionRevocation
* @see AWS API Documentation
*/
default StartViewerSessionRevocationResponse startViewerSessionRevocation(
StartViewerSessionRevocationRequest startViewerSessionRevocationRequest) throws ResourceNotFoundException,
InternalServerException, AccessDeniedException, ValidationException, PendingVerificationException,
ThrottlingException, AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID.
* Optionally, you can provide a version to revoke viewer sessions less than and including that version. For
* instructions on associating a viewer ID with a viewer session, see Setting Up Private Channels.
*
*
*
* This is a convenience which creates an instance of the {@link StartViewerSessionRevocationRequest.Builder}
* avoiding the need to create one manually via {@link StartViewerSessionRevocationRequest#builder()}
*
*
* @param startViewerSessionRevocationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.StartViewerSessionRevocationRequest.Builder} to create a
* request.
* @return Result of the StartViewerSessionRevocation operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ThrottlingException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.StartViewerSessionRevocation
* @see AWS API Documentation
*/
default StartViewerSessionRevocationResponse startViewerSessionRevocation(
Consumer startViewerSessionRevocationRequest)
throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ValidationException,
PendingVerificationException, ThrottlingException, AwsServiceException, SdkClientException, IvsException {
return startViewerSessionRevocation(StartViewerSessionRevocationRequest.builder()
.applyMutation(startViewerSessionRevocationRequest).build());
}
/**
*
* 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.
*
*
*
* @param stopStreamRequest
* @return Result of the StopStream operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws ChannelNotBroadcastingException
* @throws StreamUnavailableException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.StopStream
* @see AWS API
* Documentation
*/
default StopStreamResponse stopStream(StopStreamRequest stopStreamRequest) throws ResourceNotFoundException,
AccessDeniedException, ValidationException, ChannelNotBroadcastingException, StreamUnavailableException,
AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StopStreamRequest.Builder} avoiding the need to
* create one manually via {@link StopStreamRequest#builder()}
*
*
* @param stopStreamRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.StopStreamRequest.Builder} to create a request.
* @return Result of the StopStream operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws ChannelNotBroadcastingException
* @throws StreamUnavailableException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.StopStream
* @see AWS API
* Documentation
*/
default StopStreamResponse stopStream(Consumer stopStreamRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, ChannelNotBroadcastingException,
StreamUnavailableException, AwsServiceException, SdkClientException, IvsException {
return stopStream(StopStreamRequest.builder().applyMutation(stopStreamRequest).build());
}
/**
*
* Adds or updates tags for the Amazon Web Services resource with the specified ARN.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException,
InternalServerException, ValidationException, AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Adds or updates tags for the Amazon Web Services resource with the specified ARN.
*
*
*
* This is a convenience which creates an instance of the {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.TagResourceRequest.Builder} to create a request.
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(Consumer tagResourceRequest)
throws ResourceNotFoundException, InternalServerException, ValidationException, AwsServiceException,
SdkClientException, IvsException {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Removes tags from the resource with the specified ARN.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException,
InternalServerException, ValidationException, AwsServiceException, SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Removes tags from the resource with the specified ARN.
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.UntagResourceRequest.Builder} to create a request.
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws ValidationException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(Consumer untagResourceRequest)
throws ResourceNotFoundException, InternalServerException, ValidationException, AwsServiceException,
SdkClientException, IvsException {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Updates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the
* channel, and restart the stream for the changes to take effect.
*
*
* @param updateChannelRequest
* @return Result of the UpdateChannel operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ConflictException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.UpdateChannel
* @see AWS API
* Documentation
*/
default UpdateChannelResponse updateChannel(UpdateChannelRequest updateChannelRequest) throws ResourceNotFoundException,
AccessDeniedException, ValidationException, PendingVerificationException, ConflictException, AwsServiceException,
SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Updates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the
* channel, and restart the stream for the changes to take effect.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateChannelRequest.Builder} avoiding the need to
* create one manually via {@link UpdateChannelRequest#builder()}
*
*
* @param updateChannelRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.UpdateChannelRequest.Builder} to create a request.
* @return Result of the UpdateChannel operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ConflictException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.UpdateChannel
* @see AWS API
* Documentation
*/
default UpdateChannelResponse updateChannel(Consumer updateChannelRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, PendingVerificationException,
ConflictException, AwsServiceException, SdkClientException, IvsException {
return updateChannel(UpdateChannelRequest.builder().applyMutation(updateChannelRequest).build());
}
/**
*
* Updates a specified playback restriction policy.
*
*
* @param updatePlaybackRestrictionPolicyRequest
* @return Result of the UpdatePlaybackRestrictionPolicy operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ConflictException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.UpdatePlaybackRestrictionPolicy
* @see AWS API Documentation
*/
default UpdatePlaybackRestrictionPolicyResponse updatePlaybackRestrictionPolicy(
UpdatePlaybackRestrictionPolicyRequest updatePlaybackRestrictionPolicyRequest) throws ResourceNotFoundException,
AccessDeniedException, ValidationException, PendingVerificationException, ConflictException, AwsServiceException,
SdkClientException, IvsException {
throw new UnsupportedOperationException();
}
/**
*
* Updates a specified playback restriction policy.
*
*
*
* This is a convenience which creates an instance of the {@link UpdatePlaybackRestrictionPolicyRequest.Builder}
* avoiding the need to create one manually via {@link UpdatePlaybackRestrictionPolicyRequest#builder()}
*
*
* @param updatePlaybackRestrictionPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ivs.model.UpdatePlaybackRestrictionPolicyRequest.Builder} to create
* a request.
* @return Result of the UpdatePlaybackRestrictionPolicy operation returned by the service.
* @throws ResourceNotFoundException
* @throws AccessDeniedException
* @throws ValidationException
* @throws PendingVerificationException
* @throws ConflictException
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws IvsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample IvsClient.UpdatePlaybackRestrictionPolicy
* @see AWS API Documentation
*/
default UpdatePlaybackRestrictionPolicyResponse updatePlaybackRestrictionPolicy(
Consumer updatePlaybackRestrictionPolicyRequest)
throws ResourceNotFoundException, AccessDeniedException, ValidationException, PendingVerificationException,
ConflictException, AwsServiceException, SdkClientException, IvsException {
return updatePlaybackRestrictionPolicy(UpdatePlaybackRestrictionPolicyRequest.builder()
.applyMutation(updatePlaybackRestrictionPolicyRequest).build());
}
/**
* Create a {@link IvsClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static IvsClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link IvsClient}.
*/
static IvsClientBuilder builder() {
return new DefaultIvsClientBuilder();
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of(SERVICE_METADATA_ID);
}
@Override
default IvsServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
}