Struct 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.

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_ivs::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 Builder 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_ivs::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 CreateChannel operation has a Client::create_channel, 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.create_channel()
    .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

impl Client

pub fn batch_get_channel(&self) -> BatchGetChannelFluentBuilder

Constructs a fluent builder for the BatchGetChannel operation.

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

    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>

impl Client

pub fn batch_get_stream_key(&self) -> BatchGetStreamKeyFluentBuilder

Constructs a fluent builder for the BatchGetStreamKey operation.

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

    Array of ARNs, one per stream key.

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

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

• On failure, responds with SdkError<BatchGetStreamKeyError>

impl Client

pub fn batch_start_viewer_session_revocation( &self, ) -> BatchStartViewerSessionRevocationFluentBuilder

Constructs a fluent builder for the BatchStartViewerSessionRevocation operation.

• The fluent builder is configurable:
  • viewer_sessions(BatchStartViewerSessionRevocationViewerSession) / set_viewer_sessions(Option<Vec::<BatchStartViewerSessionRevocationViewerSession>>):
    required: true
    

    Array of viewer sessions, one per channel-ARN and viewer-ID pair.

    
    
• On success, responds with BatchStartViewerSessionRevocationOutput with field(s):
  • errors(Option<Vec::<BatchStartViewerSessionRevocationError>>):

    Each error object is related to a specific channelArn and viewerId pair in the request.

• On failure, responds with SdkError<BatchStartViewerSessionRevocationError>

impl Client

pub fn create_channel(&self) -> CreateChannelFluentBuilder

Constructs a fluent builder for the CreateChannel operation.

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

    Channel name.

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

    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.

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

    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

    
    
  • authorized(bool) / set_authorized(Option<bool>):
    required: false
    

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

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

    Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: “” (empty string, recording is disabled).

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

    
    
  • insecure_ingest(bool) / set_insecure_ingest(Option<bool>):
    required: false
    

    Whether the channel allows insecure RTMP and SRT ingest. Default: false.

    
    
  • preset(TranscodePreset) / set_preset(Option<TranscodePreset>):
    required: false
    

    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (“”).

    
    
  • playback_restriction_policy_arn(impl Into<String>) / set_playback_restriction_policy_arn(Option<String>):
    required: false
    

    Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: “” (empty string, no playback restriction policy is applied).

    
    
  • multitrack_input_configuration(MultitrackInputConfiguration) / set_multitrack_input_configuration(Option<MultitrackInputConfiguration>):
    required: false
    

    Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.

    
    
  • container_format(ContainerFormat) / set_container_format(Option<ContainerFormat>):
    required: false
    

    Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.

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

  • stream_key(Option<StreamKey>):

• On failure, responds with SdkError<CreateChannelError>

impl Client

pub fn create_playback_restriction_policy( &self, ) -> CreatePlaybackRestrictionPolicyFluentBuilder

Constructs a fluent builder for the CreatePlaybackRestrictionPolicy operation.

• The fluent builder is configurable:
  • allowed_countries(impl Into<String>) / set_allowed_countries(Option<Vec::<String>>):
    required: false
    

    A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).

    
    
  • allowed_origins(impl Into<String>) / set_allowed_origins(Option<Vec::<String>>):
    required: false
    

    A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).

    
    
  • enable_strict_origin_enforcement(bool) / set_enable_strict_origin_enforcement(Option<bool>):
    required: false
    

    Whether channel playback is constrained by origin site. Default: false.

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

    Playback-restriction-policy name. The value does not need to be unique.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

    
    
• On success, responds with CreatePlaybackRestrictionPolicyOutput with field(s):
  • playback_restriction_policy(Option<PlaybackRestrictionPolicy>):

• On failure, responds with SdkError<CreatePlaybackRestrictionPolicyError>

impl Client

pub fn create_recording_configuration( &self, ) -> CreateRecordingConfigurationFluentBuilder

Constructs a fluent builder for the CreateRecordingConfiguration operation.

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

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

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

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

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

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

    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.

    
    
  • recording_reconnect_window_seconds(i32) / set_recording_reconnect_window_seconds(Option<i32>):
    required: false
    

    If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

    
    
  • rendition_configuration(RenditionConfiguration) / set_rendition_configuration(Option<RenditionConfiguration>):
    required: false
    

    Object that describes which renditions should be recorded for a stream.

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

impl Client

pub fn create_stream_key(&self) -> CreateStreamKeyFluentBuilder

Constructs a fluent builder for the CreateStreamKey operation.

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

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

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

    
    
• 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>

impl Client

pub fn delete_channel(&self) -> DeleteChannelFluentBuilder

Constructs a fluent builder for the DeleteChannel operation.

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

    ARN of the channel to be deleted.

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

impl Client

pub fn delete_playback_key_pair(&self) -> DeletePlaybackKeyPairFluentBuilder

