aws_sdk_devicefarm/client/

create_remote_access_session.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateRemoteAccessSession`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`project_arn(impl Into<String>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::project_arn) / [`set_project_arn(Option<String>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::set_project_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.</p><br>
    ///   - [`device_arn(impl Into<String>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::device_arn) / [`set_device_arn(Option<String>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::set_device_arn):<br>required: **true**<br><p>The ARN of the device for which you want to create a remote access session.</p><br>
    ///   - [`instance_arn(impl Into<String>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::instance_arn) / [`set_instance_arn(Option<String>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::set_instance_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.</p><br>
    ///   - [`ssh_public_key(impl Into<String>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::ssh_public_key) / [`set_ssh_public_key(Option<String>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::set_ssh_public_key):<br>required: **false**<br><p>Ignored. The public key of the <code>ssh</code> key pair you want to use for connecting to remote devices in your remote debugging session. This key is required only if <code>remoteDebugEnabled</code> is set to <code>true</code>.</p> <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>.</p><br>
    ///   - [`remote_debug_enabled(bool)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::remote_debug_enabled) / [`set_remote_debug_enabled(Option<bool>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::set_remote_debug_enabled):<br>required: **false**<br><p>Set to <code>true</code> if you want to access devices remotely for debugging in your remote access session.</p> <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>.</p><br>
    ///   - [`remote_record_enabled(bool)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::remote_record_enabled) / [`set_remote_record_enabled(Option<bool>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::set_remote_record_enabled):<br>required: **false**<br><p>Set to <code>true</code> to enable remote recording for the remote access session.</p><br>
    ///   - [`remote_record_app_arn(impl Into<String>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::remote_record_app_arn) / [`set_remote_record_app_arn(Option<String>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::set_remote_record_app_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.</p><br>
    ///   - [`name(impl Into<String>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::set_name):<br>required: **false**<br><p>The name of the remote access session to create.</p><br>
    ///   - [`client_id(impl Into<String>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::client_id) / [`set_client_id(Option<String>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::set_client_id):<br>required: **false**<br><p>Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same <code>clientId</code> value in each call to <code>CreateRemoteAccessSession</code>. This identifier is required only if <code>remoteDebugEnabled</code> is set to <code>true</code>.</p> <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>.</p><br>
    ///   - [`configuration(CreateRemoteAccessSessionConfiguration)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::configuration) / [`set_configuration(Option<CreateRemoteAccessSessionConfiguration>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::set_configuration):<br>required: **false**<br><p>The configuration information for the remote access session request.</p><br>
    ///   - [`interaction_mode(InteractionMode)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::interaction_mode) / [`set_interaction_mode(Option<InteractionMode>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::set_interaction_mode):<br>required: **false**<br><p>The interaction mode of the remote access session. Valid values are:</p> <ul>  <li>   <p>INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.</p></li>  <li>   <p>NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.</p></li>  <li>   <p>VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.</p></li> </ul><br>
    ///   - [`skip_app_resign(bool)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::skip_app_resign) / [`set_skip_app_resign(Option<bool>)`](crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::set_skip_app_resign):<br>required: **false**<br><p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.</p> <p>For more information on how Device Farm modifies your uploads during tests, see <a href="http://aws.amazon.com/device-farm/faqs/">Do you modify my app?</a></p><br>
    /// - On success, responds with [`CreateRemoteAccessSessionOutput`](crate::operation::create_remote_access_session::CreateRemoteAccessSessionOutput) with field(s):
    ///   - [`remote_access_session(Option<RemoteAccessSession>)`](crate::operation::create_remote_access_session::CreateRemoteAccessSessionOutput::remote_access_session): <p>A container that describes the remote access session when the request to create a remote access session is sent.</p>
    /// - On failure, responds with [`SdkError<CreateRemoteAccessSessionError>`](crate::operation::create_remote_access_session::CreateRemoteAccessSessionError)
    pub fn create_remote_access_session(&self) -> crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder {
        crate::operation::create_remote_access_session::builders::CreateRemoteAccessSessionFluentBuilder::new(self.handle.clone())
    }
}