Struct rusoto_kinesisvideo::KinesisVideoClient
source · [−]pub struct KinesisVideoClient { /* private fields */ }
Expand description
A client for the Kinesis Video API.
Implementations
sourceimpl KinesisVideoClient
impl KinesisVideoClient
sourcepub fn new(region: Region) -> KinesisVideoClient
pub fn new(region: Region) -> KinesisVideoClient
Creates a client backed by the default tokio event loop.
The client will use the default credentials provider and tls client.
pub fn new_with<P, D>(
request_dispatcher: D,
credentials_provider: P,
region: Region
) -> KinesisVideoClient where
P: ProvideAwsCredentials + Send + Sync + 'static,
D: DispatchSignedRequest + Send + Sync + 'static,
pub fn new_with_client(client: Client, region: Region) -> KinesisVideoClient
Trait Implementations
sourceimpl Clone for KinesisVideoClient
impl Clone for KinesisVideoClient
sourcefn clone(&self) -> KinesisVideoClient
fn clone(&self) -> KinesisVideoClient
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl KinesisVideo for KinesisVideoClient
impl KinesisVideo for KinesisVideoClient
sourcefn create_signaling_channel<'life0, 'async_trait>(
&'life0 self,
input: CreateSignalingChannelInput
) -> Pin<Box<dyn Future<Output = Result<CreateSignalingChannelOutput, RusotoError<CreateSignalingChannelError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn create_signaling_channel<'life0, 'async_trait>(
&'life0 self,
input: CreateSignalingChannelInput
) -> Pin<Box<dyn Future<Output = Result<CreateSignalingChannelOutput, RusotoError<CreateSignalingChannelError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Creates a signaling channel.
CreateSignalingChannel
is an asynchronous operation.
sourcefn create_stream<'life0, 'async_trait>(
&'life0 self,
input: CreateStreamInput
) -> Pin<Box<dyn Future<Output = Result<CreateStreamOutput, RusotoError<CreateStreamError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn create_stream<'life0, 'async_trait>(
&'life0 self,
input: CreateStreamInput
) -> Pin<Box<dyn Future<Output = Result<CreateStreamOutput, RusotoError<CreateStreamError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
sourcefn delete_signaling_channel<'life0, 'async_trait>(
&'life0 self,
input: DeleteSignalingChannelInput
) -> Pin<Box<dyn Future<Output = Result<DeleteSignalingChannelOutput, RusotoError<DeleteSignalingChannelError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn delete_signaling_channel<'life0, 'async_trait>(
&'life0 self,
input: DeleteSignalingChannelInput
) -> Pin<Box<dyn Future<Output = Result<DeleteSignalingChannelOutput, RusotoError<DeleteSignalingChannelError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
sourcefn delete_stream<'life0, 'async_trait>(
&'life0 self,
input: DeleteStreamInput
) -> Pin<Box<dyn Future<Output = Result<DeleteStreamOutput, RusotoError<DeleteStreamError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn delete_stream<'life0, 'async_trait>(
&'life0 self,
input: DeleteStreamInput
) -> Pin<Box<dyn Future<Output = Result<DeleteStreamOutput, RusotoError<DeleteStreamError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
sourcefn describe_signaling_channel<'life0, 'async_trait>(
&'life0 self,
input: DescribeSignalingChannelInput
) -> Pin<Box<dyn Future<Output = Result<DescribeSignalingChannelOutput, RusotoError<DescribeSignalingChannelError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn describe_signaling_channel<'life0, 'async_trait>(
&'life0 self,
input: DescribeSignalingChannelInput
) -> Pin<Box<dyn Future<Output = Result<DescribeSignalingChannelOutput, RusotoError<DescribeSignalingChannelError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
sourcefn describe_stream<'life0, 'async_trait>(
&'life0 self,
input: DescribeStreamInput
) -> Pin<Box<dyn Future<Output = Result<DescribeStreamOutput, RusotoError<DescribeStreamError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn describe_stream<'life0, 'async_trait>(
&'life0 self,
input: DescribeStreamInput
) -> Pin<Box<dyn Future<Output = Result<DescribeStreamOutput, RusotoError<DescribeStreamError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
Returns the most current information about the specified stream. You must specify either the StreamName
or the StreamARN
.
sourcefn get_data_endpoint<'life0, 'async_trait>(
&'life0 self,
input: GetDataEndpointInput
) -> Pin<Box<dyn Future<Output = Result<GetDataEndpointOutput, RusotoError<GetDataEndpointError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_data_endpoint<'life0, 'async_trait>(
&'life0 self,
input: GetDataEndpointInput
) -> Pin<Box<dyn Future<Output = Result<GetDataEndpointOutput, RusotoError<GetDataEndpointError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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
.
sourcefn get_signaling_channel_endpoint<'life0, 'async_trait>(
&'life0 self,
input: GetSignalingChannelEndpointInput
) -> Pin<Box<dyn Future<Output = Result<GetSignalingChannelEndpointOutput, RusotoError<GetSignalingChannelEndpointError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn get_signaling_channel_endpoint<'life0, 'async_trait>(
&'life0 self,
input: GetSignalingChannelEndpointInput
) -> Pin<Box<dyn Future<Output = Result<GetSignalingChannelEndpointOutput, RusotoError<GetSignalingChannelEndpointError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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
.
sourcefn list_signaling_channels<'life0, 'async_trait>(
&'life0 self,
input: ListSignalingChannelsInput
) -> Pin<Box<dyn Future<Output = Result<ListSignalingChannelsOutput, RusotoError<ListSignalingChannelsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn list_signaling_channels<'life0, 'async_trait>(
&'life0 self,
input: ListSignalingChannelsInput
) -> Pin<Box<dyn Future<Output = Result<ListSignalingChannelsOutput, RusotoError<ListSignalingChannelsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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
.
sourcefn list_streams<'life0, 'async_trait>(
&'life0 self,
input: ListStreamsInput
) -> Pin<Box<dyn Future<Output = Result<ListStreamsOutput, RusotoError<ListStreamsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn list_streams<'life0, 'async_trait>(
&'life0 self,
input: ListStreamsInput
) -> Pin<Box<dyn Future<Output = Result<ListStreamsOutput, RusotoError<ListStreamsError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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
.
Returns a list of tags associated with the specified signaling channel.
Returns a list of tags associated with the specified stream.
In the request, you must specify either the StreamName
or the StreamARN
.
sourcefn tag_resource<'life0, 'async_trait>(
&'life0 self,
input: TagResourceInput
) -> Pin<Box<dyn Future<Output = Result<TagResourceOutput, RusotoError<TagResourceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn tag_resource<'life0, 'async_trait>(
&'life0 self,
input: TagResourceInput
) -> Pin<Box<dyn Future<Output = Result<TagResourceOutput, RusotoError<TagResourceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
sourcefn tag_stream<'life0, 'async_trait>(
&'life0 self,
input: TagStreamInput
) -> Pin<Box<dyn Future<Output = Result<TagStreamOutput, RusotoError<TagStreamError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn tag_stream<'life0, 'async_trait>(
&'life0 self,
input: TagStreamInput
) -> Pin<Box<dyn Future<Output = Result<TagStreamOutput, RusotoError<TagStreamError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
sourcefn untag_resource<'life0, 'async_trait>(
&'life0 self,
input: UntagResourceInput
) -> Pin<Box<dyn Future<Output = Result<UntagResourceOutput, RusotoError<UntagResourceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn untag_resource<'life0, 'async_trait>(
&'life0 self,
input: UntagResourceInput
) -> Pin<Box<dyn Future<Output = Result<UntagResourceOutput, RusotoError<UntagResourceError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
sourcefn untag_stream<'life0, 'async_trait>(
&'life0 self,
input: UntagStreamInput
) -> Pin<Box<dyn Future<Output = Result<UntagStreamOutput, RusotoError<UntagStreamError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn untag_stream<'life0, 'async_trait>(
&'life0 self,
input: UntagStreamInput
) -> Pin<Box<dyn Future<Output = Result<UntagStreamOutput, RusotoError<UntagStreamError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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
.
sourcefn update_data_retention<'life0, 'async_trait>(
&'life0 self,
input: UpdateDataRetentionInput
) -> Pin<Box<dyn Future<Output = Result<UpdateDataRetentionOutput, RusotoError<UpdateDataRetentionError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn update_data_retention<'life0, 'async_trait>(
&'life0 self,
input: UpdateDataRetentionInput
) -> Pin<Box<dyn Future<Output = Result<UpdateDataRetentionOutput, RusotoError<UpdateDataRetentionError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
sourcefn update_signaling_channel<'life0, 'async_trait>(
&'life0 self,
input: UpdateSignalingChannelInput
) -> Pin<Box<dyn Future<Output = Result<UpdateSignalingChannelOutput, RusotoError<UpdateSignalingChannelError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn update_signaling_channel<'life0, 'async_trait>(
&'life0 self,
input: UpdateSignalingChannelInput
) -> Pin<Box<dyn Future<Output = Result<UpdateSignalingChannelOutput, RusotoError<UpdateSignalingChannelError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
sourcefn update_stream<'life0, 'async_trait>(
&'life0 self,
input: UpdateStreamInput
) -> Pin<Box<dyn Future<Output = Result<UpdateStreamOutput, RusotoError<UpdateStreamError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
fn update_stream<'life0, 'async_trait>(
&'life0 self,
input: UpdateStreamInput
) -> Pin<Box<dyn Future<Output = Result<UpdateStreamOutput, RusotoError<UpdateStreamError>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,
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.
Auto Trait Implementations
impl !RefUnwindSafe for KinesisVideoClient
impl Send for KinesisVideoClient
impl Sync for KinesisVideoClient
impl Unpin for KinesisVideoClient
impl !UnwindSafe for KinesisVideoClient
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more