com.amazonaws.services.kinesisvideo

Class AWSKinesisVideoClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.kinesisvideo.AWSKinesisVideoClient

All Implemented Interfaces:

AWSKinesisVideo

public class AWSKinesisVideoClient
extends AmazonWebServiceClient
implements AWSKinesisVideo

Client for accessing AWSKinesisVideoFrontend. All service calls made using this client are blocking, and will not return until the service call completes.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Constructor Summary

Constructors

Constructor and Description
AWSKinesisVideoClient() Deprecated.
AWSKinesisVideoClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWSKinesisVideo using the specified AWS account credentials.
AWSKinesisVideoClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSKinesisVideo using the specified AWS account credentials and client configuration options.
AWSKinesisVideoClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWSKinesisVideo using the specified AWS account credentials provider.
AWSKinesisVideoClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSKinesisVideo using the specified AWS account credentials provider and client configuration options.
AWSKinesisVideoClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient) Constructs a new client to invoke service methods on AWSKinesisVideo using the specified AWS account credentials provider, client configuration options and request metric collector.
AWSKinesisVideoClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector) Deprecated.
AWSKinesisVideoClient(ClientConfiguration clientConfiguration) Deprecated.

Method Summary

Modifier and Type	Method and Description
CreateSignalingChannelResult	createSignalingChannel(CreateSignalingChannelRequest createSignalingChannelRequest) Creates a signaling channel.
CreateStreamResult	createStream(CreateStreamRequest createStreamRequest) Creates a new Kinesis video stream.
DeleteSignalingChannelResult	deleteSignalingChannel(DeleteSignalingChannelRequest deleteSignalingChannelRequest) Deletes a specified signaling channel.
DeleteStreamResult	deleteStream(DeleteStreamRequest deleteStreamRequest) Deletes a Kinesis video stream and the data contained in the stream.
DescribeSignalingChannelResult	describeSignalingChannel(DescribeSignalingChannelRequest describeSignalingChannelRequest) Returns the most current information about the signaling channel.
DescribeStreamResult	describeStream(DescribeStreamRequest describeStreamRequest) Returns the most current information about the specified stream.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
GetDataEndpointResult	getDataEndpoint(GetDataEndpointRequest getDataEndpointRequest) Gets an endpoint for a specified stream for either reading or writing.
GetSignalingChannelEndpointResult	getSignalingChannelEndpoint(GetSignalingChannelEndpointRequest getSignalingChannelEndpointRequest) Provides an endpoint for the specified signaling channel to send and receive messages.
ListSignalingChannelsResult	listSignalingChannels(ListSignalingChannelsRequest listSignalingChannelsRequest) Returns an array of ChannelInfo objects.
ListStreamsResult	listStreams(ListStreamsRequest listStreamsRequest) Returns an array of StreamInfo objects.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags associated with the specified signaling channel.
ListTagsForStreamResult	listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest) Returns a list of tags associated with the specified stream.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds one or more tags to a signaling channel.
TagStreamResult	tagStream(TagStreamRequest tagStreamRequest) Adds one or more tags to a stream.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from a signaling channel.
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.
UpdateSignalingChannelResult	updateSignalingChannel(UpdateSignalingChannelRequest updateSignalingChannelRequest) Updates the existing signaling channel.
UpdateStreamResult	updateStream(UpdateStreamRequest updateStreamRequest) Updates stream metadata, such as the device name and media type.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.kinesisvideo.AWSKinesisVideo

setEndpoint, setRegion, shutdown

Constructor Detail

AWSKinesisVideoClient

@Deprecated
public AWSKinesisVideoClient()

Deprecated.

Constructs a new client to invoke service methods on AWSKinesisVideo. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSKinesisVideoClient

@Deprecated
public AWSKinesisVideoClient(ClientConfiguration clientConfiguration)

Deprecated.

