Struct Client 

pub struct Client { /* private fields */ }

Client for Amazon Interactive Video Service RealTime

Client for invoking operations on Amazon Interactive Video Service RealTime. Each operation on Amazon Interactive Video Service RealTime 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_ivsrealtime::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_ivsrealtime::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 CreateEncoderConfiguration operation has a Client::create_encoder_configuration, 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_encoder_configuration()
    .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 create_encoder_configuration( &self, ) -> CreateEncoderConfigurationFluentBuilder

Constructs a fluent builder for the CreateEncoderConfiguration operation.

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

    Optional name to identify the resource.

    
    
  • video(Video) / set_video(Option<Video>):
    required: false
    

    Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps.

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

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

    
    
• On success, responds with CreateEncoderConfigurationOutput with field(s):
  • encoder_configuration(Option<EncoderConfiguration>):

    The EncoderConfiguration that was created.

• On failure, responds with SdkError<CreateEncoderConfigurationError>

impl Client

pub fn create_ingest_configuration( &self, ) -> CreateIngestConfigurationFluentBuilder

Constructs a fluent builder for the CreateIngestConfiguration operation.

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

    Optional name that can be specified for the IngestConfiguration being created.

    
    
  • stage_arn(impl Into<String>) / set_stage_arn(Option<String>):
    required: false
    

    ARN of the stage with which the IngestConfiguration is associated.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: false
    

    Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

    
    
  • attributes(impl Into<String>, impl Into<String>) / set_attributes(Option<HashMap::<String, String>>):
    required: false
    

    Application-provided attributes to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

    
    
  • ingest_protocol(IngestProtocol) / set_ingest_protocol(Option<IngestProtocol>):
    required: true
    

    Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.

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

    Whether the stage allows insecure RTMP ingest. This must be set to true, if ingestProtocol is set to RTMP. Default: false.

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

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

    
    
• On success, responds with CreateIngestConfigurationOutput with field(s):
  • ingest_configuration(Option<IngestConfiguration>):

    The IngestConfiguration that was created.

• On failure, responds with SdkError<CreateIngestConfigurationError>

impl Client

pub fn create_participant_token(&self) -> CreateParticipantTokenFluentBuilder

Constructs a fluent builder for the CreateParticipantToken operation.

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

    ARN of the stage to which this token is scoped.

    
    
  • duration(i32) / set_duration(Option<i32>):
    required: false
    

    Duration (in minutes), after which the token expires. Default: 720 (12 hours).

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: false
    

    Name that can be specified to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

    
    
  • attributes(impl Into<String>, impl Into<String>) / set_attributes(Option<HashMap::<String, String>>):
    required: false
    

    Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

    
    
  • capabilities(ParticipantTokenCapability) / set_capabilities(Option<Vec::<ParticipantTokenCapability>>):
    required: false
    

    Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.

    
    
• On success, responds with CreateParticipantTokenOutput with field(s):
  • participant_token(Option<ParticipantToken>):

    The participant token that was created.

• On failure, responds with SdkError<CreateParticipantTokenError>

impl Client

pub fn create_stage(&self) -> CreateStageFluentBuilder

Constructs a fluent builder for the CreateStage operation.

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

    Optional name that can be specified for the stage being created.

    
    
  • participant_token_configurations(ParticipantTokenConfiguration) / set_participant_token_configurations(Option<Vec::<ParticipantTokenConfiguration>>):
    required: false
    

    Array of participant token configuration objects to attach to the new stage.

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

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

    
    
  • auto_participant_recording_configuration(AutoParticipantRecordingConfiguration) / set_auto_participant_recording_configuration(Option<AutoParticipantRecordingConfiguration>):
    required: false
    

    Configuration object for individual participant recording, to attach to the new stage.

    
    
• On success, responds with CreateStageOutput with field(s):
  • stage(Option<Stage>):

    The stage that was created.

  • participant_tokens(Option<Vec::<ParticipantToken>>):

    Participant tokens attached to the stage. These correspond to the participants in the request.

• On failure, responds with SdkError<CreateStageError>

impl Client

pub fn create_storage_configuration( &self, ) -> CreateStorageConfigurationFluentBuilder

Constructs a fluent builder for the CreateStorageConfiguration operation.

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

    Storage configuration name. The value does not need to be unique.

    
    
  • s3(S3StorageConfiguration) / set_s3(Option<S3StorageConfiguration>):
    required: true
    

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

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

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

    
    
