Struct aws_sdk_ivs::Client

pub struct Client { /* private fields */ }

Client for Amazon Interactive Video Service

Client for invoking operations on Amazon Interactive Video Service. Each operation on Amazon Interactive Video Service 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_ivs::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_ivs::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_ivs::Client::from_conf(config);

Implementations

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn batch_get_channel(&self) -> BatchGetChannel

Constructs a fluent builder for the BatchGetChannel operation.

• The fluent builder is configurable:
  • arns(Vec<String>) / set_arns(Option<Vec<String>>):

    Array of ARNs, one per channel.

• On success, responds with BatchGetChannelOutput with field(s):
  • channels(Option<Vec<Channel>>):

  • errors(Option<Vec<BatchError>>):

    Each error object is related to a specific ARN in the request.

• On failure, responds with SdkError<BatchGetChannelError>

pub fn batch_get_stream_key(&self) -> BatchGetStreamKey

Constructs a fluent builder for the BatchGetStreamKey operation.

• The fluent builder is configurable:
  • arns(Vec<String>) / set_arns(Option<Vec<String>>):

    Array of ARNs, one per channel.

• On success, responds with BatchGetStreamKeyOutput with field(s):
  • stream_keys(Option<Vec<StreamKey>>):

  • errors(Option<Vec<BatchError>>):

• On failure, responds with SdkError<BatchGetStreamKeyError>

pub fn create_channel(&self) -> CreateChannel

Constructs a fluent builder for the CreateChannel operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    Channel name.

  • latency_mode(ChannelLatencyMode) / set_latency_mode(Option<ChannelLatencyMode>):

    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.

  • r#type(ChannelType) / set_type(Option<ChannelType>):

    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:

    • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.

    • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

  • authorized(bool) / set_authorized(bool):

    Whether the channel is private (enabled for playback authorization). Default: false.

  • recording_configuration_arn(impl Into<String>) / set_recording_configuration_arn(Option<String>):

    Recording-configuration ARN. Default: “” (empty string, recording is disabled).

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    Array of 1-50 maps, each of the form string:string (key:value).

• On success, responds with CreateChannelOutput with field(s):
  • channel(Option<Channel>):

  • stream_key(Option<StreamKey>):

• On failure, responds with SdkError<CreateChannelError>

pub fn create_recording_configuration(&self) -> CreateRecordingConfiguration

Constructs a fluent builder for the CreateRecordingConfiguration operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    Recording-configuration name. The value does not need to be unique.

  • destination_configuration(DestinationConfiguration) / set_destination_configuration(Option<DestinationConfiguration>):

    A complex type that contains a destination configuration for where recorded video will be stored.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    Array of 1-50 maps, each of the form string:string (key:value).

  • thumbnail_configuration(ThumbnailConfiguration) / set_thumbnail_configuration(Option<ThumbnailConfiguration>):

    A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

• On success, responds with CreateRecordingConfigurationOutput with field(s):
  • recording_configuration(Option<RecordingConfiguration>): (undocumented)
• On failure, responds with SdkError<CreateRecordingConfigurationError>

pub fn create_stream_key(&self) -> CreateStreamKey

Constructs a fluent builder for the CreateStreamKey operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):

    ARN of the channel for which to create the stream key.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    Array of 1-50 maps, each of the form string:string (key:value).

• On success, responds with CreateStreamKeyOutput with field(s):
  • stream_key(Option<StreamKey>):

    Stream key used to authenticate an RTMPS stream for ingestion.

• On failure, responds with SdkError<CreateStreamKeyError>

pub fn delete_channel(&self) -> DeleteChannel

Constructs a fluent builder for the DeleteChannel operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

    ARN of the channel to be deleted.

• On success, responds with DeleteChannelOutput
• On failure, responds with SdkError<DeleteChannelError>

pub fn delete_playback_key_pair(&self) -> DeletePlaybackKeyPair

Constructs a fluent builder for the DeletePlaybackKeyPair operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

    ARN of the key pair to be deleted.

• On success, responds with DeletePlaybackKeyPairOutput
• On failure, responds with SdkError<DeletePlaybackKeyPairError>

pub fn delete_recording_configuration(&self) -> DeleteRecordingConfiguration

Constructs a fluent builder for the DeleteRecordingConfiguration operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

    ARN of the recording configuration to be deleted.

• On success, responds with DeleteRecordingConfigurationOutput
• On failure, responds with SdkError<DeleteRecordingConfigurationError>

pub fn delete_stream_key(&self) -> DeleteStreamKey

Constructs a fluent builder for the DeleteStreamKey operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

    ARN of the stream key to be deleted.