Constructs a fluent builder for the DeletePlaybackKeyPair operation.

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

    ARN of the key pair to be deleted.

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

impl Client

pub fn delete_playback_restriction_policy( &self, ) -> DeletePlaybackRestrictionPolicyFluentBuilder

Constructs a fluent builder for the DeletePlaybackRestrictionPolicy operation.

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

    ARN of the playback restriction policy to be deleted.

    
    
• On success, responds with DeletePlaybackRestrictionPolicyOutput
• On failure, responds with SdkError<DeletePlaybackRestrictionPolicyError>

impl Client

pub fn delete_recording_configuration( &self, ) -> DeleteRecordingConfigurationFluentBuilder

Constructs a fluent builder for the DeleteRecordingConfiguration operation.

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

    ARN of the recording configuration to be deleted.

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

impl Client

pub fn delete_stream_key(&self) -> DeleteStreamKeyFluentBuilder

Constructs a fluent builder for the DeleteStreamKey operation.

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

    ARN of the stream key to be deleted.

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

impl Client

pub fn get_channel(&self) -> GetChannelFluentBuilder

Constructs a fluent builder for the GetChannel operation.

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

    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>

impl Client

pub fn get_playback_key_pair(&self) -> GetPlaybackKeyPairFluentBuilder

Constructs a fluent builder for the GetPlaybackKeyPair operation.

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

    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>

impl Client

pub fn get_playback_restriction_policy( &self, ) -> GetPlaybackRestrictionPolicyFluentBuilder

Constructs a fluent builder for the GetPlaybackRestrictionPolicy operation.

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

    ARN of the playback restriction policy to be returned.

    
    
• On success, responds with GetPlaybackRestrictionPolicyOutput with field(s):
  • playback_restriction_policy(Option<PlaybackRestrictionPolicy>):

• On failure, responds with SdkError<GetPlaybackRestrictionPolicyError>

impl Client

pub fn get_recording_configuration( &self, ) -> GetRecordingConfigurationFluentBuilder

Constructs a fluent builder for the GetRecordingConfiguration operation.

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

    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>

impl Client

pub fn get_stream(&self) -> GetStreamFluentBuilder

Constructs a fluent builder for the GetStream operation.

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

    Channel ARN for stream to be accessed.

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

• On failure, responds with SdkError<GetStreamError>

impl Client

pub fn get_stream_key(&self) -> GetStreamKeyFluentBuilder

Constructs a fluent builder for the GetStreamKey operation.

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

    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>

impl Client

pub fn get_stream_session(&self) -> GetStreamSessionFluentBuilder

Constructs a fluent builder for the GetStreamSession operation.

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

    ARN of the channel resource

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

    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>

impl Client

pub fn import_playback_key_pair(&self) -> ImportPlaybackKeyPairFluentBuilder

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>):
    required: true
    

    The public portion of a customer-generated key pair.

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

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

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Any tags provided with the request are added to the playback key pair tags. See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

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

• On failure, responds with SdkError<ImportPlaybackKeyPairError>

impl Client

pub fn list_channels(&self) -> ListChannelsFluentBuilder

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>):
    required: false
    

    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>):
    required: false
    

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

    
    
  • filter_by_playback_restriction_policy_arn(impl Into<String>) / set_filter_by_playback_restriction_policy_arn(Option<String>):
    required: false
    

    Filters the channel list to match the specified policy.

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

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of channels to return. Default: 100.

    
    
