ssmguiconnect/aws.sdk.kotlin.services.ssmguiconnect/SsmGuiConnectClient

SsmGuiConnectClient

interface SsmGuiConnectClient : SdkClient

AWS Systems Manager GUI Connect

Systems Manager GUI Connect, a component of Fleet Manager, lets you connect to your Window Server-type Amazon Elastic Compute Cloud (Amazon EC2) instances using the Remote Desktop Protocol (RDP). GUI Connect, which is powered by Amazon DCV, provides you with secure connectivity to your Windows Server instances directly from the Systems Manager console. You can have up to four simultaneous connections in a single browser window. In the console, GUI Connect is also referred to as Fleet Manager Remote Desktop.

This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see the following user guide topics:

Types

Builder

class Builder : AbstractSdkClientBuilder<SsmGuiConnectClient.Config, SsmGuiConnectClient.Config.Builder, SsmGuiConnectClient>

Companion

object Companion : AbstractAwsSdkClientFactory<SsmGuiConnectClient.Config, SsmGuiConnectClient.Config.Builder, SsmGuiConnectClient, SsmGuiConnectClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: SsmGuiConnectClient.Config

SsmGuiConnectClient's configuration

Functions

deleteConnectionRecordingPreferences

abstract suspend fun deleteConnectionRecordingPreferences(input: DeleteConnectionRecordingPreferencesRequest = DeleteConnectionRecordingPreferencesRequest { }): DeleteConnectionRecordingPreferencesResponse

Deletes the preferences for recording RDP connections.

getConnectionRecordingPreferences

abstract suspend fun getConnectionRecordingPreferences(input: GetConnectionRecordingPreferencesRequest = GetConnectionRecordingPreferencesRequest { }): GetConnectionRecordingPreferencesResponse

Returns the preferences specified for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region.

updateConnectionRecordingPreferences

abstract suspend fun updateConnectionRecordingPreferences(input: UpdateConnectionRecordingPreferencesRequest): UpdateConnectionRecordingPreferencesResponse

Updates the preferences for recording RDP connections.

Inherited functions

expect abstract fun close()

deleteConnectionRecordingPreferences

inline suspend fun SsmGuiConnectClient.deleteConnectionRecordingPreferences(crossinline block: DeleteConnectionRecordingPreferencesRequest.Builder.() -> Unit): DeleteConnectionRecordingPreferencesResponse

Deletes the preferences for recording RDP connections.

getConnectionRecordingPreferences

inline suspend fun SsmGuiConnectClient.getConnectionRecordingPreferences(crossinline block: GetConnectionRecordingPreferencesRequest.Builder.() -> Unit): GetConnectionRecordingPreferencesResponse

Returns the preferences specified for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region.

updateConnectionRecordingPreferences

inline suspend fun SsmGuiConnectClient.updateConnectionRecordingPreferences(crossinline block: UpdateConnectionRecordingPreferencesRequest.Builder.() -> Unit): UpdateConnectionRecordingPreferencesResponse

Updates the preferences for recording RDP connections.

withConfig

fun SsmGuiConnectClient.withConfig(block: SsmGuiConnectClient.Config.Builder.() -> Unit): SsmGuiConnectClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.