• On success, responds with DeleteStreamKeyOutput
• On failure, responds with SdkError<DeleteStreamKeyError>

pub fn get_channel(&self) -> GetChannel

Constructs a fluent builder for the GetChannel operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

    ARN of the channel for which the configuration is to be retrieved.

• On success, responds with GetChannelOutput with field(s):
  • channel(Option<Channel>):

• On failure, responds with SdkError<GetChannelError>

pub fn get_playback_key_pair(&self) -> GetPlaybackKeyPair

Constructs a fluent builder for the GetPlaybackKeyPair operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

    ARN of the key pair to be returned.

• On success, responds with GetPlaybackKeyPairOutput with field(s):
  • key_pair(Option<PlaybackKeyPair>): (undocumented)
• On failure, responds with SdkError<GetPlaybackKeyPairError>

pub fn get_recording_configuration(&self) -> GetRecordingConfiguration

Constructs a fluent builder for the GetRecordingConfiguration operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

    ARN of the recording configuration to be retrieved.

• On success, responds with GetRecordingConfigurationOutput with field(s):
  • recording_configuration(Option<RecordingConfiguration>): (undocumented)
• On failure, responds with SdkError<GetRecordingConfigurationError>

pub fn get_stream(&self) -> GetStream

Constructs a fluent builder for the GetStream operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):

    Channel ARN for stream to be accessed.

• On success, responds with GetStreamOutput with field(s):
  • stream(Option<Stream>):

• On failure, responds with SdkError<GetStreamError>

pub fn get_stream_key(&self) -> GetStreamKey

Constructs a fluent builder for the GetStreamKey operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

    ARN for the stream key to be retrieved.

• On success, responds with GetStreamKeyOutput with field(s):
  • stream_key(Option<StreamKey>): (undocumented)
• On failure, responds with SdkError<GetStreamKeyError>

pub fn get_stream_session(&self) -> GetStreamSession

Constructs a fluent builder for the GetStreamSession operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):

    ARN of the channel resource

  • stream_id(impl Into<String>) / set_stream_id(Option<String>):

    Unique identifier for a live or previously live stream in the specified channel. If no streamId is provided, this returns the most recent stream session for the channel, if it exists.

• On success, responds with GetStreamSessionOutput with field(s):
  • stream_session(Option<StreamSession>):

    List of stream details.

• On failure, responds with SdkError<GetStreamSessionError>

pub fn import_playback_key_pair(&self) -> ImportPlaybackKeyPair

Constructs a fluent builder for the ImportPlaybackKeyPair operation.

• The fluent builder is configurable:
  • public_key_material(impl Into<String>) / set_public_key_material(Option<String>):

    The public portion of a customer-generated key pair.

  • name(impl Into<String>) / set_name(Option<String>):

    Playback-key-pair name. The value does not need to be unique.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    Any tags provided with the request are added to the playback key pair tags.

• On success, responds with ImportPlaybackKeyPairOutput with field(s):
  • key_pair(Option<PlaybackKeyPair>):

• On failure, responds with SdkError<ImportPlaybackKeyPairError>

pub fn list_channels(&self) -> ListChannels

Constructs a fluent builder for the ListChannels operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter_by_name(impl Into<String>) / set_filter_by_name(Option<String>):

    Filters the channel list to match the specified name.

  • filter_by_recording_configuration_arn(impl Into<String>) / set_filter_by_recording_configuration_arn(Option<String>):

    Filters the channel list to match the specified recording-configuration ARN.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The first channel to retrieve. This is used for pagination; see the nextToken response field.

  • max_results(i32) / set_max_results(i32):

    Maximum number of channels to return. Default: 50.

• On success, responds with ListChannelsOutput with field(s):
  • channels(Option<Vec<ChannelSummary>>):

    List of the matching channels.

  • next_token(Option<String>):

    If there are more channels than maxResults, use nextToken in the request to get the next set.

• On failure, responds with SdkError<ListChannelsError>

pub fn list_playback_key_pairs(&self) -> ListPlaybackKeyPairs

Constructs a fluent builder for the ListPlaybackKeyPairs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    Maximum number of key pairs to return.

  • max_results(i32) / set_max_results(i32):

    The first key pair to retrieve. This is used for pagination; see the nextToken response field. Default: 50.

• On success, responds with ListPlaybackKeyPairsOutput with field(s):
  • key_pairs(Option<Vec<PlaybackKeyPairSummary>>):

    List of key pairs.

  • next_token(Option<String>):

    If there are more key pairs than maxResults, use nextToken in the request to get the next set.

• On failure, responds with SdkError<ListPlaybackKeyPairsError>

pub fn list_recording_configurations(&self) -> ListRecordingConfigurations

