Interface KinesisVideoClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface KinesisVideoClient extends AwsClient
Service client for accessing Kinesis Video. This can be created using the staticbuilder()method.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static KinesisVideoClientBuilderbuilder()Create a builder that can be used to configure and create aKinesisVideoClient.static KinesisVideoClientcreate()Create aKinesisVideoClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateSignalingChannelResponsecreateSignalingChannel(Consumer<CreateSignalingChannelRequest.Builder> createSignalingChannelRequest)Creates a signaling channel.default CreateSignalingChannelResponsecreateSignalingChannel(CreateSignalingChannelRequest createSignalingChannelRequest)Creates a signaling channel.default CreateStreamResponsecreateStream(Consumer<CreateStreamRequest.Builder> createStreamRequest)Creates a new Kinesis video stream.default CreateStreamResponsecreateStream(CreateStreamRequest createStreamRequest)Creates a new Kinesis video stream.default DeleteEdgeConfigurationResponsedeleteEdgeConfiguration(Consumer<DeleteEdgeConfigurationRequest.Builder> deleteEdgeConfigurationRequest)An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent.default DeleteEdgeConfigurationResponsedeleteEdgeConfiguration(DeleteEdgeConfigurationRequest deleteEdgeConfigurationRequest)An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent.default DeleteSignalingChannelResponsedeleteSignalingChannel(Consumer<DeleteSignalingChannelRequest.Builder> deleteSignalingChannelRequest)Deletes a specified signaling channel.default DeleteSignalingChannelResponsedeleteSignalingChannel(DeleteSignalingChannelRequest deleteSignalingChannelRequest)Deletes a specified signaling channel.default DeleteStreamResponsedeleteStream(Consumer<DeleteStreamRequest.Builder> deleteStreamRequest)Deletes a Kinesis video stream and the data contained in the stream.default DeleteStreamResponsedeleteStream(DeleteStreamRequest deleteStreamRequest)Deletes a Kinesis video stream and the data contained in the stream.default DescribeEdgeConfigurationResponsedescribeEdgeConfiguration(Consumer<DescribeEdgeConfigurationRequest.Builder> describeEdgeConfigurationRequest)Describes a stream’s edge configuration that was set using theStartEdgeConfigurationUpdateAPI and the latest status of the edge agent's recorder and uploader jobs.default DescribeEdgeConfigurationResponsedescribeEdgeConfiguration(DescribeEdgeConfigurationRequest describeEdgeConfigurationRequest)Describes a stream’s edge configuration that was set using theStartEdgeConfigurationUpdateAPI and the latest status of the edge agent's recorder and uploader jobs.default DescribeImageGenerationConfigurationResponsedescribeImageGenerationConfiguration(Consumer<DescribeImageGenerationConfigurationRequest.Builder> describeImageGenerationConfigurationRequest)Gets theImageGenerationConfigurationfor a given Kinesis video stream.default DescribeImageGenerationConfigurationResponsedescribeImageGenerationConfiguration(DescribeImageGenerationConfigurationRequest describeImageGenerationConfigurationRequest)Gets theImageGenerationConfigurationfor a given Kinesis video stream.default DescribeMappedResourceConfigurationResponsedescribeMappedResourceConfiguration(Consumer<DescribeMappedResourceConfigurationRequest.Builder> describeMappedResourceConfigurationRequest)Returns the most current information about the stream.default DescribeMappedResourceConfigurationResponsedescribeMappedResourceConfiguration(DescribeMappedResourceConfigurationRequest describeMappedResourceConfigurationRequest)Returns the most current information about the stream.default DescribeMappedResourceConfigurationIterabledescribeMappedResourceConfigurationPaginator(Consumer<DescribeMappedResourceConfigurationRequest.Builder> describeMappedResourceConfigurationRequest)default DescribeMappedResourceConfigurationIterabledescribeMappedResourceConfigurationPaginator(DescribeMappedResourceConfigurationRequest describeMappedResourceConfigurationRequest)default DescribeMediaStorageConfigurationResponsedescribeMediaStorageConfiguration(Consumer<DescribeMediaStorageConfigurationRequest.Builder> describeMediaStorageConfigurationRequest)Returns the most current information about the channel.default DescribeMediaStorageConfigurationResponsedescribeMediaStorageConfiguration(DescribeMediaStorageConfigurationRequest describeMediaStorageConfigurationRequest)Returns the most current information about the channel.default DescribeNotificationConfigurationResponsedescribeNotificationConfiguration(Consumer<DescribeNotificationConfigurationRequest.Builder> describeNotificationConfigurationRequest)Gets theNotificationConfigurationfor a given Kinesis video stream.default DescribeNotificationConfigurationResponsedescribeNotificationConfiguration(DescribeNotificationConfigurationRequest describeNotificationConfigurationRequest)Gets theNotificationConfigurationfor a given Kinesis video stream.default DescribeSignalingChannelResponsedescribeSignalingChannel(Consumer<DescribeSignalingChannelRequest.Builder> describeSignalingChannelRequest)Returns the most current information about the signaling channel.default DescribeSignalingChannelResponsedescribeSignalingChannel(DescribeSignalingChannelRequest describeSignalingChannelRequest)Returns the most current information about the signaling channel.default DescribeStreamResponsedescribeStream(Consumer<DescribeStreamRequest.Builder> describeStreamRequest)Returns the most current information about the specified stream.default DescribeStreamResponsedescribeStream(DescribeStreamRequest describeStreamRequest)Returns the most current information about the specified stream.default GetDataEndpointResponsegetDataEndpoint(Consumer<GetDataEndpointRequest.Builder> getDataEndpointRequest)Gets an endpoint for a specified stream for either reading or writing.default GetDataEndpointResponsegetDataEndpoint(GetDataEndpointRequest getDataEndpointRequest)Gets an endpoint for a specified stream for either reading or writing.default GetSignalingChannelEndpointResponsegetSignalingChannelEndpoint(Consumer<GetSignalingChannelEndpointRequest.Builder> getSignalingChannelEndpointRequest)Provides an endpoint for the specified signaling channel to send and receive messages.default GetSignalingChannelEndpointResponsegetSignalingChannelEndpoint(GetSignalingChannelEndpointRequest getSignalingChannelEndpointRequest)Provides an endpoint for the specified signaling channel to send and receive messages.default ListEdgeAgentConfigurationsResponselistEdgeAgentConfigurations(Consumer<ListEdgeAgentConfigurationsRequest.Builder> listEdgeAgentConfigurationsRequest)Returns an array of edge configurations associated with the specified Edge Agent.default ListEdgeAgentConfigurationsResponselistEdgeAgentConfigurations(ListEdgeAgentConfigurationsRequest listEdgeAgentConfigurationsRequest)Returns an array of edge configurations associated with the specified Edge Agent.default ListEdgeAgentConfigurationsIterablelistEdgeAgentConfigurationsPaginator(Consumer<ListEdgeAgentConfigurationsRequest.Builder> listEdgeAgentConfigurationsRequest)This is a variant oflistEdgeAgentConfigurations(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest)operation.default ListEdgeAgentConfigurationsIterablelistEdgeAgentConfigurationsPaginator(ListEdgeAgentConfigurationsRequest listEdgeAgentConfigurationsRequest)This is a variant oflistEdgeAgentConfigurations(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest)operation.default ListSignalingChannelsResponselistSignalingChannels(Consumer<ListSignalingChannelsRequest.Builder> listSignalingChannelsRequest)Returns an array ofChannelInfoobjects.default ListSignalingChannelsResponselistSignalingChannels(ListSignalingChannelsRequest listSignalingChannelsRequest)Returns an array ofChannelInfoobjects.default ListSignalingChannelsIterablelistSignalingChannelsPaginator(Consumer<ListSignalingChannelsRequest.Builder> listSignalingChannelsRequest)This is a variant oflistSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest)operation.default ListSignalingChannelsIterablelistSignalingChannelsPaginator(ListSignalingChannelsRequest listSignalingChannelsRequest)This is a variant oflistSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest)operation.default ListStreamsResponselistStreams()Returns an array ofStreamInfoobjects.default ListStreamsResponselistStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest)Returns an array ofStreamInfoobjects.default ListStreamsResponselistStreams(ListStreamsRequest listStreamsRequest)Returns an array ofStreamInfoobjects.default ListStreamsIterablelistStreamsPaginator()This is a variant oflistStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest)operation.default ListStreamsIterablelistStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest)This is a variant oflistStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest)operation.default ListStreamsIterablelistStreamsPaginator(ListStreamsRequest listStreamsRequest)This is a variant oflistStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Returns a list of tags associated with the specified signaling channel.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Returns a list of tags associated with the specified signaling channel.default ListTagsForStreamResponselistTagsForStream(Consumer<ListTagsForStreamRequest.Builder> listTagsForStreamRequest)Returns a list of tags associated with the specified stream.default ListTagsForStreamResponselistTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest)Returns a list of tags associated with the specified stream.default KinesisVideoServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartEdgeConfigurationUpdateResponsestartEdgeConfigurationUpdate(Consumer<StartEdgeConfigurationUpdateRequest.Builder> startEdgeConfigurationUpdateRequest)An asynchronous API that updates a stream’s existing edge configuration.default StartEdgeConfigurationUpdateResponsestartEdgeConfigurationUpdate(StartEdgeConfigurationUpdateRequest startEdgeConfigurationUpdateRequest)An asynchronous API that updates a stream’s existing edge configuration.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Adds one or more tags to a signaling channel.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Adds one or more tags to a signaling channel.default TagStreamResponsetagStream(Consumer<TagStreamRequest.Builder> tagStreamRequest)Adds one or more tags to a stream.default TagStreamResponsetagStream(TagStreamRequest tagStreamRequest)Adds one or more tags to a stream.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Removes one or more tags from a signaling channel.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Removes one or more tags from a signaling channel.default UntagStreamResponseuntagStream(Consumer<UntagStreamRequest.Builder> untagStreamRequest)Removes one or more tags from a stream.default UntagStreamResponseuntagStream(UntagStreamRequest untagStreamRequest)Removes one or more tags from a stream.default UpdateDataRetentionResponseupdateDataRetention(Consumer<UpdateDataRetentionRequest.Builder> updateDataRetentionRequest)Increases or decreases the stream's data retention period by the value that you specify.default UpdateDataRetentionResponseupdateDataRetention(UpdateDataRetentionRequest updateDataRetentionRequest)Increases or decreases the stream's data retention period by the value that you specify.default UpdateImageGenerationConfigurationResponseupdateImageGenerationConfiguration(Consumer<UpdateImageGenerationConfigurationRequest.Builder> updateImageGenerationConfigurationRequest)Updates theStreamInfoandImageProcessingConfigurationfields.default UpdateImageGenerationConfigurationResponseupdateImageGenerationConfiguration(UpdateImageGenerationConfigurationRequest updateImageGenerationConfigurationRequest)Updates theStreamInfoandImageProcessingConfigurationfields.default UpdateMediaStorageConfigurationResponseupdateMediaStorageConfiguration(Consumer<UpdateMediaStorageConfigurationRequest.Builder> updateMediaStorageConfigurationRequest)Associates aSignalingChannelto a stream to store the media.default UpdateMediaStorageConfigurationResponseupdateMediaStorageConfiguration(UpdateMediaStorageConfigurationRequest updateMediaStorageConfigurationRequest)Associates aSignalingChannelto a stream to store the media.default UpdateNotificationConfigurationResponseupdateNotificationConfiguration(Consumer<UpdateNotificationConfigurationRequest.Builder> updateNotificationConfigurationRequest)Updates the notification information for a stream.default UpdateNotificationConfigurationResponseupdateNotificationConfiguration(UpdateNotificationConfigurationRequest updateNotificationConfigurationRequest)Updates the notification information for a stream.default UpdateSignalingChannelResponseupdateSignalingChannel(Consumer<UpdateSignalingChannelRequest.Builder> updateSignalingChannelRequest)Updates the existing signaling channel.default UpdateSignalingChannelResponseupdateSignalingChannel(UpdateSignalingChannelRequest updateSignalingChannelRequest)Updates the existing signaling channel.default UpdateStreamResponseupdateStream(Consumer<UpdateStreamRequest.Builder> updateStreamRequest)Updates stream metadata, such as the device name and media type.default UpdateStreamResponseupdateStream(UpdateStreamRequest updateStreamRequest)Updates stream metadata, such as the device name and media type.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
createSignalingChannel
default CreateSignalingChannelResponse createSignalingChannel(CreateSignalingChannelRequest createSignalingChannelRequest) throws InvalidArgumentException, ClientLimitExceededException, AccountChannelLimitExceededException, ResourceInUseException, AccessDeniedException, TagsPerResourceExceededLimitException, AwsServiceException, SdkClientException, KinesisVideoException
Creates a signaling channel.
CreateSignalingChannelis an asynchronous operation.- Parameters:
createSignalingChannelRequest-- Returns:
- Result of the CreateSignalingChannel operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.AccountChannelLimitExceededException- You have reached the maximum limit of active signaling channels for this Amazon Web Services account in this region.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
AccessDeniedException- You do not have required permissions to perform this operation.TagsPerResourceExceededLimitException- You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createSignalingChannel
default CreateSignalingChannelResponse createSignalingChannel(Consumer<CreateSignalingChannelRequest.Builder> createSignalingChannelRequest) throws InvalidArgumentException, ClientLimitExceededException, AccountChannelLimitExceededException, ResourceInUseException, AccessDeniedException, TagsPerResourceExceededLimitException, AwsServiceException, SdkClientException, KinesisVideoException
Creates a signaling channel.
CreateSignalingChannelis an asynchronous operation.
This is a convenience which creates an instance of the
CreateSignalingChannelRequest.Builderavoiding the need to create one manually viaCreateSignalingChannelRequest.builder()- Parameters:
createSignalingChannelRequest- AConsumerthat will call methods onCreateSignalingChannelRequest.Builderto create a request.- Returns:
- Result of the CreateSignalingChannel operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.AccountChannelLimitExceededException- You have reached the maximum limit of active signaling channels for this Amazon Web Services account in this region.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
AccessDeniedException- You do not have required permissions to perform this operation.TagsPerResourceExceededLimitException- You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createStream
default CreateStreamResponse createStream(CreateStreamRequest createStreamRequest) throws AccountStreamLimitExceededException, DeviceStreamLimitExceededException, ResourceInUseException, InvalidDeviceException, InvalidArgumentException, ClientLimitExceededException, TagsPerResourceExceededLimitException, AwsServiceException, SdkClientException, KinesisVideoException
Creates a new Kinesis video stream.
When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version.
CreateStreamis an asynchronous operation.For information about how the service works, see How it Works.
You must have permissions for the
KinesisVideo:CreateStreamaction.- Parameters:
createStreamRequest-- Returns:
- Result of the CreateStream operation returned by the service.
- Throws:
AccountStreamLimitExceededException- The number of streams created for the account is too high.DeviceStreamLimitExceededException- Not implemented.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
InvalidDeviceException- Not implemented.InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.TagsPerResourceExceededLimitException- You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createStream
default CreateStreamResponse createStream(Consumer<CreateStreamRequest.Builder> createStreamRequest) throws AccountStreamLimitExceededException, DeviceStreamLimitExceededException, ResourceInUseException, InvalidDeviceException, InvalidArgumentException, ClientLimitExceededException, TagsPerResourceExceededLimitException, AwsServiceException, SdkClientException, KinesisVideoException
Creates a new Kinesis video stream.
When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version.
CreateStreamis an asynchronous operation.For information about how the service works, see How it Works.
You must have permissions for the
KinesisVideo:CreateStreamaction.
This is a convenience which creates an instance of the
CreateStreamRequest.Builderavoiding the need to create one manually viaCreateStreamRequest.builder()- Parameters:
createStreamRequest- AConsumerthat will call methods onCreateStreamRequest.Builderto create a request.- Returns:
- Result of the CreateStream operation returned by the service.
- Throws:
AccountStreamLimitExceededException- The number of streams created for the account is too high.DeviceStreamLimitExceededException- Not implemented.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
InvalidDeviceException- Not implemented.InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.TagsPerResourceExceededLimitException- You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteEdgeConfiguration
default DeleteEdgeConfigurationResponse deleteEdgeConfiguration(DeleteEdgeConfigurationRequest deleteEdgeConfigurationRequest) throws AccessDeniedException, ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, StreamEdgeConfigurationNotFoundException, AwsServiceException, SdkClientException, KinesisVideoException
An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent.
When you invoke this API, the sync status is set to
DELETING. A deletion process starts, in which active edge jobs are stopped and all media is deleted from the edge device. The time to delete varies, depending on the total amount of stored media. If the deletion process fails, the sync status changes toDELETE_FAILED. You will need to re-try the deletion.When the deletion process has completed successfully, the edge configuration is no longer accessible.
- Parameters:
deleteEdgeConfigurationRequest-- Returns:
- Result of the DeleteEdgeConfiguration operation returned by the service.
- Throws:
AccessDeniedException- You do not have required permissions to perform this operation.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.StreamEdgeConfigurationNotFoundException- The Exception rendered when the Amazon Kinesis Video Stream can't find a stream's edge configuration that you specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteEdgeConfiguration
default DeleteEdgeConfigurationResponse deleteEdgeConfiguration(Consumer<DeleteEdgeConfigurationRequest.Builder> deleteEdgeConfigurationRequest) throws AccessDeniedException, ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, StreamEdgeConfigurationNotFoundException, AwsServiceException, SdkClientException, KinesisVideoException
An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent.
When you invoke this API, the sync status is set to
DELETING. A deletion process starts, in which active edge jobs are stopped and all media is deleted from the edge device. The time to delete varies, depending on the total amount of stored media. If the deletion process fails, the sync status changes toDELETE_FAILED. You will need to re-try the deletion.When the deletion process has completed successfully, the edge configuration is no longer accessible.
This is a convenience which creates an instance of the
DeleteEdgeConfigurationRequest.Builderavoiding the need to create one manually viaDeleteEdgeConfigurationRequest.builder()- Parameters:
deleteEdgeConfigurationRequest- AConsumerthat will call methods onDeleteEdgeConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteEdgeConfiguration operation returned by the service.
- Throws:
AccessDeniedException- You do not have required permissions to perform this operation.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.StreamEdgeConfigurationNotFoundException- The Exception rendered when the Amazon Kinesis Video Stream can't find a stream's edge configuration that you specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteSignalingChannel
default DeleteSignalingChannelResponse deleteSignalingChannel(DeleteSignalingChannelRequest deleteSignalingChannelRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, VersionMismatchException, ResourceInUseException, AwsServiceException, SdkClientException, KinesisVideoException
Deletes a specified signaling channel.
DeleteSignalingChannelis an asynchronous operation. If you don't specify the channel's current version, the most recent version is deleted.- Parameters:
deleteSignalingChannelRequest-- Returns:
- Result of the DeleteSignalingChannel operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.VersionMismatchException- The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteSignalingChannel
default DeleteSignalingChannelResponse deleteSignalingChannel(Consumer<DeleteSignalingChannelRequest.Builder> deleteSignalingChannelRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, VersionMismatchException, ResourceInUseException, AwsServiceException, SdkClientException, KinesisVideoException
Deletes a specified signaling channel.
DeleteSignalingChannelis an asynchronous operation. If you don't specify the channel's current version, the most recent version is deleted.
This is a convenience which creates an instance of the
DeleteSignalingChannelRequest.Builderavoiding the need to create one manually viaDeleteSignalingChannelRequest.builder()- Parameters:
deleteSignalingChannelRequest- AConsumerthat will call methods onDeleteSignalingChannelRequest.Builderto create a request.- Returns:
- Result of the DeleteSignalingChannel operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.VersionMismatchException- The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteStream
default DeleteStreamResponse deleteStream(DeleteStreamRequest deleteStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, VersionMismatchException, ResourceInUseException, AwsServiceException, SdkClientException, KinesisVideoException
Deletes a Kinesis video stream and the data contained in the stream.
This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.
To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the
DescribeStreamAPI.This operation requires permission for the
KinesisVideo:DeleteStreamaction.- Parameters:
deleteStreamRequest-- Returns:
- Result of the DeleteStream operation returned by the service.
- Throws:
ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.NotAuthorizedException- The caller is not authorized to perform this operation.VersionMismatchException- The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteStream
default DeleteStreamResponse deleteStream(Consumer<DeleteStreamRequest.Builder> deleteStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, VersionMismatchException, ResourceInUseException, AwsServiceException, SdkClientException, KinesisVideoException
Deletes a Kinesis video stream and the data contained in the stream.
This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.
To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the
DescribeStreamAPI.This operation requires permission for the
KinesisVideo:DeleteStreamaction.
This is a convenience which creates an instance of the
DeleteStreamRequest.Builderavoiding the need to create one manually viaDeleteStreamRequest.builder()- Parameters:
deleteStreamRequest- AConsumerthat will call methods onDeleteStreamRequest.Builderto create a request.- Returns:
- Result of the DeleteStream operation returned by the service.
- Throws:
ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.NotAuthorizedException- The caller is not authorized to perform this operation.VersionMismatchException- The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEdgeConfiguration
default DescribeEdgeConfigurationResponse describeEdgeConfiguration(DescribeEdgeConfigurationRequest describeEdgeConfigurationRequest) throws AccessDeniedException, ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, StreamEdgeConfigurationNotFoundException, AwsServiceException, SdkClientException, KinesisVideoException
Describes a stream’s edge configuration that was set using the
StartEdgeConfigurationUpdateAPI and the latest status of the edge agent's recorder and uploader jobs. Use this API to get the status of the configuration to determine if the configuration is in sync with the Edge Agent. Use this API to evaluate the health of the Edge Agent.- Parameters:
describeEdgeConfigurationRequest-- Returns:
- Result of the DescribeEdgeConfiguration operation returned by the service.
- Throws:
AccessDeniedException- You do not have required permissions to perform this operation.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.StreamEdgeConfigurationNotFoundException- The Exception rendered when the Amazon Kinesis Video Stream can't find a stream's edge configuration that you specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEdgeConfiguration
default DescribeEdgeConfigurationResponse describeEdgeConfiguration(Consumer<DescribeEdgeConfigurationRequest.Builder> describeEdgeConfigurationRequest) throws AccessDeniedException, ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, StreamEdgeConfigurationNotFoundException, AwsServiceException, SdkClientException, KinesisVideoException
Describes a stream’s edge configuration that was set using the
StartEdgeConfigurationUpdateAPI and the latest status of the edge agent's recorder and uploader jobs. Use this API to get the status of the configuration to determine if the configuration is in sync with the Edge Agent. Use this API to evaluate the health of the Edge Agent.
This is a convenience which creates an instance of the
DescribeEdgeConfigurationRequest.Builderavoiding the need to create one manually viaDescribeEdgeConfigurationRequest.builder()- Parameters:
describeEdgeConfigurationRequest- AConsumerthat will call methods onDescribeEdgeConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeEdgeConfiguration operation returned by the service.
- Throws:
AccessDeniedException- You do not have required permissions to perform this operation.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.StreamEdgeConfigurationNotFoundException- The Exception rendered when the Amazon Kinesis Video Stream can't find a stream's edge configuration that you specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeImageGenerationConfiguration
default DescribeImageGenerationConfigurationResponse describeImageGenerationConfiguration(DescribeImageGenerationConfigurationRequest describeImageGenerationConfigurationRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
Gets the
ImageGenerationConfigurationfor a given Kinesis video stream.- Parameters:
describeImageGenerationConfigurationRequest-- Returns:
- Result of the DescribeImageGenerationConfiguration operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeImageGenerationConfiguration
default DescribeImageGenerationConfigurationResponse describeImageGenerationConfiguration(Consumer<DescribeImageGenerationConfigurationRequest.Builder> describeImageGenerationConfigurationRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
Gets the
ImageGenerationConfigurationfor a given Kinesis video stream.
This is a convenience which creates an instance of the
DescribeImageGenerationConfigurationRequest.Builderavoiding the need to create one manually viaDescribeImageGenerationConfigurationRequest.builder()- Parameters:
describeImageGenerationConfigurationRequest- AConsumerthat will call methods onDescribeImageGenerationConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeImageGenerationConfiguration operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeMappedResourceConfiguration
default DescribeMappedResourceConfigurationResponse describeMappedResourceConfiguration(DescribeMappedResourceConfigurationRequest describeMappedResourceConfigurationRequest) throws ResourceNotFoundException, InvalidArgumentException, AccessDeniedException, ClientLimitExceededException, AwsServiceException, SdkClientException, KinesisVideoException
Returns the most current information about the stream. The
streamNameorstreamARNshould be provided in the input.- Parameters:
describeMappedResourceConfigurationRequest-- Returns:
- Result of the DescribeMappedResourceConfiguration operation returned by the service.
- Throws:
ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.InvalidArgumentException- The value for this input parameter is invalid.AccessDeniedException- You do not have required permissions to perform this operation.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeMappedResourceConfiguration
default DescribeMappedResourceConfigurationResponse describeMappedResourceConfiguration(Consumer<DescribeMappedResourceConfigurationRequest.Builder> describeMappedResourceConfigurationRequest) throws ResourceNotFoundException, InvalidArgumentException, AccessDeniedException, ClientLimitExceededException, AwsServiceException, SdkClientException, KinesisVideoException
Returns the most current information about the stream. The
streamNameorstreamARNshould be provided in the input.
This is a convenience which creates an instance of the
DescribeMappedResourceConfigurationRequest.Builderavoiding the need to create one manually viaDescribeMappedResourceConfigurationRequest.builder()- Parameters:
describeMappedResourceConfigurationRequest- AConsumerthat will call methods onDescribeMappedResourceConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeMappedResourceConfiguration operation returned by the service.
- Throws:
ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.InvalidArgumentException- The value for this input parameter is invalid.AccessDeniedException- You do not have required permissions to perform this operation.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeMappedResourceConfigurationPaginator
default DescribeMappedResourceConfigurationIterable describeMappedResourceConfigurationPaginator(DescribeMappedResourceConfigurationRequest describeMappedResourceConfigurationRequest) throws ResourceNotFoundException, InvalidArgumentException, AccessDeniedException, ClientLimitExceededException, AwsServiceException, SdkClientException, KinesisVideoException
This is a variant of
describeMappedResourceConfiguration(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest)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
2) Using For loopsoftware.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationIterable responses = client.describeMappedResourceConfigurationPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationIterable responses = client .describeMappedResourceConfigurationPaginator(request); for (software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationIterable responses = client.describeMappedResourceConfigurationPaginator(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
describeMappedResourceConfiguration(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest)operation.- Parameters:
describeMappedResourceConfigurationRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.InvalidArgumentException- The value for this input parameter is invalid.AccessDeniedException- You do not have required permissions to perform this operation.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeMappedResourceConfigurationPaginator
default DescribeMappedResourceConfigurationIterable describeMappedResourceConfigurationPaginator(Consumer<DescribeMappedResourceConfigurationRequest.Builder> describeMappedResourceConfigurationRequest) throws ResourceNotFoundException, InvalidArgumentException, AccessDeniedException, ClientLimitExceededException, AwsServiceException, SdkClientException, KinesisVideoException
This is a variant of
describeMappedResourceConfiguration(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest)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
2) Using For loopsoftware.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationIterable responses = client.describeMappedResourceConfigurationPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationIterable responses = client .describeMappedResourceConfigurationPaginator(request); for (software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.kinesisvideo.paginators.DescribeMappedResourceConfigurationIterable responses = client.describeMappedResourceConfigurationPaginator(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
describeMappedResourceConfiguration(software.amazon.awssdk.services.kinesisvideo.model.DescribeMappedResourceConfigurationRequest)operation.
This is a convenience which creates an instance of the
DescribeMappedResourceConfigurationRequest.Builderavoiding the need to create one manually viaDescribeMappedResourceConfigurationRequest.builder()- Parameters:
describeMappedResourceConfigurationRequest- AConsumerthat will call methods onDescribeMappedResourceConfigurationRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.InvalidArgumentException- The value for this input parameter is invalid.AccessDeniedException- You do not have required permissions to perform this operation.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeMediaStorageConfiguration
default DescribeMediaStorageConfigurationResponse describeMediaStorageConfiguration(DescribeMediaStorageConfigurationRequest describeMediaStorageConfigurationRequest) throws ResourceNotFoundException, InvalidArgumentException, AccessDeniedException, ClientLimitExceededException, AwsServiceException, SdkClientException, KinesisVideoException
Returns the most current information about the channel. Specify the
ChannelNameorChannelARNin the input.- Parameters:
describeMediaStorageConfigurationRequest-- Returns:
- Result of the DescribeMediaStorageConfiguration operation returned by the service.
- Throws:
ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.InvalidArgumentException- The value for this input parameter is invalid.AccessDeniedException- You do not have required permissions to perform this operation.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeMediaStorageConfiguration
default DescribeMediaStorageConfigurationResponse describeMediaStorageConfiguration(Consumer<DescribeMediaStorageConfigurationRequest.Builder> describeMediaStorageConfigurationRequest) throws ResourceNotFoundException, InvalidArgumentException, AccessDeniedException, ClientLimitExceededException, AwsServiceException, SdkClientException, KinesisVideoException
Returns the most current information about the channel. Specify the
ChannelNameorChannelARNin the input.
This is a convenience which creates an instance of the
DescribeMediaStorageConfigurationRequest.Builderavoiding the need to create one manually viaDescribeMediaStorageConfigurationRequest.builder()- Parameters:
describeMediaStorageConfigurationRequest- AConsumerthat will call methods onDescribeMediaStorageConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeMediaStorageConfiguration operation returned by the service.
- Throws:
ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.InvalidArgumentException- The value for this input parameter is invalid.AccessDeniedException- You do not have required permissions to perform this operation.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeNotificationConfiguration
default DescribeNotificationConfigurationResponse describeNotificationConfiguration(DescribeNotificationConfigurationRequest describeNotificationConfigurationRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
Gets the
NotificationConfigurationfor a given Kinesis video stream.- Parameters:
describeNotificationConfigurationRequest-- Returns:
- Result of the DescribeNotificationConfiguration operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeNotificationConfiguration
default DescribeNotificationConfigurationResponse describeNotificationConfiguration(Consumer<DescribeNotificationConfigurationRequest.Builder> describeNotificationConfigurationRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
Gets the
NotificationConfigurationfor a given Kinesis video stream.
This is a convenience which creates an instance of the
DescribeNotificationConfigurationRequest.Builderavoiding the need to create one manually viaDescribeNotificationConfigurationRequest.builder()- Parameters:
describeNotificationConfigurationRequest- AConsumerthat will call methods onDescribeNotificationConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeNotificationConfiguration operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeSignalingChannel
default DescribeSignalingChannelResponse describeSignalingChannel(DescribeSignalingChannelRequest describeSignalingChannelRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.
- Parameters:
describeSignalingChannelRequest-- Returns:
- Result of the DescribeSignalingChannel operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeSignalingChannel
default DescribeSignalingChannelResponse describeSignalingChannel(Consumer<DescribeSignalingChannelRequest.Builder> describeSignalingChannelRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.
This is a convenience which creates an instance of the
DescribeSignalingChannelRequest.Builderavoiding the need to create one manually viaDescribeSignalingChannelRequest.builder()- Parameters:
describeSignalingChannelRequest- AConsumerthat will call methods onDescribeSignalingChannelRequest.Builderto create a request.- Returns:
- Result of the DescribeSignalingChannel operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeStream
default DescribeStreamResponse describeStream(DescribeStreamRequest describeStreamRequest) throws InvalidArgumentException, ResourceNotFoundException, ClientLimitExceededException, NotAuthorizedException, AwsServiceException, SdkClientException, KinesisVideoException
Returns the most current information about the specified stream. You must specify either the
StreamNameor theStreamARN.- Parameters:
describeStreamRequest-- Returns:
- Result of the DescribeStream operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.NotAuthorizedException- The caller is not authorized to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeStream
default DescribeStreamResponse describeStream(Consumer<DescribeStreamRequest.Builder> describeStreamRequest) throws InvalidArgumentException, ResourceNotFoundException, ClientLimitExceededException, NotAuthorizedException, AwsServiceException, SdkClientException, KinesisVideoException
Returns the most current information about the specified stream. You must specify either the
StreamNameor theStreamARN.
This is a convenience which creates an instance of the
DescribeStreamRequest.Builderavoiding the need to create one manually viaDescribeStreamRequest.builder()- Parameters:
describeStreamRequest- AConsumerthat will call methods onDescribeStreamRequest.Builderto create a request.- Returns:
- Result of the DescribeStream operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.NotAuthorizedException- The caller is not authorized to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDataEndpoint
default GetDataEndpointResponse getDataEndpoint(GetDataEndpointRequest getDataEndpointRequest) throws InvalidArgumentException, ResourceNotFoundException, ClientLimitExceededException, NotAuthorizedException, AwsServiceException, SdkClientException, KinesisVideoException
Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the
GetMediaorGetMediaForFragmentListoperations) or write to it (using thePutMediaoperation).The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint.
In the request, specify the stream either by
StreamNameorStreamARN.- Parameters:
getDataEndpointRequest-- Returns:
- Result of the GetDataEndpoint operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.NotAuthorizedException- The caller is not authorized to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDataEndpoint
default GetDataEndpointResponse getDataEndpoint(Consumer<GetDataEndpointRequest.Builder> getDataEndpointRequest) throws InvalidArgumentException, ResourceNotFoundException, ClientLimitExceededException, NotAuthorizedException, AwsServiceException, SdkClientException, KinesisVideoException
Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the
GetMediaorGetMediaForFragmentListoperations) or write to it (using thePutMediaoperation).The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint.
In the request, specify the stream either by
StreamNameorStreamARN.
This is a convenience which creates an instance of the
GetDataEndpointRequest.Builderavoiding the need to create one manually viaGetDataEndpointRequest.builder()- Parameters:
getDataEndpointRequest- AConsumerthat will call methods onGetDataEndpointRequest.Builderto create a request.- Returns:
- Result of the GetDataEndpoint operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.NotAuthorizedException- The caller is not authorized to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getSignalingChannelEndpoint
default GetSignalingChannelEndpointResponse getSignalingChannelEndpoint(GetSignalingChannelEndpointRequest getSignalingChannelEndpointRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, ResourceInUseException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the
SingleMasterChannelEndpointConfigurationinput parameter, which consists of theProtocolsandRoleproperties.Protocolsis used to determine the communication mechanism. For example, if you specifyWSSas the protocol, this API produces a secure websocket endpoint. If you specifyHTTPSas the protocol, this API generates an HTTPS endpoint.Roledetermines the messaging permissions. AMASTERrole results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. AVIEWERrole results in this API generating an endpoint that a client can use to communicate only with aMASTER.- Parameters:
getSignalingChannelEndpointRequest-- Returns:
- Result of the GetSignalingChannelEndpoint operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
AccessDeniedException- You do not have required permissions to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getSignalingChannelEndpoint
default GetSignalingChannelEndpointResponse getSignalingChannelEndpoint(Consumer<GetSignalingChannelEndpointRequest.Builder> getSignalingChannelEndpointRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, ResourceInUseException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the
SingleMasterChannelEndpointConfigurationinput parameter, which consists of theProtocolsandRoleproperties.Protocolsis used to determine the communication mechanism. For example, if you specifyWSSas the protocol, this API produces a secure websocket endpoint. If you specifyHTTPSas the protocol, this API generates an HTTPS endpoint.Roledetermines the messaging permissions. AMASTERrole results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. AVIEWERrole results in this API generating an endpoint that a client can use to communicate only with aMASTER.
This is a convenience which creates an instance of the
GetSignalingChannelEndpointRequest.Builderavoiding the need to create one manually viaGetSignalingChannelEndpointRequest.builder()- Parameters:
getSignalingChannelEndpointRequest- AConsumerthat will call methods onGetSignalingChannelEndpointRequest.Builderto create a request.- Returns:
- Result of the GetSignalingChannelEndpoint operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
AccessDeniedException- You do not have required permissions to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listEdgeAgentConfigurations
default ListEdgeAgentConfigurationsResponse listEdgeAgentConfigurations(ListEdgeAgentConfigurationsRequest listEdgeAgentConfigurationsRequest) throws NotAuthorizedException, ClientLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoException
Returns an array of edge configurations associated with the specified Edge Agent.
In the request, you must specify the Edge Agent
HubDeviceArn.- Parameters:
listEdgeAgentConfigurationsRequest-- Returns:
- Result of the ListEdgeAgentConfigurations operation returned by the service.
- Throws:
NotAuthorizedException- The caller is not authorized to perform this operation.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listEdgeAgentConfigurations
default ListEdgeAgentConfigurationsResponse listEdgeAgentConfigurations(Consumer<ListEdgeAgentConfigurationsRequest.Builder> listEdgeAgentConfigurationsRequest) throws NotAuthorizedException, ClientLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoException
Returns an array of edge configurations associated with the specified Edge Agent.
In the request, you must specify the Edge Agent
HubDeviceArn.
This is a convenience which creates an instance of the
ListEdgeAgentConfigurationsRequest.Builderavoiding the need to create one manually viaListEdgeAgentConfigurationsRequest.builder()- Parameters:
listEdgeAgentConfigurationsRequest- AConsumerthat will call methods onListEdgeAgentConfigurationsRequest.Builderto create a request.- Returns:
- Result of the ListEdgeAgentConfigurations operation returned by the service.
- Throws:
NotAuthorizedException- The caller is not authorized to perform this operation.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listEdgeAgentConfigurationsPaginator
default ListEdgeAgentConfigurationsIterable listEdgeAgentConfigurationsPaginator(ListEdgeAgentConfigurationsRequest listEdgeAgentConfigurationsRequest) throws NotAuthorizedException, ClientLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoException
This is a variant of
listEdgeAgentConfigurations(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsIterable responses = client.listEdgeAgentConfigurationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsIterable responses = client .listEdgeAgentConfigurationsPaginator(request); for (software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsIterable responses = client.listEdgeAgentConfigurationsPaginator(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
listEdgeAgentConfigurations(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest)operation.- Parameters:
listEdgeAgentConfigurationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
NotAuthorizedException- The caller is not authorized to perform this operation.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listEdgeAgentConfigurationsPaginator
default ListEdgeAgentConfigurationsIterable listEdgeAgentConfigurationsPaginator(Consumer<ListEdgeAgentConfigurationsRequest.Builder> listEdgeAgentConfigurationsRequest) throws NotAuthorizedException, ClientLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoException
This is a variant of
listEdgeAgentConfigurations(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsIterable responses = client.listEdgeAgentConfigurationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsIterable responses = client .listEdgeAgentConfigurationsPaginator(request); for (software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.kinesisvideo.paginators.ListEdgeAgentConfigurationsIterable responses = client.listEdgeAgentConfigurationsPaginator(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
listEdgeAgentConfigurations(software.amazon.awssdk.services.kinesisvideo.model.ListEdgeAgentConfigurationsRequest)operation.
This is a convenience which creates an instance of the
ListEdgeAgentConfigurationsRequest.Builderavoiding the need to create one manually viaListEdgeAgentConfigurationsRequest.builder()- Parameters:
listEdgeAgentConfigurationsRequest- AConsumerthat will call methods onListEdgeAgentConfigurationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
NotAuthorizedException- The caller is not authorized to perform this operation.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listSignalingChannels
default ListSignalingChannelsResponse listSignalingChannels(ListSignalingChannelsRequest listSignalingChannelsRequest) throws InvalidArgumentException, ClientLimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
Returns an array of
ChannelInfoobjects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify aChannelNameCondition.- Parameters:
listSignalingChannelsRequest-- Returns:
- Result of the ListSignalingChannels operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.AccessDeniedException- You do not have required permissions to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listSignalingChannels
default ListSignalingChannelsResponse listSignalingChannels(Consumer<ListSignalingChannelsRequest.Builder> listSignalingChannelsRequest) throws InvalidArgumentException, ClientLimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
Returns an array of
ChannelInfoobjects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify aChannelNameCondition.
This is a convenience which creates an instance of the
ListSignalingChannelsRequest.Builderavoiding the need to create one manually viaListSignalingChannelsRequest.builder()- Parameters:
listSignalingChannelsRequest- AConsumerthat will call methods onListSignalingChannelsRequest.Builderto create a request.- Returns:
- Result of the ListSignalingChannels operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.AccessDeniedException- You do not have required permissions to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listSignalingChannelsPaginator
default ListSignalingChannelsIterable listSignalingChannelsPaginator(ListSignalingChannelsRequest listSignalingChannelsRequest) throws InvalidArgumentException, ClientLimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
This is a variant of
listSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsIterable responses = client.listSignalingChannelsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsIterable responses = client .listSignalingChannelsPaginator(request); for (software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsIterable responses = client.listSignalingChannelsPaginator(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
listSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest)operation.- Parameters:
listSignalingChannelsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.AccessDeniedException- You do not have required permissions to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listSignalingChannelsPaginator
default ListSignalingChannelsIterable listSignalingChannelsPaginator(Consumer<ListSignalingChannelsRequest.Builder> listSignalingChannelsRequest) throws InvalidArgumentException, ClientLimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
This is a variant of
listSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsIterable responses = client.listSignalingChannelsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsIterable responses = client .listSignalingChannelsPaginator(request); for (software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.kinesisvideo.paginators.ListSignalingChannelsIterable responses = client.listSignalingChannelsPaginator(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
listSignalingChannels(software.amazon.awssdk.services.kinesisvideo.model.ListSignalingChannelsRequest)operation.
This is a convenience which creates an instance of the
ListSignalingChannelsRequest.Builderavoiding the need to create one manually viaListSignalingChannelsRequest.builder()- Parameters:
listSignalingChannelsRequest- AConsumerthat will call methods onListSignalingChannelsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.AccessDeniedException- You do not have required permissions to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listStreams
default ListStreamsResponse listStreams(ListStreamsRequest listStreamsRequest) throws ClientLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoException
Returns an array of
StreamInfoobjects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify aStreamNameCondition.- Parameters:
listStreamsRequest-- Returns:
- Result of the ListStreams operation returned by the service.
- Throws:
ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listStreams
default ListStreamsResponse listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest) throws ClientLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoException
Returns an array of
StreamInfoobjects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify aStreamNameCondition.
This is a convenience which creates an instance of the
ListStreamsRequest.Builderavoiding the need to create one manually viaListStreamsRequest.builder()- Parameters:
listStreamsRequest- AConsumerthat will call methods onListStreamsRequest.Builderto create a request.- Returns:
- Result of the ListStreams operation returned by the service.
- Throws:
ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listStreams
default ListStreamsResponse listStreams() throws ClientLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoException
Returns an array of
StreamInfoobjects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify aStreamNameCondition.- Returns:
- Result of the ListStreams operation returned by the service.
- Throws:
ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
listStreams(ListStreamsRequest), AWS API Documentation
-
listStreamsPaginator
default ListStreamsIterable listStreamsPaginator() throws ClientLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoException
This is a variant of
listStreams(software.amazon.awssdk.services.kinesisvideo.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
2) Using For loopsoftware.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); for (software.amazon.awssdk.services.kinesisvideo.model.ListStreamsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
listStreamsPaginator(ListStreamsRequest), AWS API Documentation
-
listStreamsPaginator
default ListStreamsIterable listStreamsPaginator(ListStreamsRequest listStreamsRequest) throws ClientLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoException
This is a variant of
listStreams(software.amazon.awssdk.services.kinesisvideo.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
2) Using For loopsoftware.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); for (software.amazon.awssdk.services.kinesisvideo.model.ListStreamsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest)operation.- Parameters:
listStreamsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listStreamsPaginator
default ListStreamsIterable listStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest) throws ClientLimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisVideoException
This is a variant of
listStreams(software.amazon.awssdk.services.kinesisvideo.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
2) Using For loopsoftware.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); for (software.amazon.awssdk.services.kinesisvideo.model.ListStreamsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.kinesisvideo.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.kinesisvideo.model.ListStreamsRequest)operation.
This is a convenience which creates an instance of the
ListStreamsRequest.Builderavoiding the need to create one manually viaListStreamsRequest.builder()- Parameters:
listStreamsRequest- AConsumerthat will call methods onListStreamsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
Returns a list of tags associated with the specified signaling channel.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
Returns a list of tags associated with the specified signaling channel.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForStream
default ListTagsForStreamResponse listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, InvalidResourceFormatException, AwsServiceException, SdkClientException, KinesisVideoException
Returns a list of tags associated with the specified stream.
In the request, you must specify either the
StreamNameor theStreamARN.- Parameters:
listTagsForStreamRequest-- Returns:
- Result of the ListTagsForStream operation returned by the service.
- Throws:
ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.NotAuthorizedException- The caller is not authorized to perform this operation.InvalidResourceFormatException- The format of theStreamARNis invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForStream
default ListTagsForStreamResponse listTagsForStream(Consumer<ListTagsForStreamRequest.Builder> listTagsForStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, InvalidResourceFormatException, AwsServiceException, SdkClientException, KinesisVideoException
Returns a list of tags associated with the specified stream.
In the request, you must specify either the
StreamNameor theStreamARN.
This is a convenience which creates an instance of the
ListTagsForStreamRequest.Builderavoiding the need to create one manually viaListTagsForStreamRequest.builder()- Parameters:
listTagsForStreamRequest- AConsumerthat will call methods onListTagsForStreamRequest.Builderto create a request.- Returns:
- Result of the ListTagsForStream operation returned by the service.
- Throws:
ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.NotAuthorizedException- The caller is not authorized to perform this operation.InvalidResourceFormatException- The format of theStreamARNis invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startEdgeConfigurationUpdate
default StartEdgeConfigurationUpdateResponse startEdgeConfigurationUpdate(StartEdgeConfigurationUpdateRequest startEdgeConfigurationUpdateRequest) throws AccessDeniedException, ClientLimitExceededException, InvalidArgumentException, NoDataRetentionException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, KinesisVideoException
An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The
SyncStatuswill be updated as the edge configuration is acknowledged, and synced with the Edge Agent.If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to
SYNCING. You will have to wait for the sync status to reach a terminal state such as:IN_SYNC, orSYNC_FAILED, before using this API again. If you invoke this API during the syncing process, aResourceInUseExceptionwill be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into theSYNC_FAILEDstate.To move an edge configuration from one device to another, use DeleteEdgeConfiguration to delete the current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an updated Hub Device ARN.
- Parameters:
startEdgeConfigurationUpdateRequest-- Returns:
- Result of the StartEdgeConfigurationUpdate operation returned by the service.
- Throws:
AccessDeniedException- You do not have required permissions to perform this operation.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.NoDataRetentionException- The Stream data retention in hours is equal to zero.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startEdgeConfigurationUpdate
default StartEdgeConfigurationUpdateResponse startEdgeConfigurationUpdate(Consumer<StartEdgeConfigurationUpdateRequest.Builder> startEdgeConfigurationUpdateRequest) throws AccessDeniedException, ClientLimitExceededException, InvalidArgumentException, NoDataRetentionException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, KinesisVideoException
An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The
SyncStatuswill be updated as the edge configuration is acknowledged, and synced with the Edge Agent.If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to
SYNCING. You will have to wait for the sync status to reach a terminal state such as:IN_SYNC, orSYNC_FAILED, before using this API again. If you invoke this API during the syncing process, aResourceInUseExceptionwill be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into theSYNC_FAILEDstate.To move an edge configuration from one device to another, use DeleteEdgeConfiguration to delete the current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an updated Hub Device ARN.
This is a convenience which creates an instance of the
StartEdgeConfigurationUpdateRequest.Builderavoiding the need to create one manually viaStartEdgeConfigurationUpdateRequest.builder()- Parameters:
startEdgeConfigurationUpdateRequest- AConsumerthat will call methods onStartEdgeConfigurationUpdateRequest.Builderto create a request.- Returns:
- Result of the StartEdgeConfigurationUpdate operation returned by the service.
- Throws:
AccessDeniedException- You do not have required permissions to perform this operation.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.NoDataRetentionException- The Stream data retention in hours is equal to zero.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, TagsPerResourceExceededLimitException, AwsServiceException, SdkClientException, KinesisVideoException
Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the Billing and Cost Management and Cost Management User Guide.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.TagsPerResourceExceededLimitException- You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, TagsPerResourceExceededLimitException, AwsServiceException, SdkClientException, KinesisVideoException
Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the Billing and Cost Management and Cost Management User Guide.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.TagsPerResourceExceededLimitException- You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagStream
default TagStreamResponse tagStream(TagStreamRequest tagStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, InvalidResourceFormatException, TagsPerResourceExceededLimitException, AwsServiceException, SdkClientException, KinesisVideoException
Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the Billing and Cost Management and Cost Management User Guide.
You must provide either the
StreamNameor theStreamARN.This operation requires permission for the
KinesisVideo:TagStreamaction.A Kinesis video stream can support up to 50 tags.
- Parameters:
tagStreamRequest-- Returns:
- Result of the TagStream operation returned by the service.
- Throws:
ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.NotAuthorizedException- The caller is not authorized to perform this operation.InvalidResourceFormatException- The format of theStreamARNis invalid.TagsPerResourceExceededLimitException- You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagStream
default TagStreamResponse tagStream(Consumer<TagStreamRequest.Builder> tagStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, InvalidResourceFormatException, TagsPerResourceExceededLimitException, AwsServiceException, SdkClientException, KinesisVideoException
Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the Billing and Cost Management and Cost Management User Guide.
You must provide either the
StreamNameor theStreamARN.This operation requires permission for the
KinesisVideo:TagStreamaction.A Kinesis video stream can support up to 50 tags.
This is a convenience which creates an instance of the
TagStreamRequest.Builderavoiding the need to create one manually viaTagStreamRequest.builder()- Parameters:
tagStreamRequest- AConsumerthat will call methods onTagStreamRequest.Builderto create a request.- Returns:
- Result of the TagStream operation returned by the service.
- Throws:
ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.NotAuthorizedException- The caller is not authorized to perform this operation.InvalidResourceFormatException- The format of theStreamARNis invalid.TagsPerResourceExceededLimitException- You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisVideoException
Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagStream
default UntagStreamResponse untagStream(UntagStreamRequest untagStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, InvalidResourceFormatException, AwsServiceException, SdkClientException, KinesisVideoException
Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.
In the request, you must provide the
StreamNameorStreamARN.- Parameters:
untagStreamRequest-- Returns:
- Result of the UntagStream operation returned by the service.
- Throws:
ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.NotAuthorizedException- The caller is not authorized to perform this operation.InvalidResourceFormatException- The format of theStreamARNis invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagStream
default UntagStreamResponse untagStream(Consumer<UntagStreamRequest.Builder> untagStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, InvalidResourceFormatException, AwsServiceException, SdkClientException, KinesisVideoException
Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.
In the request, you must provide the
StreamNameorStreamARN.
This is a convenience which creates an instance of the
UntagStreamRequest.Builderavoiding the need to create one manually viaUntagStreamRequest.builder()- Parameters:
untagStreamRequest- AConsumerthat will call methods onUntagStreamRequest.Builderto create a request.- Returns:
- Result of the UntagStream operation returned by the service.
- Throws:
ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.NotAuthorizedException- The caller is not authorized to perform this operation.InvalidResourceFormatException- The format of theStreamARNis invalid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateDataRetention
default UpdateDataRetentionResponse updateDataRetention(UpdateDataRetentionRequest updateDataRetentionRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, ResourceInUseException, NotAuthorizedException, VersionMismatchException, AwsServiceException, SdkClientException, KinesisVideoException
Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the
Operationparameter in the request body. In the request, you must specify either theStreamNameor theStreamARN.This operation requires permission for the
KinesisVideo:UpdateDataRetentionaction.Changing the data retention period affects the data in the stream as follows:
-
If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours.
-
If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.
- Parameters:
updateDataRetentionRequest-- Returns:
- Result of the UpdateDataRetention operation returned by the service.
- Throws:
ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
NotAuthorizedException- The caller is not authorized to perform this operation.VersionMismatchException- The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
updateDataRetention
default UpdateDataRetentionResponse updateDataRetention(Consumer<UpdateDataRetentionRequest.Builder> updateDataRetentionRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, ResourceInUseException, NotAuthorizedException, VersionMismatchException, AwsServiceException, SdkClientException, KinesisVideoException
Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the
Operationparameter in the request body. In the request, you must specify either theStreamNameor theStreamARN.This operation requires permission for the
KinesisVideo:UpdateDataRetentionaction.Changing the data retention period affects the data in the stream as follows:
-
If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours.
-
If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.
This is a convenience which creates an instance of the
UpdateDataRetentionRequest.Builderavoiding the need to create one manually viaUpdateDataRetentionRequest.builder()- Parameters:
updateDataRetentionRequest- AConsumerthat will call methods onUpdateDataRetentionRequest.Builderto create a request.- Returns:
- Result of the UpdateDataRetention operation returned by the service.
- Throws:
ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
NotAuthorizedException- The caller is not authorized to perform this operation.VersionMismatchException- The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
updateImageGenerationConfiguration
default UpdateImageGenerationConfigurationResponse updateImageGenerationConfiguration(UpdateImageGenerationConfigurationRequest updateImageGenerationConfigurationRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, ResourceInUseException, NoDataRetentionException, AwsServiceException, SdkClientException, KinesisVideoException
Updates the
StreamInfoandImageProcessingConfigurationfields.- Parameters:
updateImageGenerationConfigurationRequest-- Returns:
- Result of the UpdateImageGenerationConfiguration operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
NoDataRetentionException- The Stream data retention in hours is equal to zero.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateImageGenerationConfiguration
default UpdateImageGenerationConfigurationResponse updateImageGenerationConfiguration(Consumer<UpdateImageGenerationConfigurationRequest.Builder> updateImageGenerationConfigurationRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, ResourceInUseException, NoDataRetentionException, AwsServiceException, SdkClientException, KinesisVideoException
Updates the
StreamInfoandImageProcessingConfigurationfields.
This is a convenience which creates an instance of the
UpdateImageGenerationConfigurationRequest.Builderavoiding the need to create one manually viaUpdateImageGenerationConfigurationRequest.builder()- Parameters:
updateImageGenerationConfigurationRequest- AConsumerthat will call methods onUpdateImageGenerationConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdateImageGenerationConfiguration operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
NoDataRetentionException- The Stream data retention in hours is equal to zero.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateMediaStorageConfiguration
default UpdateMediaStorageConfigurationResponse updateMediaStorageConfiguration(UpdateMediaStorageConfigurationRequest updateMediaStorageConfigurationRequest) throws ResourceInUseException, InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, NoDataRetentionException, AwsServiceException, SdkClientException, KinesisVideoException
Associates a
SignalingChannelto a stream to store the media. There are two signaling modes that you can specify :-
If
StorageStatusis enabled, the data will be stored in theStreamARNprovided. In order for WebRTC Ingestion to work, the stream must have data retention enabled. -
If
StorageStatusis disabled, no data will be stored, and theStreamARNparameter will not be needed.
If
StorageStatusis enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call theJoinStorageSessionAPI to trigger an SDP offer send and establish a connection between a peer and the storage session.- Parameters:
updateMediaStorageConfigurationRequest-- Returns:
- Result of the UpdateMediaStorageConfiguration operation returned by the service.
- Throws:
ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.NoDataRetentionException- The Stream data retention in hours is equal to zero.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
updateMediaStorageConfiguration
default UpdateMediaStorageConfigurationResponse updateMediaStorageConfiguration(Consumer<UpdateMediaStorageConfigurationRequest.Builder> updateMediaStorageConfigurationRequest) throws ResourceInUseException, InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, NoDataRetentionException, AwsServiceException, SdkClientException, KinesisVideoException
Associates a
SignalingChannelto a stream to store the media. There are two signaling modes that you can specify :-
If
StorageStatusis enabled, the data will be stored in theStreamARNprovided. In order for WebRTC Ingestion to work, the stream must have data retention enabled. -
If
StorageStatusis disabled, no data will be stored, and theStreamARNparameter will not be needed.
If
StorageStatusis enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call theJoinStorageSessionAPI to trigger an SDP offer send and establish a connection between a peer and the storage session.
This is a convenience which creates an instance of the
UpdateMediaStorageConfigurationRequest.Builderavoiding the need to create one manually viaUpdateMediaStorageConfigurationRequest.builder()- Parameters:
updateMediaStorageConfigurationRequest- AConsumerthat will call methods onUpdateMediaStorageConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdateMediaStorageConfiguration operation returned by the service.
- Throws:
ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.NoDataRetentionException- The Stream data retention in hours is equal to zero.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
updateNotificationConfiguration
default UpdateNotificationConfigurationResponse updateNotificationConfiguration(UpdateNotificationConfigurationRequest updateNotificationConfigurationRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, ResourceInUseException, NoDataRetentionException, AwsServiceException, SdkClientException, KinesisVideoException
Updates the notification information for a stream.
- Parameters:
updateNotificationConfigurationRequest-- Returns:
- Result of the UpdateNotificationConfiguration operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
NoDataRetentionException- The Stream data retention in hours is equal to zero.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateNotificationConfiguration
default UpdateNotificationConfigurationResponse updateNotificationConfiguration(Consumer<UpdateNotificationConfigurationRequest.Builder> updateNotificationConfigurationRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, AccessDeniedException, ResourceInUseException, NoDataRetentionException, AwsServiceException, SdkClientException, KinesisVideoException
Updates the notification information for a stream.
This is a convenience which creates an instance of the
UpdateNotificationConfigurationRequest.Builderavoiding the need to create one manually viaUpdateNotificationConfigurationRequest.builder()- Parameters:
updateNotificationConfigurationRequest- AConsumerthat will call methods onUpdateNotificationConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdateNotificationConfiguration operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException- You do not have required permissions to perform this operation.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
NoDataRetentionException- The Stream data retention in hours is equal to zero.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateSignalingChannel
default UpdateSignalingChannelResponse updateSignalingChannel(UpdateSignalingChannelRequest updateSignalingChannelRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, ResourceInUseException, AccessDeniedException, VersionMismatchException, AwsServiceException, SdkClientException, KinesisVideoException
Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.
If the
MessageTtlSecondsvalue is updated (either increased or reduced), it only applies to new messages sent via this channel after it's been updated. Existing messages are still expired as per the previousMessageTtlSecondsvalue.- Parameters:
updateSignalingChannelRequest-- Returns:
- Result of the UpdateSignalingChannel operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
AccessDeniedException- You do not have required permissions to perform this operation.VersionMismatchException- The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateSignalingChannel
default UpdateSignalingChannelResponse updateSignalingChannel(Consumer<UpdateSignalingChannelRequest.Builder> updateSignalingChannelRequest) throws InvalidArgumentException, ClientLimitExceededException, ResourceNotFoundException, ResourceInUseException, AccessDeniedException, VersionMismatchException, AwsServiceException, SdkClientException, KinesisVideoException
Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.
If the
MessageTtlSecondsvalue is updated (either increased or reduced), it only applies to new messages sent via this channel after it's been updated. Existing messages are still expired as per the previousMessageTtlSecondsvalue.
This is a convenience which creates an instance of the
UpdateSignalingChannelRequest.Builderavoiding the need to create one manually viaUpdateSignalingChannelRequest.builder()- Parameters:
updateSignalingChannelRequest- AConsumerthat will call methods onUpdateSignalingChannelRequest.Builderto create a request.- Returns:
- Result of the UpdateSignalingChannel operation returned by the service.
- Throws:
InvalidArgumentException- The value for this input parameter is invalid.ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
AccessDeniedException- You do not have required permissions to perform this operation.VersionMismatchException- The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateStream
default UpdateStreamResponse updateStream(UpdateStreamRequest updateStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, ResourceInUseException, NotAuthorizedException, VersionMismatchException, AwsServiceException, SdkClientException, KinesisVideoException
Updates stream metadata, such as the device name and media type.
You must provide the stream name or the Amazon Resource Name (ARN) of the stream.
To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the
DescribeStreamAPI.UpdateStreamis an asynchronous operation, and takes time to complete.- Parameters:
updateStreamRequest-- Returns:
- Result of the UpdateStream operation returned by the service.
- Throws:
ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
NotAuthorizedException- The caller is not authorized to perform this operation.VersionMismatchException- The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateStream
default UpdateStreamResponse updateStream(Consumer<UpdateStreamRequest.Builder> updateStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, ResourceInUseException, NotAuthorizedException, VersionMismatchException, AwsServiceException, SdkClientException, KinesisVideoException
Updates stream metadata, such as the device name and media type.
You must provide the stream name or the Amazon Resource Name (ARN) of the stream.
To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the
DescribeStreamAPI.UpdateStreamis an asynchronous operation, and takes time to complete.
This is a convenience which creates an instance of the
UpdateStreamRequest.Builderavoiding the need to create one manually viaUpdateStreamRequest.builder()- Parameters:
updateStreamRequest- AConsumerthat will call methods onUpdateStreamRequest.Builderto create a request.- Returns:
- Result of the UpdateStream operation returned by the service.
- Throws:
ClientLimitExceededException- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.InvalidArgumentException- The value for this input parameter is invalid.ResourceNotFoundException- Amazon Kinesis Video Streams can't find the stream that you specified.ResourceInUseException- When the inputStreamARNorChannelARNinCLOUD_STORAGE_MODEis already mapped to a different Kinesis Video Stream resource, or if the provided inputStreamARNorChannelARNis not in Active status, try one of the following :-
The
DescribeMediaStorageConfigurationAPI to determine what the stream given channel is mapped to. -
The
DescribeMappedResourceConfigurationAPI to determine the channel that the given stream is mapped to. -
The
DescribeStreamorDescribeSignalingChannelAPI to determine the status of the resource.
-
NotAuthorizedException- The caller is not authorized to perform this operation.VersionMismatchException- The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisVideoException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static KinesisVideoClient create()
Create aKinesisVideoClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static KinesisVideoClientBuilder builder()
Create a builder that can be used to configure and create aKinesisVideoClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default KinesisVideoServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-