• On success, responds with CreateStorageConfigurationOutput with field(s):
  • storage_configuration(Option<StorageConfiguration>):

    The StorageConfiguration that was created.

• On failure, responds with SdkError<CreateStorageConfigurationError>

impl Client

pub fn delete_encoder_configuration( &self, ) -> DeleteEncoderConfigurationFluentBuilder

Constructs a fluent builder for the DeleteEncoderConfiguration operation.

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

    ARN of the EncoderConfiguration.

    
    
• On success, responds with DeleteEncoderConfigurationOutput
• On failure, responds with SdkError<DeleteEncoderConfigurationError>

impl Client

pub fn delete_ingest_configuration( &self, ) -> DeleteIngestConfigurationFluentBuilder

Constructs a fluent builder for the DeleteIngestConfiguration operation.

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

    ARN of the IngestConfiguration.

    
    
  • force(bool) / set_force(Option<bool>):
    required: false
    

    Optional field to force deletion of the IngestConfiguration. If this is set to true when a participant is actively publishing, the participant is disconnected from the stage, followed by deletion of the IngestConfiguration. Default: false.

    
    
• On success, responds with DeleteIngestConfigurationOutput
• On failure, responds with SdkError<DeleteIngestConfigurationError>

impl Client

pub fn delete_public_key(&self) -> DeletePublicKeyFluentBuilder

Constructs a fluent builder for the DeletePublicKey operation.

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

    ARN of the public key to be deleted.

    
    
• On success, responds with DeletePublicKeyOutput
• On failure, responds with SdkError<DeletePublicKeyError>

impl Client

pub fn delete_stage(&self) -> DeleteStageFluentBuilder

Constructs a fluent builder for the DeleteStage operation.

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

    ARN of the stage to be deleted.

    
    
• On success, responds with DeleteStageOutput
• On failure, responds with SdkError<DeleteStageError>

impl Client

pub fn delete_storage_configuration( &self, ) -> DeleteStorageConfigurationFluentBuilder

Constructs a fluent builder for the DeleteStorageConfiguration operation.

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

    ARN of the storage configuration to be deleted.

    
    
• On success, responds with DeleteStorageConfigurationOutput
• On failure, responds with SdkError<DeleteStorageConfigurationError>

impl Client

pub fn disconnect_participant(&self) -> DisconnectParticipantFluentBuilder

Constructs a fluent builder for the DisconnectParticipant operation.

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

    ARN of the stage to which the participant is attached.

    
    
  • participant_id(impl Into<String>) / set_participant_id(Option<String>):
    required: true
    

    Identifier of the participant to be disconnected. IVS assigns this; it is returned by CreateParticipantToken (for streams using WebRTC ingest) or CreateIngestConfiguration (for streams using RTMP ingest).

    
    
  • reason(impl Into<String>) / set_reason(Option<String>):
    required: false
    

    Description of why this participant is being disconnected.

    
    
• On success, responds with DisconnectParticipantOutput
• On failure, responds with SdkError<DisconnectParticipantError>

impl Client

pub fn get_composition(&self) -> GetCompositionFluentBuilder

Constructs a fluent builder for the GetComposition operation.

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

    ARN of the Composition resource.

    
    
• On success, responds with GetCompositionOutput with field(s):
  • composition(Option<Composition>):

    The Composition that was returned.

• On failure, responds with SdkError<GetCompositionError>

impl Client

pub fn get_encoder_configuration(&self) -> GetEncoderConfigurationFluentBuilder

Constructs a fluent builder for the GetEncoderConfiguration operation.

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

    ARN of the EncoderConfiguration resource.

    
    
• On success, responds with GetEncoderConfigurationOutput with field(s):
  • encoder_configuration(Option<EncoderConfiguration>):

    The EncoderConfiguration that was returned.

• On failure, responds with SdkError<GetEncoderConfigurationError>

impl Client

pub fn get_ingest_configuration(&self) -> GetIngestConfigurationFluentBuilder

Constructs a fluent builder for the GetIngestConfiguration operation.

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

    ARN of the ingest for which the information is to be retrieved.

    
    
• On success, responds with GetIngestConfigurationOutput with field(s):
  • ingest_configuration(Option<IngestConfiguration>):

    The IngestConfiguration that was returned.

• On failure, responds with SdkError<GetIngestConfigurationError>

impl Client

pub fn get_participant(&self) -> GetParticipantFluentBuilder

