Struct aws_sdk_kinesisvideomedia::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Amazon Kinesis Video Streams Media
Client for invoking operations on Amazon Kinesis Video Streams Media. Each operation on Amazon Kinesis Video Streams Media is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_kinesisvideomedia::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_kinesisvideomedia::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the GetMedia
operation has
a Client::get_media
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.get_media()
.stream_name("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn get_media(&self) -> GetMediaFluentBuilder
pub fn get_media(&self) -> GetMediaFluentBuilder
Constructs a fluent builder for the GetMedia
operation.
- The fluent builder is configurable:
stream_name(impl Into<String>)
/set_stream_name(Option<String>)
:
required: falseThe Kinesis video stream name from where you want to get the media content. If you don’t specify the
streamName
, you must specify thestreamARN
.stream_arn(impl Into<String>)
/set_stream_arn(Option<String>)
:
required: falseThe ARN of the stream from where you want to get the media content. If you don’t specify the
streamARN
, you must specify thestreamName
.start_selector(StartSelector)
/set_start_selector(Option<StartSelector>)
:
required: trueIdentifies the starting chunk to get from the specified stream.
- On success, responds with
GetMediaOutput
with field(s):content_type(Option<String>)
:The content type of the requested media.
payload(ByteStream)
:The payload Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see . The chunks that Kinesis Video Streams returns in the
GetMedia
call also include the following additional Matroska (MKV) tags:-
AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8 string) - In the event your
GetMedia
call terminates, you can use this continuation token in your next request to get the next chunk where the last request terminated. -
AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) - Client applications can use this tag value to determine how far behind the chunk returned in the response is from the latest chunk on the stream.
-
AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.
-
AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server timestamp of the fragment.
-
AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer timestamp of the fragment.
The following tags will be present if an error occurs:
-
AWS_KINESISVIDEO_ERROR_CODE - String description of an error that caused GetMedia to stop.
-
AWS_KINESISVIDEO_ERROR_ID: Integer code of the error.
The error codes are as follows:
-
3002 - Error writing to the stream
-
4000 - Requested fragment is not found
-
4500 - Access denied for the stream’s KMS key
-
4501 - Stream’s KMS key is disabled
-
4502 - Validation error on the stream’s KMS key
-
4503 - KMS key specified in the stream is unavailable
-
4504 - Invalid usage of the KMS key specified in the stream
-
4505 - Invalid state of the KMS key specified in the stream
-
4506 - Unable to find the KMS key specified in the stream
-
5000 - Internal error
-
- On failure, responds with
SdkError<GetMediaError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more