Skip to content

install_to_remote_access_session

install_to_remote_access_session(
    remote_access_session_arn: AmazonResourceName,
    app_arn: AmazonResourceName,
    *,
    config_overrides: Optional[DeviceFarmClientConfig] = None,
) -> InstallToRemoteAccessSessionResult

Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.

Parameters:

  • remote_access_session_arn (AmazonResourceName) –

    The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.

  • app_arn (AmazonResourceName) –

    The ARN of the app about which you are requesting information.

Raises:

Examples:

To install to a remote access session The following example installs a specific app to a device in a specific remote access session.

>>> client.install_to_remote_access_session(remote_access_session_arn='arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456', app_arn='arn:aws:devicefarm:us-west-2:123456789101:app:EXAMPLE-GUID-123-456')
Source code in docs_src/capo_device_farm/_services/device_farm.py
def install_to_remote_access_session(
    self,
    remote_access_session_arn: "capo_device_farm.types.amazon_resource_name.AmazonResourceName",
    app_arn: "capo_device_farm.types.amazon_resource_name.AmazonResourceName",
    *,
    config_overrides: Optional[DeviceFarmClientConfig] = None,
) -> "capo_device_farm.types.install_to_remote_access_session_result.InstallToRemoteAccessSessionResult":
    """<p>Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.</p>

    Args:
        remote_access_session_arn: <p>The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.</p>
        app_arn: <p>The ARN of the app about which you are requesting information.</p>

    Raises:
        capo_device_farm.errors.argument_exception.ArgumentException: <p>An invalid argument was specified.</p>
        capo_device_farm.errors.limit_exceeded_exception.LimitExceededException: <p>A limit was exceeded.</p>
        capo_device_farm.errors.not_found_exception.NotFoundException: <p>The specified entity was not found.</p>
        capo_device_farm.errors.service_account_exception.ServiceAccountException: <p>There was a problem with the service account.</p>
        capo_device_farm.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To install to a remote access session
        The following example installs a specific app to a device in a specific remote access session.

        >>> client.install_to_remote_access_session(remote_access_session_arn='arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456', app_arn='arn:aws:devicefarm:us-west-2:123456789101:app:EXAMPLE-GUID-123-456')
    """

    def _handler(
        req: "OperationRequest[capo_device_farm.types.install_to_remote_access_session_request.InstallToRemoteAccessSessionRequest]",
    ) -> OperationResponse[
        "capo_device_farm.types.install_to_remote_access_session_result.InstallToRemoteAccessSessionResult"
    ]:
        import capo_device_farm._operations.device_farm_20150623.install_to_remote_access_session

        output, http_response = (
            capo_device_farm._operations.device_farm_20150623.install_to_remote_access_session.install_to_remote_access_session(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_device_farm.types.install_to_remote_access_session_result.InstallToRemoteAccessSessionResult",
    ) -> dict[str, Any]:
        import capo_device_farm.types.install_to_remote_access_session_result

        return capo_device_farm.types.install_to_remote_access_session_result.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "InstallToRemoteAccessSession", redact_output=_redact_output
        ),
    )
    input_: capo_device_farm.types.install_to_remote_access_session_request.InstallToRemoteAccessSessionRequest = {
        "remote_access_session_arn": remote_access_session_arn,
        "app_arn": app_arn,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output