AmazonKinesisVideo (AWS SDK for Java

All Known Subinterfaces:

AmazonKinesisVideoAsync

All Known Implementing Classes:

AbstractAmazonKinesisVideo, AbstractAmazonKinesisVideoAsync, AmazonKinesisVideoAsyncClient, AmazonKinesisVideoClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonKinesisVideo
```
Interface for accessing Kinesis Video.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonKinesisVideo instead.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

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

Method Summary

All Methods Instance Methods Abstract Methods
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.
`DescribeEdgeConfigurationResult`	`describeEdgeConfiguration(DescribeEdgeConfigurationRequest describeEdgeConfigurationRequest)` Describes a stream’s edge configuration that was set using the `StartEdgeConfigurationUpdate` API.
`DescribeImageGenerationConfigurationResult`	`describeImageGenerationConfiguration(DescribeImageGenerationConfigurationRequest describeImageGenerationConfigurationRequest)` Gets the `ImageGenerationConfiguration` for a given Kinesis video stream.
`DescribeMappedResourceConfigurationResult`	`describeMappedResourceConfiguration(DescribeMappedResourceConfigurationRequest describeMappedResourceConfigurationRequest)` Returns the most current information about the stream.
`DescribeMediaStorageConfigurationResult`	`describeMediaStorageConfiguration(DescribeMediaStorageConfigurationRequest describeMediaStorageConfigurationRequest)` Returns the most current information about the channel.
`DescribeNotificationConfigurationResult`	`describeNotificationConfiguration(DescribeNotificationConfigurationRequest describeNotificationConfigurationRequest)` Gets the `NotificationConfiguration` for a given Kinesis video 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`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartEdgeConfigurationUpdateResult`	`startEdgeConfigurationUpdate(StartEdgeConfigurationUpdateRequest startEdgeConfigurationUpdateRequest)` An asynchronous API that updates a stream’s existing edge configuration.
`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.
`UpdateImageGenerationConfigurationResult`	`updateImageGenerationConfiguration(UpdateImageGenerationConfigurationRequest updateImageGenerationConfigurationRequest)` Updates the `StreamInfo` and `ImageProcessingConfiguration` fields.
`UpdateMediaStorageConfigurationResult`	`updateMediaStorageConfiguration(UpdateMediaStorageConfigurationRequest updateMediaStorageConfigurationRequest)` Associates a `SignalingChannel` to a stream to store the media.
`UpdateNotificationConfigurationResult`	`updateNotificationConfiguration(UpdateNotificationConfigurationRequest updateNotificationConfigurationRequest)` Updates the notification information for a stream.
`UpdateSignalingChannelResult`	`updateSignalingChannel(UpdateSignalingChannelRequest updateSignalingChannelRequest)` Updates the existing signaling channel.
`UpdateStreamResult`	`updateStream(UpdateStreamRequest updateStreamRequest)` Updates stream metadata, such as the device name and media type.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - createSignalingChannel
```
CreateSignalingChannelResult createSignalingChannel(CreateSignalingChannelRequest createSignalingChannelRequest)
```
    Creates a signaling channel.
    
    CreateSignalingChannel is an asynchronous operation.
    Parameters:
    
    createSignalingChannelRequest -
    
    Returns:
    
    Result of the CreateSignalingChannel operation returned by the service.
    
    Throws:
    
    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 Amazon Web Services account in this region.
    ResourceInUseException - When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :
    
    The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.
    
    The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.
    
    The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.
    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. A Kinesis video stream can support up to 50 tags.
    
    See Also:
    
    AWS API Documentation
  - createStream
```
CreateStreamResult createStream(CreateStreamRequest createStreamRequest)
```
    Creates a new Kinesis video stream.
    
    When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version.
    
    CreateStream is an asynchronous operation.
    
    For information about how the service works, see How it Works.
    
    You must have permissions for the KinesisVideo:CreateStream action.
    Parameters:
    
    createStreamRequest -
    
    Returns:
    
    Result of the CreateStream operation returned by the service.
    
    Throws:
    
    AccountStreamLimitExceededException - The number of streams created for the account is too high.
    
    DeviceStreamLimitExceededException - Not implemented.
    ResourceInUseException - When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :
    
    The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.
    
    The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.
    
    The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.
    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. A Kinesis video stream can support up to 50 tags.
    
    See Also:
    
    AWS API Documentation
  - deleteSignalingChannel
```
DeleteSignalingChannelResult deleteSignalingChannel(DeleteSignalingChannelRequest deleteSignalingChannelRequest)
```
    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.
    Parameters:
    
    deleteSignalingChannelRequest -
    
    Returns:
    
    Result of the DeleteSignalingChannel operation returned by the service.
    
    Throws:
    
    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.
    ResourceInUseException - When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :
    
    The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.
    
    The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.
    
    The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.
    See Also:
    
    AWS API Documentation
  - deleteStream
```
DeleteStreamResult deleteStream(DeleteStreamRequest deleteStreamRequest)
```
    Deletes a Kinesis video stream and the data contained in the stream.
    
    This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.
    
    To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.
    
    This operation requires permission for the KinesisVideo:DeleteStream action.
    Parameters:
    
    deleteStreamRequest -
    
    Returns:
    
    Result of the DeleteStream operation returned by the service.
    
    Throws:
    
    ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException - The value for this input parameter is invalid.
    
    ResourceNotFoundException - Amazon Kinesis Video Streams can't find the stream that you specified.
    
    NotAuthorizedException - The caller is not authorized to perform this operation.
    
    VersionMismatchException - The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.
    ResourceInUseException - When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :
    
    The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.
    
    The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.
    
    The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.
    See Also:
    
    AWS API Documentation
  - describeEdgeConfiguration
```
DescribeEdgeConfigurationResult describeEdgeConfiguration(DescribeEdgeConfigurationRequest describeEdgeConfigurationRequest)
```
    Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API. Use this API to get the status of the configuration if the configuration is in sync with the Edge Agent.
    
    Parameters:
    
    describeEdgeConfigurationRequest -
    
    Returns:
    
    Result of the DescribeEdgeConfiguration operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You do not have required permissions to perform this operation.
    
    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.
    
    StreamEdgeConfigurationNotFoundException - The Exception rendered when the Amazon Kinesis Video Stream can't find a stream's edge configuration that you specified.
    
    See Also:
    
    AWS API Documentation
  - describeImageGenerationConfiguration
```
DescribeImageGenerationConfigurationResult describeImageGenerationConfiguration(DescribeImageGenerationConfigurationRequest describeImageGenerationConfigurationRequest)
```
    Gets the ImageGenerationConfiguration for a given Kinesis video stream.
    
    Parameters:
    
    describeImageGenerationConfigurationRequest -
    
    Returns:
    
    Result of the DescribeImageGenerationConfiguration operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeMappedResourceConfiguration
```
DescribeMappedResourceConfigurationResult describeMappedResourceConfiguration(DescribeMappedResourceConfigurationRequest describeMappedResourceConfigurationRequest)
```
    Returns the most current information about the stream. Either streamName or streamARN should be provided in the input.
    
    Returns the most current information about the stream. The streamName or streamARN should be provided in the input.
    
    Parameters:
    
    describeMappedResourceConfigurationRequest -
    
    Returns:
    
    Result of the DescribeMappedResourceConfiguration operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - Amazon Kinesis Video Streams can't find the stream that you specified.
    
    InvalidArgumentException - The value for this input parameter is invalid.
    
    AccessDeniedException - You do not have required permissions to perform this operation.
    
    ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    See Also:
    
    AWS API Documentation
  - describeMediaStorageConfiguration
```
DescribeMediaStorageConfigurationResult describeMediaStorageConfiguration(DescribeMediaStorageConfigurationRequest describeMediaStorageConfigurationRequest)
```
    Returns the most current information about the channel. Specify the ChannelName or ChannelARN in the input.
    
    Parameters:
    
    describeMediaStorageConfigurationRequest -
    
    Returns:
    
    Result of the DescribeMediaStorageConfiguration operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - Amazon Kinesis Video Streams can't find the stream that you specified.
    
    InvalidArgumentException - The value for this input parameter is invalid.
    
    AccessDeniedException - You do not have required permissions to perform this operation.
    
    ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    See Also:
    
    AWS API Documentation
  - describeNotificationConfiguration
```
DescribeNotificationConfigurationResult describeNotificationConfiguration(DescribeNotificationConfigurationRequest describeNotificationConfigurationRequest)
```
    Gets the NotificationConfiguration for a given Kinesis video stream.
    
    Parameters:
    
    describeNotificationConfigurationRequest -
    
    Returns:
    
    Result of the DescribeNotificationConfiguration operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeSignalingChannel
```
DescribeSignalingChannelResult describeSignalingChannel(DescribeSignalingChannelRequest describeSignalingChannelRequest)
```
    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.
    
    Parameters:
    
    describeSignalingChannelRequest -
    
    Returns:
    
    Result of the DescribeSignalingChannel operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeStream
```
DescribeStreamResult describeStream(DescribeStreamRequest describeStreamRequest)
```
    Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.
    
    Parameters:
    
    describeStreamRequest -
    
    Returns:
    
    Result of the DescribeStream operation returned by the service.
    
    Throws:
    
    InvalidArgumentException - The value for this input parameter is invalid.
    
    ResourceNotFoundException - Amazon Kinesis Video Streams can't find the stream that you specified.
    
    ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    NotAuthorizedException - The caller is not authorized to perform this operation.
    
    See Also:
    
    AWS API Documentation
  - getDataEndpoint
```
GetDataEndpointResult getDataEndpoint(GetDataEndpointRequest getDataEndpointRequest)
```
    Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the GetMedia or GetMediaForFragmentList operations) or write to it (using the PutMedia operation).
    
    The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint.
    
    In the request, specify the stream either by StreamName or StreamARN.
    
    Parameters:
    
    getDataEndpointRequest -
    
    Returns:
    
    Result of the GetDataEndpoint operation returned by the service.
    
    Throws:
    
    InvalidArgumentException - The value for this input parameter is invalid.
    
    ResourceNotFoundException - Amazon Kinesis Video Streams can't find the stream that you specified.
    
    ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    NotAuthorizedException - The caller is not authorized to perform this operation.
    
    See Also:
    
    AWS API Documentation
  - getSignalingChannelEndpoint
