public interface AWSKinesisVideo
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)
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.
|
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.
|
void |
setEndpoint(java.lang.String endpoint)
Overrides the default endpoint for this client
("https://https://kinesisvideo.us-west-2.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String) , sets the
regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
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.
|
void setEndpoint(java.lang.String endpoint) throws java.lang.IllegalArgumentException
Callers can pass in just the endpoint (ex:
"https://kinesisvideo.us-west-2.amazonaws.com") or a full URL, including
the protocol (ex:
"https://https://kinesisvideo.us-west-2.amazonaws.com"). If the protocol
is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint
- The endpoint (ex:
"https://kinesisvideo.us-west-2.amazonaws.com") or a full URL,
including the protocol (ex:
"https://https://kinesisvideo.us-west-2.amazonaws.com") of the
region specific AWS endpoint this client will communicate
with.java.lang.IllegalArgumentException
- If any problems are detected with the
specified endpoint.void setRegion(Region region) throws java.lang.IllegalArgumentException
setEndpoint(String)
, sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)
for
accessing a given region.java.lang.IllegalArgumentException
- If the given region is null,
or if this service isn't available in the given region. See
Region.isServiceSupported(String)
Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
CreateSignalingChannelResult createSignalingChannel(CreateSignalingChannelRequest createSignalingChannelRequest) throws AmazonClientException, AmazonServiceException
Creates a signaling channel.
CreateSignalingChannel
is an asynchronous operation.
createSignalingChannelRequest
- 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.CreateStreamResult createStream(CreateStreamRequest createStreamRequest) throws AmazonClientException, AmazonServiceException
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
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.DeleteSignalingChannelResult deleteSignalingChannel(DeleteSignalingChannelRequest deleteSignalingChannelRequest) throws AmazonClientException, AmazonServiceException
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.
deleteSignalingChannelRequest
- 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.DeleteStreamResult deleteStream(DeleteStreamRequest deleteStreamRequest) throws AmazonClientException, AmazonServiceException
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
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.DescribeSignalingChannelResult describeSignalingChannel(DescribeSignalingChannelRequest describeSignalingChannelRequest) throws AmazonClientException, AmazonServiceException
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.
describeSignalingChannelRequest
- 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.DescribeStreamResult describeStream(DescribeStreamRequest describeStreamRequest) throws AmazonClientException, AmazonServiceException
Returns the most current information about the specified stream. You must
specify either the StreamName
or the StreamARN
.
describeStreamRequest
- 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.GetDataEndpointResult getDataEndpoint(GetDataEndpointRequest getDataEndpointRequest) throws AmazonClientException, AmazonServiceException
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
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.GetSignalingChannelEndpointResult getSignalingChannelEndpoint(GetSignalingChannelEndpointRequest getSignalingChannelEndpointRequest) throws AmazonClientException, AmazonServiceException
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
.
getSignalingChannelEndpointRequest
- 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.ListSignalingChannelsResult listSignalingChannels(ListSignalingChannelsRequest listSignalingChannelsRequest) throws AmazonClientException, AmazonServiceException
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
.
listSignalingChannelsRequest
- 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.ListStreamsResult listStreams(ListStreamsRequest listStreamsRequest) throws AmazonClientException, AmazonServiceException
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
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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AmazonClientException, AmazonServiceException
Returns a list of tags associated with the specified signaling channel.
listTagsForResourceRequest
- 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.ListTagsForStreamResult listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest) throws AmazonClientException, AmazonServiceException
Returns a list of tags associated with the specified stream.
In the request, you must specify either the StreamName
or
the StreamARN
.
listTagsForStreamRequest
- 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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest) throws AmazonClientException, AmazonServiceException
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.
tagResourceRequest
- 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.TagStreamResult tagStream(TagStreamRequest tagStreamRequest) throws AmazonClientException, AmazonServiceException
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
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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest) throws AmazonClientException, AmazonServiceException
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.
untagResourceRequest
- 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.UntagStreamResult untagStream(UntagStreamRequest untagStreamRequest) throws AmazonClientException, AmazonServiceException
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
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.UpdateDataRetentionResult updateDataRetention(UpdateDataRetentionRequest updateDataRetentionRequest) throws AmazonClientException, AmazonServiceException
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
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.UpdateSignalingChannelResult updateSignalingChannel(UpdateSignalingChannelRequest updateSignalingChannelRequest) throws AmazonClientException, AmazonServiceException
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.
updateSignalingChannelRequest
- 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.UpdateStreamResult updateStream(UpdateStreamRequest updateStreamRequest) throws AmazonClientException, AmazonServiceException
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
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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.