@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonKinesisVideoClient extends AmazonWebServiceClient implements AmazonKinesisVideo
Modifier and Type | Field and Description |
---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
static AmazonKinesisVideoClientBuilder |
builder() |
CreateSignalingChannelResult |
createSignalingChannel(CreateSignalingChannelRequest request)
Creates a signaling channel.
|
CreateStreamResult |
createStream(CreateStreamRequest request)
Creates a new Kinesis video stream.
|
DeleteSignalingChannelResult |
deleteSignalingChannel(DeleteSignalingChannelRequest request)
Deletes a specified signaling channel.
|
DeleteStreamResult |
deleteStream(DeleteStreamRequest request)
Deletes a Kinesis video stream and the data contained in the stream.
|
DescribeSignalingChannelResult |
describeSignalingChannel(DescribeSignalingChannelRequest request)
Returns the most current information about the signaling channel.
|
DescribeStreamResult |
describeStream(DescribeStreamRequest request)
Returns the most current information about the specified stream.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDataEndpointResult |
getDataEndpoint(GetDataEndpointRequest request)
Gets an endpoint for a specified stream for either reading or writing.
|
GetSignalingChannelEndpointResult |
getSignalingChannelEndpoint(GetSignalingChannelEndpointRequest request)
Provides an endpoint for the specified signaling channel to send and receive messages.
|
ListSignalingChannelsResult |
listSignalingChannels(ListSignalingChannelsRequest request)
Returns an array of
ChannelInfo objects. |
ListStreamsResult |
listStreams(ListStreamsRequest request)
Returns an array of
StreamInfo objects. |
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns a list of tags associated with the specified signaling channel.
|
ListTagsForStreamResult |
listTagsForStream(ListTagsForStreamRequest request)
Returns a list of tags associated with the specified stream.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds one or more tags to a signaling channel.
|
TagStreamResult |
tagStream(TagStreamRequest request)
Adds one or more tags to a stream.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from a signaling channel.
|
UntagStreamResult |
untagStream(UntagStreamRequest request)
Removes one or more tags from a stream.
|
UpdateDataRetentionResult |
updateDataRetention(UpdateDataRetentionRequest request)
Increases or decreases the stream's data retention period by the value that you specify.
|
UpdateSignalingChannelResult |
updateSignalingChannel(UpdateSignalingChannelRequest request)
Updates the existing signaling channel.
|
UpdateStreamResult |
updateStream(UpdateStreamRequest request)
Updates stream metadata, such as the device name and media type.
|
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
shutdown
protected static final ClientConfigurationFactory configFactory
public static AmazonKinesisVideoClientBuilder builder()
public CreateSignalingChannelResult createSignalingChannel(CreateSignalingChannelRequest request)
Creates a signaling channel.
CreateSignalingChannel
is an asynchronous operation.
createSignalingChannel
in interface AmazonKinesisVideo
createSignalingChannelRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.AccountChannelLimitExceededException
- You have reached the maximum limit of active signaling channels for this AWS account in this region.ResourceInUseException
- The stream is currently not available for this operation.AccessDeniedException
- You do not have required permissions to perform this operation.TagsPerResourceExceededLimitException
- You have exceeded the limit of tags that you can associate with the resource. Kinesis video streams
support up to 50 tags.public CreateStreamResult createStream(CreateStreamRequest request)
Creates a new Kinesis video stream.
When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version.
CreateStream
is an asynchronous operation.
For information about how the service works, see How it Works.
You must have permissions for the KinesisVideo:CreateStream
action.
createStream
in interface AmazonKinesisVideo
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.TagsPerResourceExceededLimitException
- You have exceeded the limit of tags that you can associate with the resource. Kinesis video streams
support up to 50 tags.public DeleteSignalingChannelResult deleteSignalingChannel(DeleteSignalingChannelRequest request)
Deletes a specified signaling channel. DeleteSignalingChannel
is an asynchronous operation. If you
don't specify the channel's current version, the most recent version is deleted.
deleteSignalingChannel
in interface AmazonKinesisVideo
deleteSignalingChannelRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException
- You do not have required permissions to perform this operation.VersionMismatchException
- The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream
API.public DeleteStreamResult deleteStream(DeleteStreamRequest request)
Deletes a Kinesis video stream and the data contained in the stream.
This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.
To ensure that you have the latest version of the stream before deleting it, you can specify the stream version.
Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a
new version number. To get the latest stream version, use the DescribeStream
API.
This operation requires permission for the KinesisVideo:DeleteStream
action.
deleteStream
in interface AmazonKinesisVideo
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.VersionMismatchException
- The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream
API.public DescribeSignalingChannelResult describeSignalingChannel(DescribeSignalingChannelRequest request)
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.
describeSignalingChannel
in interface AmazonKinesisVideo
describeSignalingChannelRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException
- You do not have required permissions to perform this operation.public DescribeStreamResult describeStream(DescribeStreamRequest request)
Returns the most current information about the specified stream. You must specify either the
StreamName
or the StreamARN
.
describeStream
in interface AmazonKinesisVideo
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.public GetDataEndpointResult getDataEndpoint(GetDataEndpointRequest request)
Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to
read from the specified stream (using the GetMedia
or GetMediaForFragmentList
operations) or write to it (using the PutMedia
operation).
The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint.
In the request, specify the stream either by StreamName
or StreamARN
.
getDataEndpoint
in interface AmazonKinesisVideo
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.public GetSignalingChannelEndpointResult getSignalingChannelEndpoint(GetSignalingChannelEndpointRequest request)
Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the
SingleMasterChannelEndpointConfiguration
input parameter, which consists of the
Protocols
and Role
properties.
Protocols
is used to determine the communication mechanism. For example, 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
.
getSignalingChannelEndpoint
in interface AmazonKinesisVideo
getSignalingChannelEndpointRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.ResourceInUseException
- The stream is currently not available for this operation.AccessDeniedException
- You do not have required permissions to perform this operation.public ListSignalingChannelsResult listSignalingChannels(ListSignalingChannelsRequest request)
Returns an array of ChannelInfo
objects. Each object describes a signaling channel. To retrieve only
those channels that satisfy a specific condition, you can specify a ChannelNameCondition
.
listSignalingChannels
in interface AmazonKinesisVideo
listSignalingChannelsRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.AccessDeniedException
- You do not have required permissions to perform this operation.public ListStreamsResult listStreams(ListStreamsRequest request)
Returns an array of StreamInfo
objects. Each object describes a stream. To retrieve only streams
that satisfy a specific condition, you can specify a StreamNameCondition
.
listStreams
in interface AmazonKinesisVideo
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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns a list of tags associated with the specified signaling channel.
listTagsForResource
in interface AmazonKinesisVideo
listTagsForResourceRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException
- You do not have required permissions to perform this operation.public ListTagsForStreamResult listTagsForStream(ListTagsForStreamRequest request)
Returns a list of tags associated with the specified stream.
In the request, you must specify either the StreamName
or the StreamARN
.
listTagsForStream
in interface AmazonKinesisVideo
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.public TagResourceResult tagResource(TagResourceRequest request)
Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to 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.
tagResource
in interface AmazonKinesisVideo
tagResourceRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException
- You do not have required permissions to perform this operation.TagsPerResourceExceededLimitException
- You have exceeded the limit of tags that you can associate with the resource. Kinesis video streams
support up to 50 tags.public TagStreamResult tagStream(TagStreamRequest request)
Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to 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.
tagStream
in interface AmazonKinesisVideo
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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.
untagResource
in interface AmazonKinesisVideo
untagResourceRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.AccessDeniedException
- You do not have required permissions to perform this operation.public UntagStreamResult untagStream(UntagStreamRequest request)
Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.
In the request, you must provide the StreamName
or StreamARN
.
untagStream
in interface AmazonKinesisVideo
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.public UpdateDataRetentionResult updateDataRetention(UpdateDataRetentionRequest request)
Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you
want to increase or decrease the data retention period, specify the Operation
parameter in the
request body. In the request, you must specify either the StreamName
or the StreamARN
.
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.
updateDataRetention
in interface AmazonKinesisVideo
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.public UpdateSignalingChannelResult updateSignalingChannel(UpdateSignalingChannelRequest request)
Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.
If the MessageTtlSeconds
value is updated (either increased or reduced), 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.
updateSignalingChannel
in interface AmazonKinesisVideo
updateSignalingChannelRequest
- InvalidArgumentException
- The value for this input parameter is invalid.ClientLimitExceededException
- Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client
calls. Try making the call later.ResourceNotFoundException
- Amazon Kinesis Video Streams can't find the stream that you specified.ResourceInUseException
- The stream is currently not available for this operation.AccessDeniedException
- You do not have required permissions to perform this operation.VersionMismatchException
- The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream
API.public UpdateStreamResult updateStream(UpdateStreamRequest request)
Updates stream metadata, such as the device name and media type.
You must provide the stream name or the Amazon Resource Name (ARN) of the stream.
To make sure that you have the latest version of the stream before updating it, you can specify the stream
version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams
assigns a new version number. To get the latest stream version, use the DescribeStream
API.
UpdateStream
is an asynchronous operation, and takes time to complete.
updateStream
in interface AmazonKinesisVideo
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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonKinesisVideo
request
- The originally executed requestCopyright © 2020. All rights reserved.