```
GetSignalingChannelEndpointResult getSignalingChannelEndpoint(GetSignalingChannelEndpointRequest getSignalingChannelEndpointRequest)
```
    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.
    Parameters:
    
    getSignalingChannelEndpointRequest -
    
    Returns:
    
    Result of the GetSignalingChannelEndpoint operation returned by the service.
    
    Throws:
    
    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 - When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :
    
    The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.
    
    The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.
    
    The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.
    AccessDeniedException - You do not have required permissions to perform this operation.
    
    See Also:
    
    AWS API Documentation
  - listSignalingChannels
```
ListSignalingChannelsResult listSignalingChannels(ListSignalingChannelsRequest listSignalingChannelsRequest)
```
    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.
    
    Parameters:
    
    listSignalingChannelsRequest -
    
    Returns:
    
    Result of the ListSignalingChannels operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listStreams
```
ListStreamsResult listStreams(ListStreamsRequest listStreamsRequest)
```
    Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition.
    
    Parameters:
    
    listStreamsRequest -
    
    Returns:
    
    Result of the ListStreams operation returned by the service.
    
    Throws:
    
    ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException - The value for this input parameter is invalid.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Returns a list of tags associated with the specified signaling channel.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listTagsForStream
```
ListTagsForStreamResult listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest)
```
    Returns a list of tags associated with the specified stream.
    
    In the request, you must specify either the StreamName or the StreamARN.
    
    Parameters:
    
    listTagsForStreamRequest -
    
    Returns:
    
    Result of the ListTagsForStream operation returned by the service.
    
    Throws:
    
    ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException - The value for this input parameter is invalid.
    
    ResourceNotFoundException - Amazon Kinesis Video Streams can't find the stream that you specified.
    
    NotAuthorizedException - The caller is not authorized to perform this operation.
    
    InvalidResourceFormatException - The format of the StreamARN is invalid.
    
    See Also:
    
    AWS API Documentation
  - startEdgeConfigurationUpdate
