AbstractAmazonKinesisVideo (AWS Java SDK for Amazon Kinesis Video Streams 1.12.189 API)

java.lang.Object
- com.amazonaws.services.kinesisvideo.AbstractAmazonKinesisVideo

All Implemented Interfaces:

AmazonKinesisVideo

Direct Known Subclasses:

AbstractAmazonKinesisVideoAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonKinesisVideo
extends Object
implements AmazonKinesisVideo
```
Abstract implementation of AmazonKinesisVideo. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.kinesisvideo.AmazonKinesisVideo
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractAmazonKinesisVideo()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAmazonKinesisVideo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractAmazonKinesisVideo
```
protected AbstractAmazonKinesisVideo()
```
- Method Detail
  - createSignalingChannel
```
public CreateSignalingChannelResult createSignalingChannel(CreateSignalingChannelRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    Creates a signaling channel.
    
    CreateSignalingChannel is an asynchronous operation.
    
    Specified by:
    
    createSignalingChannel in interface AmazonKinesisVideo
    
    Returns:
    
    Result of the CreateSignalingChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createStream
```
public CreateStreamResult createStream(CreateStreamRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    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 AmazonKinesisVideo
    
    Returns:
    
    Result of the CreateStream operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteSignalingChannel
```
public DeleteSignalingChannelResult deleteSignalingChannel(DeleteSignalingChannelRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    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 AmazonKinesisVideo
    
    Returns:
    
    Result of the DeleteSignalingChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteStream
```
public DeleteStreamResult deleteStream(DeleteStreamRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    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 AmazonKinesisVideo
    
    Returns:
    
    Result of the DeleteStream operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeSignalingChannel
```
public DescribeSignalingChannelResult describeSignalingChannel(DescribeSignalingChannelRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.
    
    Specified by:
    
    describeSignalingChannel in interface AmazonKinesisVideo
    
    Returns:
    
    Result of the DescribeSignalingChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStream
```
public DescribeStreamResult describeStream(DescribeStreamRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.
    
    Specified by:
    
    describeStream in interface AmazonKinesisVideo
    
    Returns:
    
    Result of the DescribeStream operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDataEndpoint
```
public GetDataEndpointResult getDataEndpoint(GetDataEndpointRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    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 AmazonKinesisVideo
    
    Returns:
    
    Result of the GetDataEndpoint operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSignalingChannelEndpoint
```
public GetSignalingChannelEndpointResult getSignalingChannelEndpoint(GetSignalingChannelEndpointRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    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, if you specify WSS as the protocol, this API produces a secure websocket endpoint. If you specify HTTPS as the protocol, this API generates 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 AmazonKinesisVideo
    
    Returns:
    
    Result of the GetSignalingChannelEndpoint operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSignalingChannels
```
public ListSignalingChannelsResult listSignalingChannels(ListSignalingChannelsRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    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 AmazonKinesisVideo
    
    Returns:
    
    Result of the ListSignalingChannels operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listStreams
```
public ListStreamsResult listStreams(ListStreamsRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    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 AmazonKinesisVideo
    
    Returns:
    
    Result of the ListStreams operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    Returns a list of tags associated with the specified signaling channel.
    
    Specified by:
    
    listTagsForResource in interface AmazonKinesisVideo
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForStream
```
public ListTagsForStreamResult listTagsForStream(ListTagsForStreamRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    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 AmazonKinesisVideo
    
    Returns:
    
    Result of the ListTagsForStream operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    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 AmazonKinesisVideo
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagStream
```
public TagStreamResult tagStream(TagStreamRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    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 AmazonKinesisVideo
    
    Returns:
    
    Result of the TagStream operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    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 AmazonKinesisVideo
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagStream
```
public UntagStreamResult untagStream(UntagStreamRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    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 AmazonKinesisVideo
    
    Returns:
    
    Result of the UntagStream operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDataRetention
```
public UpdateDataRetentionResult updateDataRetention(UpdateDataRetentionRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    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 AmazonKinesisVideo
    
    Returns:
    
    Result of the UpdateDataRetention operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateSignalingChannel
```
public UpdateSignalingChannelResult updateSignalingChannel(UpdateSignalingChannelRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    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), it only applies to new messages sent via this channel after it's been updated. Existing messages are still expired as per the previous MessageTtlSeconds value.
    
    Specified by:
    
    updateSignalingChannel in interface AmazonKinesisVideo
    
    Returns:
    
    Result of the UpdateSignalingChannel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateStream
```
public UpdateStreamResult updateStream(UpdateStreamRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    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 AmazonKinesisVideo
    
    Returns:
    
    Result of the UpdateStream operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonKinesisVideo
    
    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.
    
    Specified by:
    
    shutdown in interface AmazonKinesisVideo
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonKinesisVideo
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonKinesisVideo
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AbstractAmazonKinesisVideo

Field Summary

Fields inherited from interface com.amazonaws.services.kinesisvideo.AmazonKinesisVideo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractAmazonKinesisVideo

Method Detail

createSignalingChannel

createStream

deleteSignalingChannel

deleteStream

describeSignalingChannel

describeStream

getDataEndpoint

getSignalingChannelEndpoint

listSignalingChannels

listStreams

listTagsForResource

listTagsForStream

tagResource

tagStream

untagResource

untagStream

updateDataRetention

updateSignalingChannel

updateStream

shutdown

getCachedResponseMetadata