Constructs a fluent builder for the GetParticipant operation.

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

    Stage ARN.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    ID of a session within the stage.

    
    
  • participant_id(impl Into<String>) / set_participant_id(Option<String>):
    required: true
    

    Unique identifier for the participant. This is assigned by IVS and returned by CreateParticipantToken.

    
    
• On success, responds with GetParticipantOutput with field(s):
  • participant(Option<Participant>):

    The participant that is returned.

• On failure, responds with SdkError<GetParticipantError>

impl Client

pub fn get_public_key(&self) -> GetPublicKeyFluentBuilder

Constructs a fluent builder for the GetPublicKey operation.

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

    ARN of the public key for which the information is to be retrieved.

    
    
• On success, responds with GetPublicKeyOutput with field(s):
  • public_key(Option<PublicKey>):

    The public key that is returned.

• On failure, responds with SdkError<GetPublicKeyError>

impl Client

pub fn get_stage(&self) -> GetStageFluentBuilder

Constructs a fluent builder for the GetStage operation.

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

    ARN of the stage for which the information is to be retrieved.

    
    
• On success, responds with GetStageOutput with field(s):
  • stage(Option<Stage>):

    The stage that is returned.

• On failure, responds with SdkError<GetStageError>

impl Client

pub fn get_stage_session(&self) -> GetStageSessionFluentBuilder

Constructs a fluent builder for the GetStageSession operation.

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

    ARN of the stage for which the information is to be retrieved.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    ID of a session within the stage.

    
    
• On success, responds with GetStageSessionOutput with field(s):
  • stage_session(Option<StageSession>):

    The stage session that is returned.

• On failure, responds with SdkError<GetStageSessionError>

impl Client

pub fn get_storage_configuration(&self) -> GetStorageConfigurationFluentBuilder

Constructs a fluent builder for the GetStorageConfiguration operation.

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

    ARN of the storage configuration to be retrieved.

    
    
• On success, responds with GetStorageConfigurationOutput with field(s):
  • storage_configuration(Option<StorageConfiguration>):

    The StorageConfiguration that was returned.

• On failure, responds with SdkError<GetStorageConfigurationError>

impl Client

pub fn import_public_key(&self) -> ImportPublicKeyFluentBuilder

Constructs a fluent builder for the ImportPublicKey operation.

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

    The content of the public key to be imported.

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

    Name of the public key to be imported.

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

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

    
    
• On success, responds with ImportPublicKeyOutput with field(s):
  • public_key(Option<PublicKey>):

    The public key that was imported.

• On failure, responds with SdkError<ImportPublicKeyError>

impl Client

pub fn list_compositions(&self) -> ListCompositionsFluentBuilder

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

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

    Filters the Composition list to match the specified Stage ARN.

    
    
  • filter_by_encoder_configuration_arn(impl Into<String>) / set_filter_by_encoder_configuration_arn(Option<String>):
    required: false
    

    Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.

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

    The first Composition 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 results to return. Default: 100.

    
    
• On success, responds with ListCompositionsOutput with field(s):
  • compositions(Vec::<CompositionSummary>):

    List of the matching Compositions (summary information only).

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListCompositionsError>

impl Client

pub fn list_encoder_configurations( &self, ) -> ListEncoderConfigurationsFluentBuilder

Constructs a fluent builder for the ListEncoderConfigurations 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 encoder 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 results to return. Default: 100.

    
    
• On success, responds with ListEncoderConfigurationsOutput with field(s):
  • encoder_configurations(Vec::<EncoderConfigurationSummary>):

    List of the matching EncoderConfigurations (summary information only).

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListEncoderConfigurationsError>

impl Client

pub fn list_ingest_configurations( &self, ) -> ListIngestConfigurationsFluentBuilder

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

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

    Filters the response list to match the specified stage ARN. Only one filter (by stage ARN or by state) can be used at a time.

    
    
  • filter_by_state(IngestConfigurationState) / set_filter_by_state(Option<IngestConfigurationState>):
    required: false
    

    Filters the response list to match the specified state. Only one filter (by stage ARN or by state) can be used at a time.

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

    The first IngestConfiguration 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 results to return. Default: 50.

    
    
• On success, responds with ListIngestConfigurationsOutput with field(s):
  • ingest_configurations(Vec::<IngestConfigurationSummary>):

    List of the matching ingest configurations (summary information only).

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListIngestConfigurationsError>

impl Client

