Interface SsmGuiConnectClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface SsmGuiConnectClient
extends AwsClient

Service client for accessing AWS SSM-GUIConnect. This can be created using the static builder() method.

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:

• Setting up Amazon Web Services Systems Manager

• Connect to a Windows Server managed instance using Remote Desktop

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static SsmGuiConnectClientBuilder	builder()	Create a builder that can be used to configure and create a SsmGuiConnectClient.
static SsmGuiConnectClient	create()	Create a SsmGuiConnectClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DeleteConnectionRecordingPreferencesResponse	deleteConnectionRecordingPreferences(Consumer<DeleteConnectionRecordingPreferencesRequest.Builder> deleteConnectionRecordingPreferencesRequest)	Deletes the preferences for recording RDP connections.
default DeleteConnectionRecordingPreferencesResponse	deleteConnectionRecordingPreferences(DeleteConnectionRecordingPreferencesRequest deleteConnectionRecordingPreferencesRequest)	Deletes the preferences for recording RDP connections.
default GetConnectionRecordingPreferencesResponse	getConnectionRecordingPreferences(Consumer<GetConnectionRecordingPreferencesRequest.Builder> getConnectionRecordingPreferencesRequest)	Returns the preferences specified for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region.
default GetConnectionRecordingPreferencesResponse	getConnectionRecordingPreferences(GetConnectionRecordingPreferencesRequest getConnectionRecordingPreferencesRequest)	Returns the preferences specified for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region.
default SsmGuiConnectServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default UpdateConnectionRecordingPreferencesResponse	updateConnectionRecordingPreferences(Consumer<UpdateConnectionRecordingPreferencesRequest.Builder> updateConnectionRecordingPreferencesRequest)	Updates the preferences for recording RDP connections.
default UpdateConnectionRecordingPreferencesResponse	updateConnectionRecordingPreferences(UpdateConnectionRecordingPreferencesRequest updateConnectionRecordingPreferencesRequest)	Updates the preferences for recording RDP connections.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

deleteConnectionRecordingPreferences

default DeleteConnectionRecordingPreferencesResponse deleteConnectionRecordingPreferences(DeleteConnectionRecordingPreferencesRequest deleteConnectionRecordingPreferencesRequest)
                                                                                   throws ServiceQuotaExceededException,
ValidationException,
ResourceNotFoundException,
ConflictException,
ThrottlingException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SsmGuiConnectException

Deletes the preferences for recording RDP connections.

Parameters:

deleteConnectionRecordingPreferencesRequest -

Returns:

Result of the DeleteConnectionRecordingPreferences operation returned by the service.

See Also:

• AWS API Documentation

deleteConnectionRecordingPreferences

default DeleteConnectionRecordingPreferencesResponse deleteConnectionRecordingPreferences(Consumer<DeleteConnectionRecordingPreferencesRequest.Builder> deleteConnectionRecordingPreferencesRequest)
                                                                                   throws ServiceQuotaExceededException,
ValidationException,
ResourceNotFoundException,
ConflictException,
ThrottlingException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SsmGuiConnectException

Deletes the preferences for recording RDP connections.

This is a convenience which creates an instance of the DeleteConnectionRecordingPreferencesRequest.Builder avoiding the need to create one manually via DeleteConnectionRecordingPreferencesRequest.builder()

Parameters:

deleteConnectionRecordingPreferencesRequest - A Consumer that will call methods on DeleteConnectionRecordingPreferencesRequest.Builder to create a request.

Returns:

Result of the DeleteConnectionRecordingPreferences operation returned by the service.

See Also:

• AWS API Documentation

getConnectionRecordingPreferences

default GetConnectionRecordingPreferencesResponse getConnectionRecordingPreferences(GetConnectionRecordingPreferencesRequest getConnectionRecordingPreferencesRequest)
                                                                             throws ServiceQuotaExceededException,
ValidationException,
ResourceNotFoundException,
ConflictException,
ThrottlingException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SsmGuiConnectException

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

Parameters:

getConnectionRecordingPreferencesRequest -

Returns:

Result of the GetConnectionRecordingPreferences operation returned by the service.

See Also:

• AWS API Documentation

getConnectionRecordingPreferences

default GetConnectionRecordingPreferencesResponse getConnectionRecordingPreferences(Consumer<GetConnectionRecordingPreferencesRequest.Builder> getConnectionRecordingPreferencesRequest)
                                                                             throws ServiceQuotaExceededException,
ValidationException,
ResourceNotFoundException,
ConflictException,
ThrottlingException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SsmGuiConnectException

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

This is a convenience which creates an instance of the GetConnectionRecordingPreferencesRequest.Builder avoiding the need to create one manually via GetConnectionRecordingPreferencesRequest.builder()

Parameters:

getConnectionRecordingPreferencesRequest - A Consumer that will call methods on GetConnectionRecordingPreferencesRequest.Builder to create a request.

Returns:

Result of the GetConnectionRecordingPreferences operation returned by the service.

See Also:

• AWS API Documentation

updateConnectionRecordingPreferences

default UpdateConnectionRecordingPreferencesResponse updateConnectionRecordingPreferences(UpdateConnectionRecordingPreferencesRequest updateConnectionRecordingPreferencesRequest)
                                                                                   throws ServiceQuotaExceededException,
ValidationException,
ResourceNotFoundException,
ConflictException,
ThrottlingException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SsmGuiConnectException

Updates the preferences for recording RDP connections.

Parameters:

updateConnectionRecordingPreferencesRequest -

Returns:

Result of the UpdateConnectionRecordingPreferences operation returned by the service.

See Also:

• AWS API Documentation

updateConnectionRecordingPreferences

default UpdateConnectionRecordingPreferencesResponse updateConnectionRecordingPreferences(Consumer<UpdateConnectionRecordingPreferencesRequest.Builder> updateConnectionRecordingPreferencesRequest)
                                                                                   throws ServiceQuotaExceededException,
ValidationException,
ResourceNotFoundException,
ConflictException,
ThrottlingException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
SsmGuiConnectException

Updates the preferences for recording RDP connections.

This is a convenience which creates an instance of the UpdateConnectionRecordingPreferencesRequest.Builder avoiding the need to create one manually via UpdateConnectionRecordingPreferencesRequest.builder()

Parameters:

updateConnectionRecordingPreferencesRequest - A Consumer that will call methods on UpdateConnectionRecordingPreferencesRequest.Builder to create a request.

Returns:

Result of the UpdateConnectionRecordingPreferences operation returned by the service.

See Also:

• AWS API Documentation

create

static SsmGuiConnectClient create()

Create a SsmGuiConnectClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static SsmGuiConnectClientBuilder builder()

Create a builder that can be used to configure and create a SsmGuiConnectClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default SsmGuiConnectServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration