aws_sdk_gameliftstreams/client/
create_stream_session_connection.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateStreamSessionConnection`](crate::operation::create_stream_session_connection::builders::CreateStreamSessionConnectionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`client_token(impl Into<String>)`](crate::operation::create_stream_session_connection::builders::CreateStreamSessionConnectionFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_stream_session_connection::builders::CreateStreamSessionConnectionFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field.</p><br>
7    ///   - [`identifier(impl Into<String>)`](crate::operation::create_stream_session_connection::builders::CreateStreamSessionConnectionFluentBuilder::identifier) / [`set_identifier(Option<String>)`](crate::operation::create_stream_session_connection::builders::CreateStreamSessionConnectionFluentBuilder::set_identifier):<br>required: **true**<br><p><a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. Example ID: <code>sg-1AB2C3De4</code>.</p> <p>The stream group that you want to run this stream session with. The stream group must be in <code>ACTIVE</code> status.</p><br>
8    ///   - [`stream_session_identifier(impl Into<String>)`](crate::operation::create_stream_session_connection::builders::CreateStreamSessionConnectionFluentBuilder::stream_session_identifier) / [`set_stream_session_identifier(Option<String>)`](crate::operation::create_stream_session_connection::builders::CreateStreamSessionConnectionFluentBuilder::set_stream_session_identifier):<br>required: **true**<br><p><a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream session resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567</code>. Example ID: <code>ABC123def4567</code>.</p> <p>The stream session must be in <code>PENDING_CLIENT_RECONNECTION</code> or <code>ACTIVE</code> status.</p><br>
9    ///   - [`signal_request(impl Into<String>)`](crate::operation::create_stream_session_connection::builders::CreateStreamSessionConnectionFluentBuilder::signal_request) / [`set_signal_request(Option<String>)`](crate::operation::create_stream_session_connection::builders::CreateStreamSessionConnectionFluentBuilder::set_signal_request):<br>required: **true**<br><p>A WebRTC ICE offer string to use when initializing a WebRTC connection. The offer is a very long JSON string. Provide the string as a text value in quotes. The offer must be newly generated, not the same offer provided to <code>StartStreamSession</code>.</p><br>
10    /// - On success, responds with [`CreateStreamSessionConnectionOutput`](crate::operation::create_stream_session_connection::CreateStreamSessionConnectionOutput) with field(s):
11    ///   - [`signal_response(Option<String>)`](crate::operation::create_stream_session_connection::CreateStreamSessionConnectionOutput::signal_response): <p>The WebRTC answer string that the stream server generates in response to the <code>SignalRequest</code>.</p>
12    /// - On failure, responds with [`SdkError<CreateStreamSessionConnectionError>`](crate::operation::create_stream_session_connection::CreateStreamSessionConnectionError)
13    pub fn create_stream_session_connection(
14        &self,
15    ) -> crate::operation::create_stream_session_connection::builders::CreateStreamSessionConnectionFluentBuilder {
16        crate::operation::create_stream_session_connection::builders::CreateStreamSessionConnectionFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_gameliftstreams/client/create_stream_session_connection.rs

aws_sdk_gameliftstreams/client/
create_stream_session_connection.rs