pub fn list_participant_events(&self) -> ListParticipantEventsFluentBuilder

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

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

    Stage ARN.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    ID of a session within the stage.

    
    
  • participant_id(impl Into<String>) / set_participant_id(Option<String>):
    required: true
    

    Unique identifier for this participant. This is assigned by IVS and returned by CreateParticipantToken.

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

    The first participant event 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 results to return. Default: 50.

    
    
• On success, responds with ListParticipantEventsOutput with field(s):
  • events(Vec::<Event>):

    List of the matching events.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListParticipantEventsError>

impl Client

pub fn list_participant_replicas(&self) -> ListParticipantReplicasFluentBuilder

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

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

    ARN of the stage where the participant is publishing.

    
    
  • participant_id(impl Into<String>) / set_participant_id(Option<String>):
    required: true
    

    Participant ID of the publisher that has been replicated. This is assigned by IVS and returned by CreateParticipantToken or the jti (JWT ID) used to create a self signed token.

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

    The first participant 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 results to return. Default: 50.

    
    
• On success, responds with ListParticipantReplicasOutput with field(s):
  • replicas(Vec::<ParticipantReplica>):

    List of all participant replicas.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListParticipantReplicasError>

impl Client

pub fn list_participants(&self) -> ListParticipantsFluentBuilder

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

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

    Stage ARN.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    ID of the session within the stage.

    
    
  • filter_by_user_id(impl Into<String>) / set_filter_by_user_id(Option<String>):
    required: false
    

    Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.

    
    
  • filter_by_published(bool) / set_filter_by_published(Option<bool>):
    required: false
    

    Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

    
    
  • filter_by_state(ParticipantState) / set_filter_by_state(Option<ParticipantState>):
    required: false
    

    Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

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

    The first participant 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 results to return. Default: 50.

    
    
  • filter_by_recording_state(ParticipantRecordingFilterByRecordingState) / set_filter_by_recording_state(Option<ParticipantRecordingFilterByRecordingState>):
    required: false
    

    Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

    
    
• On success, responds with ListParticipantsOutput with field(s):
  • participants(Vec::<ParticipantSummary>):

    List of the matching participants (summary information only).

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListParticipantsError>

impl Client

pub fn list_public_keys(&self) -> ListPublicKeysFluentBuilder

Constructs a fluent builder for the ListPublicKeys 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 public 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 results to return. Default: 50.

    
    
• On success, responds with ListPublicKeysOutput with field(s):
  • public_keys(Vec::<PublicKeySummary>):

    List of the matching public keys (summary information only).

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListPublicKeysError>

impl Client

pub fn list_stage_sessions(&self) -> ListStageSessionsFluentBuilder

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

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

    Stage ARN.

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

    The first stage session 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 results to return. Default: 50.

    
    
• On success, responds with ListStageSessionsOutput with field(s):
  • stage_sessions(Vec::<StageSessionSummary>):

    List of matching stage sessions.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListStageSessionsError>

impl Client

pub fn list_stages(&self) -> ListStagesFluentBuilder

Constructs a fluent builder for the ListStages 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 stage 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 results to return. Default: 50.

    
    
• On success, responds with ListStagesOutput with field(s):
  • stages(Vec::<StageSummary>):

    List of the matching stages (summary information only).

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListStagesError>

impl Client

pub fn list_storage_configurations( &self, ) -> ListStorageConfigurationsFluentBuilder

Constructs a fluent builder for the ListStorageConfigurations 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 storage 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 storage configurations to return. Default: your service quota or 100, whichever is smaller.

    
    
• On success, responds with ListStorageConfigurationsOutput with field(s):
  • storage_configurations(Vec::<StorageConfigurationSummary>):

    List of the matching storage configurations.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListStorageConfigurationsError>

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 start_composition(&self) -> StartCompositionFluentBuilder

Constructs a fluent builder for the StartComposition operation.

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

    ARN of the stage to be used for compositing.

    
    
  • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):
    required: false
    

    Idempotency token.

    
    
  • layout(LayoutConfiguration) / set_layout(Option<LayoutConfiguration>):
    required: false
    

    Layout object to configure composition parameters.

    
    
  • destinations(DestinationConfiguration) / set_destinations(Option<Vec::<DestinationConfiguration>>):
    required: true
    

    Array of destination configuration.

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

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

    
    
• On success, responds with StartCompositionOutput with field(s):
  • composition(Option<Composition>):

    The Composition that was created.

• On failure, responds with SdkError<StartCompositionError>

impl Client

pub fn start_participant_replication( &self, ) -> StartParticipantReplicationFluentBuilder