Constructs a new client to invoke service methods on AWSKinesisVideo. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWSKinesisVideo (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSKinesisVideoClient

public AWSKinesisVideoClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AWSKinesisVideo using the specified AWS account credentials.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSKinesisVideoClient client = new AWSKinesisVideoClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSKinesisVideoClient

public AWSKinesisVideoClient(AWSCredentials awsCredentials,
                             ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSKinesisVideo using the specified AWS account credentials and client configuration options.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSKinesisVideoClient client = new AWSKinesisVideoClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSKinesisVideo (ex: proxy settings, retry counts, etc.).

AWSKinesisVideoClient

public AWSKinesisVideoClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AWSKinesisVideo using the specified AWS account credentials provider.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSKinesisVideoClient client = new AWSKinesisVideoClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSKinesisVideoClient

public AWSKinesisVideoClient(AWSCredentialsProvider awsCredentialsProvider,
                             ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSKinesisVideo using the specified AWS account credentials provider and client configuration options.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSKinesisVideoClient client = new AWSKinesisVideoClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSKinesisVideo (ex: proxy settings, retry counts, etc.).

AWSKinesisVideoClient

@Deprecated
public AWSKinesisVideoClient(AWSCredentialsProvider awsCredentialsProvider,
                                         ClientConfiguration clientConfiguration,
                                         com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)

Deprecated.

Constructs a new client to invoke service methods on AWSKinesisVideo using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSKinesisVideo (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

AWSKinesisVideoClient

public AWSKinesisVideoClient(AWSCredentialsProvider awsCredentialsProvider,
                             ClientConfiguration clientConfiguration,
                             HttpClient httpClient)

Constructs a new client to invoke service methods on AWSKinesisVideo using the specified AWS account credentials provider, client configuration options and request metric collector.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AWSKinesisVideoClient client = new AWSKinesisVideoClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSKinesisVideo (ex: proxy settings, retry counts, etc.).

httpClient - A http client

Method Detail

createSignalingChannel

public CreateSignalingChannelResult createSignalingChannel(CreateSignalingChannelRequest createSignalingChannelRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Creates a signaling channel.

CreateSignalingChannel is an asynchronous operation.

Specified by:

createSignalingChannel in interface AWSKinesisVideo

Parameters:

createSignalingChannelRequest -

Returns:

createSignalingChannelResult The response from the CreateSignalingChannel service method, as returned by AWSKinesisVideoFrontend.

Throws:

InvalidArgumentException

ClientLimitExceededException

AccountChannelLimitExceededException

ResourceInUseException

AccessDeniedException

TagsPerResourceExceededLimitException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

createStream

public CreateStreamResult createStream(CreateStreamRequest createStreamRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

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.

Specified by:

createStream in interface AWSKinesisVideo

Parameters:

createStreamRequest -

Returns:

createStreamResult The response from the CreateStream service method, as returned by AWSKinesisVideoFrontend.

Throws:

AccountStreamLimitExceededException

DeviceStreamLimitExceededException

ResourceInUseException

InvalidDeviceException

InvalidArgumentException

ClientLimitExceededException

TagsPerResourceExceededLimitException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

deleteSignalingChannel

public DeleteSignalingChannelResult deleteSignalingChannel(DeleteSignalingChannelRequest deleteSignalingChannelRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

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.

Specified by:

deleteSignalingChannel in interface AWSKinesisVideo

Parameters:

deleteSignalingChannelRequest -

Returns:

deleteSignalingChannelResult The response from the DeleteSignalingChannel service method, as returned by AWSKinesisVideoFrontend.

Throws:

InvalidArgumentException

ClientLimitExceededException

ResourceNotFoundException

AccessDeniedException

VersionMismatchException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

deleteStream

public DeleteStreamResult deleteStream(DeleteStreamRequest deleteStreamRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

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.

Specified by:

deleteStream in interface AWSKinesisVideo

Parameters:

deleteStreamRequest -

Returns:

deleteStreamResult The response from the DeleteStream service method, as returned by AWSKinesisVideoFrontend.

Throws:

ClientLimitExceededException

InvalidArgumentException

ResourceNotFoundException

NotAuthorizedException

VersionMismatchException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

describeSignalingChannel

public DescribeSignalingChannelResult describeSignalingChannel(DescribeSignalingChannelRequest describeSignalingChannelRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Returns the most current information about the signaling channel. You must specify either the name or the ARN of the channel that you want to describe.

Specified by:

describeSignalingChannel in interface AWSKinesisVideo

Parameters:

describeSignalingChannelRequest -

Returns:

describeSignalingChannelResult The response from the DescribeSignalingChannel service method, as returned by AWSKinesisVideoFrontend.

Throws:

InvalidArgumentException

ClientLimitExceededException

ResourceNotFoundException

AccessDeniedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

describeStream

public DescribeStreamResult describeStream(DescribeStreamRequest describeStreamRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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

Specified by:

describeStream in interface AWSKinesisVideo

Parameters:

describeStreamRequest -

Returns:

describeStreamResult The response from the DescribeStream service method, as returned by AWSKinesisVideoFrontend.

Throws:

InvalidArgumentException

ResourceNotFoundException

ClientLimitExceededException

NotAuthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

getDataEndpoint

public GetDataEndpointResult getDataEndpoint(GetDataEndpointRequest getDataEndpointRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

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.

Specified by:

getDataEndpoint in interface AWSKinesisVideo

Parameters:

getDataEndpointRequest -

Returns:

getDataEndpointResult The response from the GetDataEndpoint service method, as returned by AWSKinesisVideoFrontend.

Throws:

InvalidArgumentException

ResourceNotFoundException

ClientLimitExceededException

NotAuthorizedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

getSignalingChannelEndpoint

public GetSignalingChannelEndpointResult getSignalingChannelEndpoint(GetSignalingChannelEndpointRequest getSignalingChannelEndpointRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

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, specifying WSS as the protocol, results in this API producing a secure websocket endpoint, and specifying HTTPS as the protocol, results in this API generating 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.

Specified by:

getSignalingChannelEndpoint in interface AWSKinesisVideo

Parameters:

getSignalingChannelEndpointRequest -

Returns:

getSignalingChannelEndpointResult The response from the GetSignalingChannelEndpoint service method, as returned by AWSKinesisVideoFrontend.

Throws:

InvalidArgumentException

ClientLimitExceededException

ResourceNotFoundException

ResourceInUseException

AccessDeniedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

listSignalingChannels

public ListSignalingChannelsResult listSignalingChannels(ListSignalingChannelsRequest listSignalingChannelsRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

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.

Specified by:

listSignalingChannels in interface AWSKinesisVideo

Parameters:

listSignalingChannelsRequest -

Returns:

listSignalingChannelsResult The response from the ListSignalingChannels service method, as returned by AWSKinesisVideoFrontend.

Throws:

InvalidArgumentException

ClientLimitExceededException

AccessDeniedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

listStreams

public ListStreamsResult listStreams(ListStreamsRequest listStreamsRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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.

Specified by:

listStreams in interface AWSKinesisVideo

Parameters:

listStreamsRequest -

Returns:

listStreamsResult The response from the ListStreams service method, as returned by AWSKinesisVideoFrontend.

Throws:

ClientLimitExceededException

InvalidArgumentException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Returns a list of tags associated with the specified signaling channel.

Specified by:

listTagsForResource in interface AWSKinesisVideo

Parameters:

listTagsForResourceRequest -

Returns:

listTagsForResourceResult The response from the ListTagsForResource service method, as returned by AWSKinesisVideoFrontend.

Throws:

InvalidArgumentException

ClientLimitExceededException

ResourceNotFoundException

AccessDeniedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

listTagsForStream

public ListTagsForStreamResult listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Returns a list of tags associated with the specified stream.

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

Specified by:

listTagsForStream in interface AWSKinesisVideo

Parameters:

listTagsForStreamRequest -

Returns:

listTagsForStreamResult The response from the ListTagsForStream service method, as returned by AWSKinesisVideoFrontend.

Throws:

ClientLimitExceededException

InvalidArgumentException

ResourceNotFoundException

NotAuthorizedException

InvalidResourceFormatException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

tagResource

public TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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

Specified by:

tagResource in interface AWSKinesisVideo

Parameters:

tagResourceRequest -

Returns:

tagResourceResult The response from the TagResource service method, as returned by AWSKinesisVideoFrontend.

Throws:

InvalidArgumentException

ClientLimitExceededException

ResourceNotFoundException

AccessDeniedException

TagsPerResourceExceededLimitException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

tagStream

public TagStreamResult tagStream(TagStreamRequest tagStreamRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

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.

Specified by:

tagStream in interface AWSKinesisVideo

Parameters:

tagStreamRequest -

Returns:

tagStreamResult The response from the TagStream service method, as returned by AWSKinesisVideoFrontend.

Throws:

ClientLimitExceededException

InvalidArgumentException

ResourceNotFoundException

NotAuthorizedException

InvalidResourceFormatException

TagsPerResourceExceededLimitException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

untagResource

public UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

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.

Specified by:

untagResource in interface AWSKinesisVideo

Parameters:

untagResourceRequest -

Returns:

untagResourceResult The response from the UntagResource service method, as returned by AWSKinesisVideoFrontend.

Throws:

InvalidArgumentException

ClientLimitExceededException

ResourceNotFoundException

AccessDeniedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

untagStream

public UntagStreamResult untagStream(UntagStreamRequest untagStreamRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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.

Specified by:

untagStream in interface AWSKinesisVideo

Parameters:

untagStreamRequest -

Returns:

untagStreamResult The response from the UntagStream service method, as returned by AWSKinesisVideoFrontend.

Throws:

ClientLimitExceededException

InvalidArgumentException

ResourceNotFoundException

NotAuthorizedException

InvalidResourceFormatException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

updateDataRetention

public UpdateDataRetentionResult updateDataRetention(UpdateDataRetentionRequest updateDataRetentionRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

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.

Specified by:

updateDataRetention in interface AWSKinesisVideo

Parameters:

updateDataRetentionRequest -

Returns:

updateDataRetentionResult The response from the UpdateDataRetention service method, as returned by AWSKinesisVideoFrontend.

Throws:

ClientLimitExceededException

InvalidArgumentException

ResourceNotFoundException

ResourceInUseException

NotAuthorizedException

VersionMismatchException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

updateSignalingChannel

public UpdateSignalingChannelResult updateSignalingChannel(UpdateSignalingChannelRequest updateSignalingChannelRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

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), then it only applies to new messages sent via this channel after it's been updated. Existing messages are still expire as per the previous MessageTtlSeconds value.

Specified by:

updateSignalingChannel in interface AWSKinesisVideo

Parameters:

updateSignalingChannelRequest -

Returns:

updateSignalingChannelResult The response from the UpdateSignalingChannel service method, as returned by AWSKinesisVideoFrontend.

Throws:

InvalidArgumentException

ClientLimitExceededException

ResourceNotFoundException

ResourceInUseException

AccessDeniedException

VersionMismatchException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

updateStream

public UpdateStreamResult updateStream(UpdateStreamRequest updateStreamRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

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.

Specified by:

updateStream in interface AWSKinesisVideo

Parameters:

updateStreamRequest -

Returns:

updateStreamResult The response from the UpdateStream service method, as returned by AWSKinesisVideoFrontend.

Throws:

ClientLimitExceededException

InvalidArgumentException

ResourceNotFoundException

ResourceInUseException

NotAuthorizedException

VersionMismatchException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSKinesisVideoFrontend indicating either a problem with the data in the request, or a server side issue.

getCachedResponseMetadata

@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.

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

Specified by:

getCachedResponseMetadata in interface AWSKinesisVideo

Parameters:

request - The originally executed request

Returns:

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