Struct aws_sdk_kinesisvideosignaling::client::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for Amazon Kinesis Video Signaling Channels
Client for invoking operations on Amazon Kinesis Video Signaling Channels. Each operation on Amazon Kinesis Video Signaling Channels is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_kinesisvideosignaling::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_kinesisvideosignaling::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_kinesisvideosignaling::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn get_ice_server_config(&self) -> GetIceServerConfig
pub fn get_ice_server_config(&self) -> GetIceServerConfig
Constructs a fluent builder for the GetIceServerConfig
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.
client_id(impl Into<String>)
/set_client_id(Option<String>)
:Unique identifier for the viewer. Must be unique within the signaling channel.
service(Service)
/set_service(Option<Service>)
:Specifies the desired service. Currently,
TURN
is the only valid value.username(impl Into<String>)
/set_username(Option<String>)
:An optional user ID to be associated with the credentials.
- On success, responds with
GetIceServerConfigOutput
with field(s):ice_server_list(Option<Vec<IceServer>>)
:The list of ICE server information objects.
- On failure, responds with
SdkError<GetIceServerConfigError>
sourcepub fn send_alexa_offer_to_master(&self) -> SendAlexaOfferToMaster
pub fn send_alexa_offer_to_master(&self) -> SendAlexaOfferToMaster
Constructs a fluent builder for the SendAlexaOfferToMaster
operation.
- The fluent builder is configurable:
channel_arn(impl Into<String>)
/set_channel_arn(Option<String>)
:The ARN of the signaling channel by which Alexa and the master peer communicate.
sender_client_id(impl Into<String>)
/set_sender_client_id(Option<String>)
:The unique identifier for the sender client.
message_payload(impl Into<String>)
/set_message_payload(Option<String>)
:The base64-encoded SDP offer content.
- On success, responds with
SendAlexaOfferToMasterOutput
with field(s):answer(Option<String>)
:The base64-encoded SDP answer content.
- On failure, responds with
SdkError<SendAlexaOfferToMasterError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
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> 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