Constructs a fluent builder for the StartParticipantReplication operation.

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

    ARN of the stage where the participant is publishing.

    
    
  • destination_stage_arn(impl Into<String>) / set_destination_stage_arn(Option<String>):
    required: true
    

    ARN of the stage to which the participant will be replicated.

    
    
  • participant_id(impl Into<String>) / set_participant_id(Option<String>):
    required: true
    

    Participant ID of the publisher that will be replicated. This is assigned by IVS and returned by CreateParticipantToken or the jti (JWT ID) used to create a self signed token.

    
    
  • reconnect_window_seconds(i32) / set_reconnect_window_seconds(Option<i32>):
    required: false
    

    If the participant disconnects and then reconnects within the specified interval, replication will continue to be ACTIVE. Default: 0.

    
    
  • attributes(impl Into<String>, impl Into<String>) / set_attributes(Option<HashMap::<String, String>>):
    required: false
    

    Application-provided attributes to set on the replicated participant in the destination stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

    These attributes are merged with any attributes set for this participant when creating the token. If there is overlap in keys, the values in these attributes are replaced.

    
    
• On success, responds with StartParticipantReplicationOutput with field(s):
  • access_control_allow_origin(Option<String>):

  • access_control_expose_headers(Option<String>):

  • cache_control(Option<String>):

  • content_security_policy(Option<String>):

  • strict_transport_security(Option<String>):

  • x_content_type_options(Option<String>):

  • x_frame_options(Option<String>):

• On failure, responds with SdkError<StartParticipantReplicationError>

impl Client

pub fn stop_composition(&self) -> StopCompositionFluentBuilder

Constructs a fluent builder for the StopComposition operation.

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

    ARN of the Composition.

    
    
• On success, responds with StopCompositionOutput
• On failure, responds with SdkError<StopCompositionError>

impl Client

pub fn stop_participant_replication( &self, ) -> StopParticipantReplicationFluentBuilder

Constructs a fluent builder for the StopParticipantReplication operation.

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

    ARN of the stage where the participant is publishing.

    
    
  • destination_stage_arn(impl Into<String>) / set_destination_stage_arn(Option<String>):
    required: true
    

    ARN of the stage where the participant has been replicated.

    
    
  • participant_id(impl Into<String>) / set_participant_id(Option<String>):
    required: true
    

    Participant ID of the publisher that has been replicated. This is assigned by IVS and returned by CreateParticipantToken or the jti (JWT ID) used to create a self signed token.

    
    
• On success, responds with StopParticipantReplicationOutput with field(s):
  • access_control_allow_origin(Option<String>):

  • access_control_expose_headers(Option<String>):

  • cache_control(Option<String>):

  • content_security_policy(Option<String>):

  • strict_transport_security(Option<String>):

  • x_content_type_options(Option<String>):

  • x_frame_options(Option<String>):

• On failure, responds with SdkError<StopParticipantReplicationError>

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
    

    The ARN of the resource to be tagged. 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 AWS Resources and Tag Editor for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no constraints on tags 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
    

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

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

    Array of tag keys (strings) for the tags to be removed. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no constraints on tags beyond what is documented there.

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

impl Client

pub fn update_ingest_configuration( &self, ) -> UpdateIngestConfigurationFluentBuilder

Constructs a fluent builder for the UpdateIngestConfiguration operation.

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

    ARN of the IngestConfiguration, for which the related stage ARN needs to be updated.

    
    
  • stage_arn(impl Into<String>) / set_stage_arn(Option<String>):
    required: false
    

    Stage ARN that needs to be updated.

    
    
• On success, responds with UpdateIngestConfigurationOutput with field(s):
  • ingest_configuration(Option<IngestConfiguration>):

    The updated IngestConfiguration.

• On failure, responds with SdkError<UpdateIngestConfigurationError>

impl Client

pub fn update_stage(&self) -> UpdateStageFluentBuilder

Constructs a fluent builder for the UpdateStage operation.

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

    ARN of the stage to be updated.

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

    Name of the stage to be updated.

    
    
  • auto_participant_recording_configuration(AutoParticipantRecordingConfiguration) / set_auto_participant_recording_configuration(Option<AutoParticipantRecordingConfiguration>):
    required: false
    

    Configuration object for individual participant recording, to attach to the stage. Note that this cannot be updated while recording is active.

    
    
• On success, responds with UpdateStageOutput with field(s):
  • stage(Option<Stage>):

    The updated stage.

• On failure, responds with SdkError<UpdateStageError>

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.