```
StartEdgeConfigurationUpdateResult startEdgeConfigurationUpdate(StartEdgeConfigurationUpdateRequest startEdgeConfigurationUpdateRequest)
```
    An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The SyncStatus will be updated as the edge configuration is acknowledged, and synced with the Edge Agent.
    
    If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to SYNCING. You will have to wait for the sync status to reach a terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API again. If you invoke this API during the syncing process, a ResourceInUseException will be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into the SYNC_FAILED state.
    Parameters:
    
    startEdgeConfigurationUpdateRequest -
    
    Returns:
    
    Result of the StartEdgeConfigurationUpdate operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You do not have required permissions to perform this operation.
    
    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.
    
    NoDataRetentionException - The Stream data retention in hours is equal to zero.
    ResourceInUseException - When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :
    
    The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.
    
    The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.
    
    The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.
    ResourceNotFoundException - Amazon Kinesis Video Streams can't find the stream that you specified.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    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 Amazon Web Services 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 Billing and Cost Management and Cost Management User Guide.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    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. A Kinesis video stream can support up to 50 tags.
    
    See Also:
    
    AWS API Documentation
  - tagStream
```
TagStreamResult tagStream(TagStreamRequest tagStreamRequest)
```
    Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services 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 Billing and Cost Management and Cost Management User Guide.
    
    You must provide either the StreamName or the StreamARN.
    
    This operation requires permission for the KinesisVideo:TagStream action.
    
    A Kinesis video stream can support up to 50 tags.
    
    Parameters:
    
    tagStreamRequest -
    
    Returns:
    
    Result of the TagStream operation returned by the service.
    
    Throws:
    
    ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException - The value for this input parameter is invalid.
    
    ResourceNotFoundException - Amazon Kinesis Video Streams can't find the stream that you specified.
    
    NotAuthorizedException - The caller is not authorized to perform this operation.
    
    InvalidResourceFormatException - The format of the StreamARN is invalid.
    
    TagsPerResourceExceededLimitException - You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    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.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - untagStream
