com.amazonaws.services.kinesisvideo

Interface AmazonKinesisVideo

All Known Subinterfaces:

AmazonKinesisVideoAsync

All Known Implementing Classes:

AbstractAmazonKinesisVideo, AbstractAmazonKinesisVideoAsync, AmazonKinesisVideoAsyncClient, AmazonKinesisVideoClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonKinesisVideo

Interface for accessing Kinesis Video.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonKinesisVideo instead.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateStreamResult	createStream(CreateStreamRequest createStreamRequest) Creates a new Kinesis video stream.
DeleteStreamResult	deleteStream(DeleteStreamRequest deleteStreamRequest) Deletes a Kinesis video stream and the data contained in the stream.
DescribeStreamResult	describeStream(DescribeStreamRequest describeStreamRequest) 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 getDataEndpointRequest) Gets an endpoint for a specified stream for either reading or writing.
ListStreamsResult	listStreams(ListStreamsRequest listStreamsRequest) Returns an array of StreamInfo objects.
ListTagsForStreamResult	listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest) 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.
TagStreamResult	tagStream(TagStreamRequest tagStreamRequest) Adds one or more tags to a stream.
UntagStreamResult	untagStream(UntagStreamRequest untagStreamRequest) Removes one or more tags from a stream.
UpdateDataRetentionResult	updateDataRetention(UpdateDataRetentionRequest updateDataRetentionRequest) Increases or decreases the stream's data retention period by the value that you specify.
UpdateStreamResult	updateStream(UpdateStreamRequest updateStreamRequest) Updates stream metadata, such as the device name and media type.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createStream

CreateStreamResult createStream(CreateStreamRequest createStreamRequest)

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.

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 - 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.

See Also:

AWS API Documentation

deleteStream

DeleteStreamResult deleteStream(DeleteStreamRequest deleteStreamRequest)

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.

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.

See Also:

AWS API Documentation

describeStream

DescribeStreamResult describeStream(DescribeStreamRequest describeStreamRequest)

Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.

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.

See Also:

AWS API Documentation

getDataEndpoint

GetDataEndpointResult getDataEndpoint(GetDataEndpointRequest getDataEndpointRequest)

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.

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.

See Also:

AWS API Documentation

listStreams

ListStreamsResult listStreams(ListStreamsRequest listStreamsRequest)

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.

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.

See Also:

AWS API Documentation

listTagsForStream

ListTagsForStreamResult listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest)

Returns a list of tags associated with the specified stream.

In the request, you must specify either the StreamName or the StreamARN.

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 the StreamARN is invalid.

See Also:

AWS API Documentation

tagStream

TagStreamResult tagStream(TagStreamRequest tagStreamRequest)

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.

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 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.

See Also:

AWS API Documentation

untagStream

UntagStreamResult untagStream(UntagStreamRequest untagStreamRequest)

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.

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 the StreamARN is invalid.

See Also:

AWS API Documentation

updateDataRetention

UpdateDataRetentionResult updateDataRetention(UpdateDataRetentionRequest updateDataRetentionRequest)

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.

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 - 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.

See Also:

AWS API Documentation

updateStream

UpdateStreamResult updateStream(UpdateStreamRequest updateStreamRequest)

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.

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 - 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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.