• On success, responds with ListChannelsOutput with field(s):
  • channels(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>

impl Client

pub fn list_playback_key_pairs(&self) -> ListPlaybackKeyPairsFluentBuilder

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>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of key pairs to return. Default: your service quota or 100, whichever is smaller.

    
    
• On success, responds with ListPlaybackKeyPairsOutput with field(s):
  • key_pairs(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>

impl Client

pub fn list_playback_restriction_policies( &self, ) -> ListPlaybackRestrictionPoliciesFluentBuilder

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

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

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of policies to return. Default: 1.

    
    
• On success, responds with ListPlaybackRestrictionPoliciesOutput with field(s):
  • playback_restriction_policies(Vec::<PlaybackRestrictionPolicySummary>):

    List of the matching policies.

  • 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<ListPlaybackRestrictionPoliciesError>

impl Client

pub fn list_recording_configurations( &self, ) -> ListRecordingConfigurationsFluentBuilder

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>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of recording configurations to return. Default: your service quota or 100, whichever is smaller.

    
    
• On success, responds with ListRecordingConfigurationsOutput with field(s):
  • recording_configurations(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>

impl Client

pub fn list_stream_keys(&self) -> ListStreamKeysFluentBuilder

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>):
    required: true
    

    Channel ARN used to filter the list.

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

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of streamKeys to return. Default: 1.

    
    
• On success, responds with ListStreamKeysOutput with field(s):
  • stream_keys(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>

impl Client

pub fn list_stream_sessions(&self) -> ListStreamSessionsFluentBuilder

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>):
    required: true
    

    Channel ARN used to filter the list.

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

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of streams to return. Default: 100.

    
    
• On success, responds with ListStreamSessionsOutput with field(s):
  • stream_sessions(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>

impl Client

pub fn list_streams(&self) -> ListStreamsFluentBuilder

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>):
    required: false
    

    Filters the stream list to match the specified criterion.

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

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of streams to return. Default: 100.

    
    
• On success, responds with ListStreamsOutput with field(s):
  • streams(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>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

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

    The ARN of the resource to be retrieved. The ARN must be URL-encoded.

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

    Tags attached to the resource. Array of maps, each of the form string:string (key:value).

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn put_metadata(&self) -> PutMetadataFluentBuilder

Constructs a fluent builder for the PutMetadata operation.

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

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

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

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

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

impl Client

pub fn start_viewer_session_revocation( &self, ) -> StartViewerSessionRevocationFluentBuilder

Constructs a fluent builder for the StartViewerSessionRevocation operation.

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

    The ARN of the channel associated with the viewer session to revoke.

    
    
  • viewer_id(impl Into<String>) / set_viewer_id(Option<String>):
    required: true
    

    The ID of the viewer associated with the viewer session to revoke. Do not use this field for personally identifying, confidential, or sensitive information.

    
    
  • viewer_session_versions_less_than_or_equal_to(i32) / set_viewer_session_versions_less_than_or_equal_to(Option<i32>):
    required: false
    

    An optional filter on which versions of the viewer session to revoke. All versions less than or equal to the specified version will be revoked. Default: 0.

    
    
• On success, responds with StartViewerSessionRevocationOutput
• On failure, responds with SdkError<StartViewerSessionRevocationError>

impl Client

pub fn stop_stream(&self) -> StopStreamFluentBuilder

Constructs a fluent builder for the StopStream operation.

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

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

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

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

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

    ARN of the resource for which tags are to be added or updated. The ARN must be URL-encoded.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    Array of tags to be added or updated. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

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

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

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

    ARN of the resource for which tags are to be removed. The ARN must be URL-encoded.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    Array of tags to be removed. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

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

impl Client

pub fn update_channel(&self) -> UpdateChannelFluentBuilder

Constructs a fluent builder for the UpdateChannel operation.

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

    ARN of the channel to be updated.

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

    Channel name.

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

    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers.

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

    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

    
    
  • authorized(bool) / set_authorized(Option<bool>):
    required: false
    

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

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

    Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled.

    
    
  • insecure_ingest(bool) / set_insecure_ingest(Option<bool>):
    required: false
    

    Whether the channel allows insecure RTMP and SRT ingest. Default: false.

    
    
  • preset(TranscodePreset) / set_preset(Option<TranscodePreset>):
    required: false
    

    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string (“”).

    
    
  • playback_restriction_policy_arn(impl Into<String>) / set_playback_restriction_policy_arn(Option<String>):
    required: false
    

    Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. If this is set to an empty string, playback restriction policy is disabled.

    
    
  • multitrack_input_configuration(MultitrackInputConfiguration) / set_multitrack_input_configuration(Option<MultitrackInputConfiguration>):
    required: false
    

    Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.

    
    
  • container_format(ContainerFormat) / set_container_format(Option<ContainerFormat>):
    required: false
    

    Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.

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

    Object specifying the updated channel.

• On failure, responds with SdkError<UpdateChannelError>

impl Client

pub fn update_playback_restriction_policy( &self, ) -> UpdatePlaybackRestrictionPolicyFluentBuilder

Constructs a fluent builder for the UpdatePlaybackRestrictionPolicy operation.

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

    ARN of the playback-restriction-policy to be updated.

    
    
  • allowed_countries(impl Into<String>) / set_allowed_countries(Option<Vec::<String>>):
    required: false
    

    A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).

    
    
  • allowed_origins(impl Into<String>) / set_allowed_origins(Option<Vec::<String>>):
    required: false
    

    A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).

    
    
  • enable_strict_origin_enforcement(bool) / set_enable_strict_origin_enforcement(Option<bool>):
    required: false
    

    Whether channel playback is constrained by origin site. Default: false.

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

    Playback-restriction-policy name. The value does not need to be unique.

    
    
• On success, responds with UpdatePlaybackRestrictionPolicyOutput with field(s):
  • playback_restriction_policy(Option<PlaybackRestrictionPolicy>):

    Object specifying the updated policy.

• On failure, responds with SdkError<UpdatePlaybackRestrictionPolicyError>

impl Client

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 and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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 the sleep_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 the http_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, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate 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.