```
UntagStreamResult untagStream(UntagStreamRequest untagStreamRequest)
```
    Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.
    
    In the request, you must provide the StreamName or StreamARN.
    
    Parameters:
    
    untagStreamRequest -
    
    Returns:
    
    Result of the UntagStream operation returned by the service.
    
    Throws:
    
    ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException - The value for this input parameter is invalid.
    
    ResourceNotFoundException - Amazon Kinesis Video Streams can't find the stream that you specified.
    
    NotAuthorizedException - The caller is not authorized to perform this operation.
    
    InvalidResourceFormatException - The format of the StreamARN is invalid.
    
    See Also:
    
    AWS API Documentation
  - updateDataRetention
```
UpdateDataRetentionResult updateDataRetention(UpdateDataRetentionRequest updateDataRetentionRequest)
```
    Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the Operation parameter in the request body. In the request, you must specify either the StreamName or the StreamARN.
    
    The retention period that you specify replaces the current value.
    
    This operation requires permission for the KinesisVideo:UpdateDataRetention action.
    
    Changing the data retention period affects the data in the stream as follows:
    - If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours.
    - If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.
    Parameters:
    
    updateDataRetentionRequest -
    
    Returns:
    
    Result of the UpdateDataRetention operation returned by the service.
    
    Throws:
    
    ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException - The value for this input parameter is invalid.
    
    ResourceNotFoundException - Amazon Kinesis Video Streams can't find the stream that you specified.
    ResourceInUseException - When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :
    
    The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.
    
    The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.
    
    The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.
    NotAuthorizedException - The caller is not authorized to perform this operation.
    
    VersionMismatchException - The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.
    
    See Also:
    
    AWS API Documentation
  - updateImageGenerationConfiguration