Constructs a fluent builder for the ListRecordingConfigurations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The first recording configuration to retrieve. This is used for pagination; see the nextToken response field.

  • max_results(i32) / set_max_results(i32):

    Maximum number of recording configurations to return. Default: 50.

• On success, responds with ListRecordingConfigurationsOutput with field(s):
  • recording_configurations(Option<Vec<RecordingConfigurationSummary>>):

    List of the matching recording configurations.

  • next_token(Option<String>):

    If there are more recording configurations than maxResults, use nextToken in the request to get the next set.

• On failure, responds with SdkError<ListRecordingConfigurationsError>

pub fn list_stream_keys(&self) -> ListStreamKeys

Constructs a fluent builder for the ListStreamKeys operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):

    Channel ARN used to filter the list.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The first stream key to retrieve. This is used for pagination; see the nextToken response field.

  • max_results(i32) / set_max_results(i32):

    Maximum number of streamKeys to return. Default: 50.

• On success, responds with ListStreamKeysOutput with field(s):
  • stream_keys(Option<Vec<StreamKeySummary>>):

    List of stream keys.

  • next_token(Option<String>):

    If there are more stream keys than maxResults, use nextToken in the request to get the next set.

• On failure, responds with SdkError<ListStreamKeysError>

pub fn list_streams(&self) -> ListStreams

Constructs a fluent builder for the ListStreams operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter_by(StreamFilters) / set_filter_by(Option<StreamFilters>):

    Filters the stream list to match the specified criterion.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The first stream to retrieve. This is used for pagination; see the nextToken response field.

  • max_results(i32) / set_max_results(i32):

    Maximum number of streams to return. Default: 50.

• On success, responds with ListStreamsOutput with field(s):
  • streams(Option<Vec<StreamSummary>>):

    List of streams.

  • next_token(Option<String>):

    If there are more streams than maxResults, use nextToken in the request to get the next set.

• On failure, responds with SdkError<ListStreamsError>

pub fn list_stream_sessions(&self) -> ListStreamSessions

Constructs a fluent builder for the ListStreamSessions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):

    Channel ARN used to filter the list.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The first stream to retrieve. This is used for pagination; see the nextToken response field.

  • max_results(i32) / set_max_results(i32):

    Maximum number of streams to return. Default: 50.

• On success, responds with ListStreamSessionsOutput with field(s):
  • stream_sessions(Option<Vec<StreamSessionSummary>>):

    List of stream sessions.

  • next_token(Option<String>):

    If there are more streams than maxResults, use nextToken in the request to get the next set.

• On failure, responds with SdkError<ListStreamSessionsError>

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The ARN of the resource to be retrieved.

• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap<String, String>>):

• On failure, responds with SdkError<ListTagsForResourceError>

pub fn put_metadata(&self) -> PutMetadata

Constructs a fluent builder for the PutMetadata operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):

    ARN of the channel into which metadata is inserted. This channel must have an active stream.

  • metadata(impl Into<String>) / set_metadata(Option<String>):

    Metadata to insert into the stream. Maximum: 1 KB per request.

• On success, responds with PutMetadataOutput
• On failure, responds with SdkError<PutMetadataError>

pub fn stop_stream(&self) -> StopStream

Constructs a fluent builder for the StopStream operation.

• The fluent builder is configurable:
  • channel_arn(impl Into<String>) / set_channel_arn(Option<String>):

    ARN of the channel for which the stream is to be stopped.

• On success, responds with StopStreamOutput
• On failure, responds with SdkError<StopStreamError>

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    ARN of the resource for which tags are to be added or updated.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    Array of tags to be added or updated.

• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

pub fn untag_resource(&self) -> UntagResource

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    ARN of the resource for which tags are to be removed.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    Array of tags to be removed.

• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

pub fn update_channel(&self) -> UpdateChannel

Constructs a fluent builder for the UpdateChannel operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

    ARN of the channel to be updated.

  • name(impl Into<String>) / set_name(Option<String>):

    Channel name.

  • latency_mode(ChannelLatencyMode) / set_latency_mode(Option<ChannelLatencyMode>):

    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

  • r#type(ChannelType) / set_type(Option<ChannelType>):

    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:

    • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.

    • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

  • authorized(bool) / set_authorized(bool):

    Whether the channel is private (enabled for playback authorization).

  • recording_configuration_arn(impl Into<String>) / set_recording_configuration_arn(Option<String>):

    Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

• On success, responds with UpdateChannelOutput with field(s):
  • channel(Option<Channel>):

    Object specifying a channel.

• On failure, responds with SdkError<UpdateChannelError>

impl Client

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.

pub fn new(config: &Config) -> Self

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Performs the conversion.