@Generated(value="software.amazon.awssdk:codegen") public interface KinesisVideoClient extends SdkClient, SdkAutoCloseable
builder()
method.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static KinesisVideoClientBuilder |
builder()
Create a builder that can be used to configure and create a
KinesisVideoClient . |
static KinesisVideoClient |
create()
Create a
KinesisVideoClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider . |
default CreateStreamResponse |
createStream(Consumer<CreateStreamRequest.Builder> createStreamRequest)
Creates a new Kinesis video stream.
|
default CreateStreamResponse |
createStream(CreateStreamRequest createStreamRequest)
Creates a new Kinesis video stream.
|
default DeleteStreamResponse |
deleteStream(Consumer<DeleteStreamRequest.Builder> deleteStreamRequest)
Deletes a Kinesis video stream and the data contained in the stream.
|
default DeleteStreamResponse |
deleteStream(DeleteStreamRequest deleteStreamRequest)
Deletes a Kinesis video stream and the data contained in the stream.
|
default DescribeStreamResponse |
describeStream(Consumer<DescribeStreamRequest.Builder> describeStreamRequest)
Returns the most current information about the specified stream.
|
default DescribeStreamResponse |
describeStream(DescribeStreamRequest describeStreamRequest)
Returns the most current information about the specified stream.
|
default GetDataEndpointResponse |
getDataEndpoint(Consumer<GetDataEndpointRequest.Builder> getDataEndpointRequest)
Gets an endpoint for a specified stream for either reading or writing.
|
default GetDataEndpointResponse |
getDataEndpoint(GetDataEndpointRequest getDataEndpointRequest)
Gets an endpoint for a specified stream for either reading or writing.
|
default ListStreamsResponse |
listStreams()
Returns an array of
StreamInfo objects. |
default ListStreamsResponse |
listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
Returns an array of
StreamInfo objects. |
default ListStreamsResponse |
listStreams(ListStreamsRequest listStreamsRequest)
Returns an array of
StreamInfo objects. |
default ListTagsForStreamResponse |
listTagsForStream(Consumer<ListTagsForStreamRequest.Builder> listTagsForStreamRequest)
Returns a list of tags associated with the specified stream.
|
default ListTagsForStreamResponse |
listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest)
Returns a list of tags associated with the specified stream.
|
static ServiceMetadata |
serviceMetadata() |
default TagStreamResponse |
tagStream(Consumer<TagStreamRequest.Builder> tagStreamRequest)
Adds one or more tags to a stream.
|
default TagStreamResponse |
tagStream(TagStreamRequest tagStreamRequest)
Adds one or more tags to a stream.
|
default UntagStreamResponse |
untagStream(Consumer<UntagStreamRequest.Builder> untagStreamRequest)
Removes one or more tags from a stream.
|
default UntagStreamResponse |
untagStream(UntagStreamRequest untagStreamRequest)
Removes one or more tags from a stream.
|
default UpdateDataRetentionResponse |
updateDataRetention(Consumer<UpdateDataRetentionRequest.Builder> updateDataRetentionRequest)
Increases or decreases the stream's data retention period by the value that you specify.
|
default UpdateDataRetentionResponse |
updateDataRetention(UpdateDataRetentionRequest updateDataRetentionRequest)
Increases or decreases the stream's data retention period by the value that you specify.
|
default UpdateStreamResponse |
updateStream(Consumer<UpdateStreamRequest.Builder> updateStreamRequest)
Updates stream metadata, such as the device name and media type.
|
default UpdateStreamResponse |
updateStream(UpdateStreamRequest updateStreamRequest)
Updates stream metadata, such as the device name and media type.
|
serviceName
close
static final String SERVICE_NAME
static KinesisVideoClient create()
KinesisVideoClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static KinesisVideoClientBuilder builder()
KinesisVideoClient
.default CreateStreamResponse createStream(CreateStreamRequest createStreamRequest) throws AccountStreamLimitExceededException, DeviceStreamLimitExceededException, ResourceInUseException, InvalidDeviceException, InvalidArgumentException, ClientLimitExceededException, SdkServiceException, 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.
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.
createStreamRequest
- AccountStreamLimitExceededException
- The number of streams created for the account is too high.DeviceStreamLimitExceededException
- Not implemented.ResourceInUseException
- The stream is currently not available for this operation.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.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.SdkServiceException
default CreateStreamResponse createStream(Consumer<CreateStreamRequest.Builder> createStreamRequest) throws AccountStreamLimitExceededException, DeviceStreamLimitExceededException, ResourceInUseException, InvalidDeviceException, InvalidArgumentException, ClientLimitExceededException, SdkServiceException, 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.
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.
createStreamRequest
- AccountStreamLimitExceededException
- The number of streams created for the account is too high.DeviceStreamLimitExceededException
- Not implemented.ResourceInUseException
- The stream is currently not available for this operation.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.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.SdkServiceException
default DeleteStreamResponse deleteStream(DeleteStreamRequest deleteStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, SdkServiceException, 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 DescribeStream
API.
This operation requires permission for the KinesisVideo:DeleteStream
action.
deleteStreamRequest
- 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.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.SdkServiceException
default DeleteStreamResponse deleteStream(Consumer<DeleteStreamRequest.Builder> deleteStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, SdkServiceException, 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 DescribeStream
API.
This operation requires permission for the KinesisVideo:DeleteStream
action.
deleteStreamRequest
- 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.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.SdkServiceException
default DescribeStreamResponse describeStream(DescribeStreamRequest describeStreamRequest) throws InvalidArgumentException, ResourceNotFoundException, ClientLimitExceededException, NotAuthorizedException, SdkServiceException, SdkClientException, KinesisVideoException
Returns the most current information about the specified stream. You must specify either the
StreamName
or the StreamARN
.
describeStreamRequest
- 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.SdkServiceException
default DescribeStreamResponse describeStream(Consumer<DescribeStreamRequest.Builder> describeStreamRequest) throws InvalidArgumentException, ResourceNotFoundException, ClientLimitExceededException, NotAuthorizedException, SdkServiceException, SdkClientException, KinesisVideoException
Returns the most current information about the specified stream. You must specify either the
StreamName
or the StreamARN
.
describeStreamRequest
- 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.SdkServiceException
default GetDataEndpointResponse getDataEndpoint(GetDataEndpointRequest getDataEndpointRequest) throws InvalidArgumentException, ResourceNotFoundException, ClientLimitExceededException, NotAuthorizedException, SdkServiceException, 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 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
.
getDataEndpointRequest
- 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.SdkServiceException
default GetDataEndpointResponse getDataEndpoint(Consumer<GetDataEndpointRequest.Builder> getDataEndpointRequest) throws InvalidArgumentException, ResourceNotFoundException, ClientLimitExceededException, NotAuthorizedException, SdkServiceException, 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 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
.
getDataEndpointRequest
- 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.SdkServiceException
default ListStreamsResponse listStreams() throws ClientLimitExceededException, InvalidArgumentException, SdkServiceException, SdkClientException, KinesisVideoException
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
.
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.SdkServiceException
listStreams(ListStreamsRequest)
,
AWS API
Documentationdefault ListStreamsResponse listStreams(ListStreamsRequest listStreamsRequest) throws ClientLimitExceededException, InvalidArgumentException, SdkServiceException, SdkClientException, KinesisVideoException
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
.
listStreamsRequest
- 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.SdkServiceException
default ListStreamsResponse listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest) throws ClientLimitExceededException, InvalidArgumentException, SdkServiceException, SdkClientException, KinesisVideoException
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
.
listStreamsRequest
- 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.SdkServiceException
default ListTagsForStreamResponse listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, InvalidResourceFormatException, SdkServiceException, SdkClientException, KinesisVideoException
Returns a list of tags associated with the specified stream.
In the request, you must specify either the StreamName
or the StreamARN
.
listTagsForStreamRequest
- 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.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.SdkServiceException
default ListTagsForStreamResponse listTagsForStream(Consumer<ListTagsForStreamRequest.Builder> listTagsForStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, InvalidResourceFormatException, SdkServiceException, SdkClientException, KinesisVideoException
Returns a list of tags associated with the specified stream.
In the request, you must specify either the StreamName
or the StreamARN
.
listTagsForStreamRequest
- 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.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.SdkServiceException
default TagStreamResponse tagStream(TagStreamRequest tagStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, InvalidResourceFormatException, TagsPerResourceExceededLimitException, SdkServiceException, 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 AWS 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 AWS Billing and Cost Management User Guide.
You must provide either the StreamName
or the StreamARN
.
This operation requires permission for the KinesisVideo:TagStream
action.
Kinesis video streams support up to 50 tags.
tagStreamRequest
- 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. Kinesis video streams
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.SdkServiceException
default TagStreamResponse tagStream(Consumer<TagStreamRequest.Builder> tagStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, InvalidResourceFormatException, TagsPerResourceExceededLimitException, SdkServiceException, 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 AWS 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 AWS Billing and Cost Management User Guide.
You must provide either the StreamName
or the StreamARN
.
This operation requires permission for the KinesisVideo:TagStream
action.
Kinesis video streams support up to 50 tags.
tagStreamRequest
- 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. Kinesis video streams
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.SdkServiceException
default UntagStreamResponse untagStream(UntagStreamRequest untagStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, InvalidResourceFormatException, SdkServiceException, 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 StreamName
or StreamARN
.
untagStreamRequest
- 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.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.SdkServiceException
default UntagStreamResponse untagStream(Consumer<UntagStreamRequest.Builder> untagStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, NotAuthorizedException, InvalidResourceFormatException, SdkServiceException, 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 StreamName
or StreamARN
.
untagStreamRequest
- 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.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.SdkServiceException
default UpdateDataRetentionResponse updateDataRetention(UpdateDataRetentionRequest updateDataRetentionRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, ResourceInUseException, NotAuthorizedException, VersionMismatchException, SdkServiceException, 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 Operation
parameter in the
request body. In the request, you must specify either the StreamName
or the StreamARN
.
The retention period that you specify replaces the current value.
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.
updateDataRetentionRequest
- 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
- The stream is currently not available for this operation.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.SdkServiceException
default UpdateDataRetentionResponse updateDataRetention(Consumer<UpdateDataRetentionRequest.Builder> updateDataRetentionRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, ResourceInUseException, NotAuthorizedException, VersionMismatchException, SdkServiceException, 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 Operation
parameter in the
request body. In the request, you must specify either the StreamName
or the StreamARN
.
The retention period that you specify replaces the current value.
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.
updateDataRetentionRequest
- 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
- The stream is currently not available for this operation.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.SdkServiceException
default UpdateStreamResponse updateStream(UpdateStreamRequest updateStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, ResourceInUseException, NotAuthorizedException, VersionMismatchException, SdkServiceException, 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 DescribeStream
API.
UpdateStream
is an asynchronous operation, and takes time to complete.
updateStreamRequest
- 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
- The stream is currently not available for this operation.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.SdkServiceException
default UpdateStreamResponse updateStream(Consumer<UpdateStreamRequest.Builder> updateStreamRequest) throws ClientLimitExceededException, InvalidArgumentException, ResourceNotFoundException, ResourceInUseException, NotAuthorizedException, VersionMismatchException, SdkServiceException, 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 DescribeStream
API.
UpdateStream
is an asynchronous operation, and takes time to complete.
updateStreamRequest
- 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
- The stream is currently not available for this operation.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.SdkServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.