```
UpdateImageGenerationConfigurationResult updateImageGenerationConfiguration(UpdateImageGenerationConfigurationRequest updateImageGenerationConfigurationRequest)
```
    Updates the StreamInfo and ImageProcessingConfiguration fields.
    Parameters:
    
    updateImageGenerationConfigurationRequest -
    
    Returns:
    
    Result of the UpdateImageGenerationConfiguration operation returned by the service.
    
    Throws:
    
    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.
    ResourceInUseException - When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :
    
    The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.
    
    The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.
    
    The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.
    NoDataRetentionException - The Stream data retention in hours is equal to zero.
    
    See Also:
    
    AWS API Documentation
  - updateMediaStorageConfiguration
```
UpdateMediaStorageConfigurationResult updateMediaStorageConfiguration(UpdateMediaStorageConfigurationRequest updateMediaStorageConfigurationRequest)
```
    Associates a SignalingChannel to a stream to store the media. There are two signaling modes that can specified :
    - If the StorageStatus is disabled, no data will be stored, and the StreamARN parameter will not be needed.
    - If the StorageStatus is enabled, the data will be stored in the StreamARN provided.
    Parameters:
    
    updateMediaStorageConfigurationRequest -
    
    Returns:
    
    Result of the UpdateMediaStorageConfiguration operation returned by the service.
    
    Throws:
    ResourceInUseException - When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :
    
    The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.
    
    The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.
    
    The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.
    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.
    
    NoDataRetentionException - The Stream data retention in hours is equal to zero.
    
    See Also:
    
    AWS API Documentation
  - updateNotificationConfiguration
```
UpdateNotificationConfigurationResult updateNotificationConfiguration(UpdateNotificationConfigurationRequest updateNotificationConfigurationRequest)
```
    Updates the notification information for a stream.
    Parameters:
    
    updateNotificationConfigurationRequest -
    
    Returns:
    
    Result of the UpdateNotificationConfiguration operation returned by the service.
    
    Throws:
    
    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.
    ResourceInUseException - When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :
    
    The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.
    
    The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.
    
    The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.
    NoDataRetentionException - The Stream data retention in hours is equal to zero.
    
    See Also:
    
    AWS API Documentation
  - updateSignalingChannel
```
UpdateSignalingChannelResult updateSignalingChannel(UpdateSignalingChannelRequest updateSignalingChannelRequest)
```
    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.
    Parameters:
    
    updateSignalingChannelRequest -
    
    Returns:
    
    Result of the UpdateSignalingChannel operation returned by the service.
    
    Throws:
    
    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 - When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :
    
    The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.
    
    The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.
    
    The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.
    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.
    
    See Also:
    
    AWS API Documentation
  - updateStream
```
UpdateStreamResult updateStream(UpdateStreamRequest updateStreamRequest)
```
    Updates stream metadata, such as the device name and media type.
    
    You must provide the stream name or the Amazon Resource Name (ARN) of the stream.
    
    To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.
    
    UpdateStream is an asynchronous operation, and takes time to complete.
    Parameters:
    
    updateStreamRequest -
    
    Returns:
    
    Result of the UpdateStream operation returned by the service.
    
    Throws:
    
    ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
    
    InvalidArgumentException - The value for this input parameter is invalid.
    
    ResourceNotFoundException - Amazon Kinesis Video Streams can't find the stream that you specified.
    ResourceInUseException - When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :
    
    The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.
    
    The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.
    
    The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.
    NotAuthorizedException - The caller is not authorized to perform this operation.
    
    VersionMismatchException - The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonKinesisVideo

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createSignalingChannel

createStream

deleteSignalingChannel

deleteStream

describeEdgeConfiguration

describeImageGenerationConfiguration

describeMappedResourceConfiguration

describeMediaStorageConfiguration

describeNotificationConfiguration

describeSignalingChannel

describeStream

getDataEndpoint

getSignalingChannelEndpoint

listSignalingChannels

listStreams

listTagsForResource

listTagsForStream

startEdgeConfigurationUpdate

tagResource

tagStream

untagResource

untagStream

updateDataRetention

updateImageGenerationConfiguration

updateMediaStorageConfiguration

updateNotificationConfiguration

updateSignalingChannel

updateStream

shutdown

getCachedResponseMetadata