@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonKinesisVideoClient extends AmazonWebServiceClient implements AmazonKinesisVideo
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AmazonKinesisVideoClientBuilder |
builder() |
CreateSignalingChannelResult |
createSignalingChannel(CreateSignalingChannelRequest request)
Creates a signaling channel.
|
CreateStreamResult |
createStream(CreateStreamRequest request)
Creates a new Kinesis video stream.
|
DeleteEdgeConfigurationResult |
deleteEdgeConfiguration(DeleteEdgeConfigurationRequest request)
An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from
the Edge Agent.
|
DeleteSignalingChannelResult |
deleteSignalingChannel(DeleteSignalingChannelRequest request)
Deletes a specified signaling channel.
|
DeleteStreamResult |
deleteStream(DeleteStreamRequest request)
Deletes a Kinesis video stream and the data contained in the stream.
|
DescribeEdgeConfigurationResult |
describeEdgeConfiguration(DescribeEdgeConfigurationRequest request)
Describes a stream’s edge configuration that was set using the
StartEdgeConfigurationUpdate API and
the latest status of the edge agent's recorder and uploader jobs. |
DescribeImageGenerationConfigurationResult |
describeImageGenerationConfiguration(DescribeImageGenerationConfigurationRequest request)
Gets the
ImageGenerationConfiguration for a given Kinesis video stream. |
DescribeMappedResourceConfigurationResult |
describeMappedResourceConfiguration(DescribeMappedResourceConfigurationRequest request)
Returns the most current information about the stream.
|
DescribeMediaStorageConfigurationResult |
describeMediaStorageConfiguration(DescribeMediaStorageConfigurationRequest request)
Returns the most current information about the channel.
|
DescribeNotificationConfigurationResult |
describeNotificationConfiguration(DescribeNotificationConfigurationRequest request)
Gets the
NotificationConfiguration for a given Kinesis video stream. |
DescribeSignalingChannelResult |
describeSignalingChannel(DescribeSignalingChannelRequest request)
Returns the most current information about the signaling channel.
|
DescribeStreamResult |
describeStream(DescribeStreamRequest request)
Returns the most current information about the specified stream.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDataEndpointResult |
getDataEndpoint(GetDataEndpointRequest request)
Gets an endpoint for a specified stream for either reading or writing.
|
GetSignalingChannelEndpointResult |
getSignalingChannelEndpoint(GetSignalingChannelEndpointRequest request)
Provides an endpoint for the specified signaling channel to send and receive messages.
|
ListEdgeAgentConfigurationsResult |
listEdgeAgentConfigurations(ListEdgeAgentConfigurationsRequest request)
Returns an array of edge configurations associated with the specified Edge Agent.
|
ListSignalingChannelsResult |
listSignalingChannels(ListSignalingChannelsRequest request)
Returns an array of
ChannelInfo objects. |
ListStreamsResult |
listStreams(ListStreamsRequest request)
Returns an array of
StreamInfo objects. |
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns a list of tags associated with the specified signaling channel.
|
ListTagsForStreamResult |
listTagsForStream(ListTagsForStreamRequest request)
Returns a list of tags associated with the specified stream.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartEdgeConfigurationUpdateResult |
startEdgeConfigurationUpdate(StartEdgeConfigurationUpdateRequest request)
An asynchronous API that updates a stream’s existing edge configuration.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds one or more tags to a signaling channel.
|
TagStreamResult |
tagStream(TagStreamRequest request)
Adds one or more tags to a stream.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from a signaling channel.
|
UntagStreamResult |
untagStream(UntagStreamRequest request)
Removes one or more tags from a stream.
|
UpdateDataRetentionResult |
updateDataRetention(UpdateDataRetentionRequest request)
Increases or decreases the stream's data retention period by the value that you specify.
|
UpdateImageGenerationConfigurationResult |
updateImageGenerationConfiguration(UpdateImageGenerationConfigurationRequest request)
Updates the
StreamInfo and ImageProcessingConfiguration fields. |
UpdateMediaStorageConfigurationResult |
updateMediaStorageConfiguration(UpdateMediaStorageConfigurationRequest request)
Associates a
SignalingChannel to a stream to store the media. |
UpdateNotificationConfigurationResult |
updateNotificationConfiguration(UpdateNotificationConfigurationRequest request)
Updates the notification information for a stream.
|
UpdateSignalingChannelResult |
updateSignalingChannel(UpdateSignalingChannelRequest request)
Updates the existing signaling channel.
|
UpdateStreamResult |
updateStream(UpdateStreamRequest request)
Updates stream metadata, such as the device name and media type.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AmazonKinesisVideoClientBuilder builder()
public CreateSignalingChannelResult createSignalingChannel(CreateSignalingChannelRequest request)
Creates a signaling channel.
CreateSignalingChannel is an asynchronous operation.
createSignalingChannel in interface AmazonKinesisVideocreateSignalingChannelRequest - 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 input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is
already mapped to a different Kinesis Video Stream resource, or if the provided input
StreamARN or ChannelARN is not in Active status, try one of the following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API 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.public CreateStreamResult createStream(CreateStreamRequest request)
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.
CreateStream is an asynchronous operation.
For information about how the service works, see How it Works.
You must have permissions for the KinesisVideo:CreateStream action.
createStream in interface AmazonKinesisVideocreateStreamRequest - AccountStreamLimitExceededException - The number of streams created for the account is too high.DeviceStreamLimitExceededException - Not implemented.ResourceInUseException - When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is
already mapped to a different Kinesis Video Stream resource, or if the provided input
StreamARN or ChannelARN is not in Active status, try one of the following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API 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.public DeleteEdgeConfigurationResult deleteEdgeConfiguration(DeleteEdgeConfigurationRequest request)
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 to
DELETE_FAILED. You will need to re-try the deletion.
When the deletion process has completed successfully, the edge configuration is no longer accessible.
deleteEdgeConfiguration in interface AmazonKinesisVideodeleteEdgeConfigurationRequest - 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.public DeleteSignalingChannelResult deleteSignalingChannel(DeleteSignalingChannelRequest request)
Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you
don't specify the channel's current version, the most recent version is deleted.
deleteSignalingChannel in interface AmazonKinesisVideodeleteSignalingChannelRequest - 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 input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is
already mapped to a different Kinesis Video Stream resource, or if the provided input
StreamARN or ChannelARN is not in Active status, try one of the following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
public DeleteStreamResult deleteStream(DeleteStreamRequest request)
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 DescribeStream API.
This operation requires permission for the KinesisVideo:DeleteStream action.
deleteStream in interface AmazonKinesisVideodeleteStreamRequest - 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 input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is
already mapped to a different Kinesis Video Stream resource, or if the provided input
StreamARN or ChannelARN is not in Active status, try one of the following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
public DescribeEdgeConfigurationResult describeEdgeConfiguration(DescribeEdgeConfigurationRequest request)
Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API 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.
describeEdgeConfiguration in interface AmazonKinesisVideodescribeEdgeConfigurationRequest - 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.public DescribeImageGenerationConfigurationResult describeImageGenerationConfiguration(DescribeImageGenerationConfigurationRequest request)
Gets the ImageGenerationConfiguration for a given Kinesis video stream.
describeImageGenerationConfiguration in interface AmazonKinesisVideodescribeImageGenerationConfigurationRequest - 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.public DescribeMappedResourceConfigurationResult describeMappedResourceConfiguration(DescribeMappedResourceConfigurationRequest request)
Returns the most current information about the stream. The streamName or streamARN
should be provided in the input.
describeMappedResourceConfiguration in interface AmazonKinesisVideodescribeMappedResourceConfigurationRequest - 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.public DescribeMediaStorageConfigurationResult describeMediaStorageConfiguration(DescribeMediaStorageConfigurationRequest request)
Returns the most current information about the channel. Specify the ChannelName or
ChannelARN in the input.
describeMediaStorageConfiguration in interface AmazonKinesisVideodescribeMediaStorageConfigurationRequest - 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.public DescribeNotificationConfigurationResult describeNotificationConfiguration(DescribeNotificationConfigurationRequest request)
Gets the NotificationConfiguration for a given Kinesis video stream.
describeNotificationConfiguration in interface AmazonKinesisVideodescribeNotificationConfigurationRequest - 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.public DescribeSignalingChannelResult describeSignalingChannel(DescribeSignalingChannelRequest request)
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.
describeSignalingChannel in interface AmazonKinesisVideodescribeSignalingChannelRequest - 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.public DescribeStreamResult describeStream(DescribeStreamRequest request)
Returns the most current information about the specified stream. You must specify either the
StreamName or the StreamARN.
describeStream in interface AmazonKinesisVideodescribeStreamRequest - 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.public GetDataEndpointResult getDataEndpoint(GetDataEndpointRequest request)
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 GetMedia or GetMediaForFragmentList
operations) or write to it (using the PutMedia operation).
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 StreamName or StreamARN.
getDataEndpoint in interface AmazonKinesisVideogetDataEndpointRequest - 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.public GetSignalingChannelEndpointResult getSignalingChannelEndpoint(GetSignalingChannelEndpointRequest request)
Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the
SingleMasterChannelEndpointConfiguration input parameter, which consists of the
Protocols and Role properties.
Protocols is used to determine the communication mechanism. For example, if you specify
WSS as the protocol, this API produces a secure websocket endpoint. If you specify
HTTPS as the protocol, this API generates an HTTPS endpoint.
Role determines the messaging permissions. A MASTER role results in this API generating
an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER
role results in this API generating an endpoint that a client can use to communicate only with a
MASTER.
getSignalingChannelEndpoint in interface AmazonKinesisVideogetSignalingChannelEndpointRequest - 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 input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is
already mapped to a different Kinesis Video Stream resource, or if the provided input
StreamARN or ChannelARN is not in Active status, try one of the following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
AccessDeniedException - You do not have required permissions to perform this operation.public ListEdgeAgentConfigurationsResult listEdgeAgentConfigurations(ListEdgeAgentConfigurationsRequest request)
Returns an array of edge configurations associated with the specified Edge Agent.
In the request, you must specify the Edge Agent HubDeviceArn.
listEdgeAgentConfigurations in interface AmazonKinesisVideolistEdgeAgentConfigurationsRequest - 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.public ListSignalingChannelsResult listSignalingChannels(ListSignalingChannelsRequest request)
Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only
those channels that satisfy a specific condition, you can specify a ChannelNameCondition.
listSignalingChannels in interface AmazonKinesisVideolistSignalingChannelsRequest - 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.public ListStreamsResult listStreams(ListStreamsRequest request)
Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams
that satisfy a specific condition, you can specify a StreamNameCondition.
listStreams in interface AmazonKinesisVideolistStreamsRequest - 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns a list of tags associated with the specified signaling channel.
listTagsForResource in interface AmazonKinesisVideolistTagsForResourceRequest - 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.public ListTagsForStreamResult listTagsForStream(ListTagsForStreamRequest request)
Returns a list of tags associated with the specified stream.
In the request, you must specify either the StreamName or the StreamARN.
listTagsForStream in interface AmazonKinesisVideolistTagsForStreamRequest - 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 the StreamARN is invalid.public StartEdgeConfigurationUpdateResult startEdgeConfigurationUpdate(StartEdgeConfigurationUpdateRequest request)
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
SyncStatus will 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, or SYNC_FAILED, before using this API again. If you invoke this API
during the syncing process, a ResourceInUseException will 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 the SYNC_FAILED state.
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.
startEdgeConfigurationUpdate in interface AmazonKinesisVideostartEdgeConfigurationUpdateRequest - 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 input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is
already mapped to a different Kinesis Video Stream resource, or if the provided input
StreamARN or ChannelARN is not in Active status, try one of the following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
ResourceNotFoundException - Amazon Kinesis Video Streams can't find the stream that you specified.public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource in interface AmazonKinesisVideotagResourceRequest - 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.public TagStreamResult tagStream(TagStreamRequest request)
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 StreamName or the StreamARN.
This operation requires permission for the KinesisVideo:TagStream action.
A Kinesis video stream can support up to 50 tags.
tagStream in interface AmazonKinesisVideotagStreamRequest - 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 the StreamARN is 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.public UntagResourceResult untagResource(UntagResourceRequest request)
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.
untagResource in interface AmazonKinesisVideountagResourceRequest - 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.public UntagStreamResult untagStream(UntagStreamRequest request)
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 StreamName or StreamARN.
untagStream in interface AmazonKinesisVideountagStreamRequest - 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 the StreamARN is invalid.public UpdateDataRetentionResult updateDataRetention(UpdateDataRetentionRequest request)
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 Operation parameter in the
request body. In the request, you must specify either the StreamName or the StreamARN.
This operation requires permission for the KinesisVideo:UpdateDataRetention action.
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.
updateDataRetention in interface AmazonKinesisVideoupdateDataRetentionRequest - 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 input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is
already mapped to a different Kinesis Video Stream resource, or if the provided input
StreamARN or ChannelARN is not in Active status, try one of the following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API 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.public UpdateImageGenerationConfigurationResult updateImageGenerationConfiguration(UpdateImageGenerationConfigurationRequest request)
Updates the StreamInfo and ImageProcessingConfiguration fields.
updateImageGenerationConfiguration in interface AmazonKinesisVideoupdateImageGenerationConfigurationRequest - 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 input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is
already mapped to a different Kinesis Video Stream resource, or if the provided input
StreamARN or ChannelARN is not in Active status, try one of the following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
NoDataRetentionException - The Stream data retention in hours is equal to zero.public UpdateMediaStorageConfigurationResult updateMediaStorageConfiguration(UpdateMediaStorageConfigurationRequest request)
Associates a SignalingChannel to a stream to store the media. There are two signaling modes that you
can specify :
If StorageStatus is enabled, the data will be stored in the StreamARN provided. In
order for WebRTC Ingestion to work, the stream must have data retention enabled.
If StorageStatus is disabled, no data will be stored, and the StreamARN parameter will
not be needed.
If StorageStatus is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers
connect directly to the storage session. You must call the JoinStorageSession API to trigger an SDP
offer send and establish a connection between a peer and the storage session.
updateMediaStorageConfiguration in interface AmazonKinesisVideoupdateMediaStorageConfigurationRequest - ResourceInUseException - When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is
already mapped to a different Kinesis Video Stream resource, or if the provided input
StreamARN or ChannelARN is not in Active status, try one of the following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API 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.public UpdateNotificationConfigurationResult updateNotificationConfiguration(UpdateNotificationConfigurationRequest request)
Updates the notification information for a stream.
updateNotificationConfiguration in interface AmazonKinesisVideoupdateNotificationConfigurationRequest - 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 input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is
already mapped to a different Kinesis Video Stream resource, or if the provided input
StreamARN or ChannelARN is not in Active status, try one of the following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API to determine the status of
the resource.
NoDataRetentionException - The Stream data retention in hours is equal to zero.public UpdateSignalingChannelResult updateSignalingChannel(UpdateSignalingChannelRequest request)
Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.
If the MessageTtlSeconds value 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 previous
MessageTtlSeconds value.
updateSignalingChannel in interface AmazonKinesisVideoupdateSignalingChannelRequest - 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 input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is
already mapped to a different Kinesis Video Stream resource, or if the provided input
StreamARN or ChannelARN is not in Active status, try one of the following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API 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.public UpdateStreamResult updateStream(UpdateStreamRequest request)
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 DescribeStream API.
UpdateStream is an asynchronous operation, and takes time to complete.
updateStream in interface AmazonKinesisVideoupdateStreamRequest - 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 input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is
already mapped to a different Kinesis Video Stream resource, or if the provided input
StreamARN or ChannelARN is not in Active status, try one of the following :
The DescribeMediaStorageConfiguration API to determine what the stream given channel is
mapped to.
The DescribeMappedResourceConfiguration API to determine the channel that the given stream
is mapped to.
The DescribeStream or DescribeSignalingChannel API 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonKinesisVideorequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AmazonKinesisVideoshutdown in class AmazonWebServiceClient