SSMGUIConnect ************* Client ====== class SSMGUIConnect.Client A low-level client representing AWS SSM-GUIConnect 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 import boto3 client = boto3.client('ssm-guiconnect') These are the available methods: * can_paginate * close * delete_connection_recording_preferences * get_connection_recording_preferences * get_paginator * get_waiter * update_connection_recording_preferences SSMGUIConnect / Client / get_paginator get_paginator ************* SSMGUIConnect.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. SSMGUIConnect / Client / can_paginate can_paginate ************ SSMGUIConnect.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. SSMGUIConnect / Client / delete_connection_recording_preferences delete_connection_recording_preferences *************************************** SSMGUIConnect.Client.delete_connection_recording_preferences(**kwargs) Deletes the preferences for recording RDP connections. See also: AWS API Documentation **Request Syntax** response = client.delete_connection_recording_preferences( ClientToken='string' ) Parameters: **ClientToken** (*string*) -- User-provided idempotency token. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'ClientToken': 'string' } **Response Structure** * *(dict) --* * **ClientToken** *(string) --* Service-provided idempotency token. **Exceptions** * "SSMGUIConnect.Client.exceptions.ServiceQuotaExceededException" * "SSMGUIConnect.Client.exceptions.ValidationException" * "SSMGUIConnect.Client.exceptions.ResourceNotFoundException" * "SSMGUIConnect.Client.exceptions.ConflictException" * "SSMGUIConnect.Client.exceptions.ThrottlingException" * "SSMGUIConnect.Client.exceptions.InternalServerException" * "SSMGUIConnect.Client.exceptions.AccessDeniedException" SSMGUIConnect / Client / get_connection_recording_preferences get_connection_recording_preferences ************************************ SSMGUIConnect.Client.get_connection_recording_preferences() Returns the preferences specified for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region. See also: AWS API Documentation **Request Syntax** response = client.get_connection_recording_preferences() Return type: dict Returns: **Response Syntax** { 'ClientToken': 'string', 'ConnectionRecordingPreferences': { 'KMSKeyArn': 'string', 'RecordingDestinations': { 'S3Buckets': [ { 'BucketName': 'string', 'BucketOwner': 'string' }, ] } } } **Response Structure** * *(dict) --* * **ClientToken** *(string) --* Service-provided idempotency token. * **ConnectionRecordingPreferences** *(dict) --* The set of preferences used for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region. This includes details such as which S3 bucket recordings are stored in. * **KMSKeyArn** *(string) --* The ARN of a KMS key that is used to encrypt data while it is being processed by the service. This key must exist in the same Amazon Web Services Region as the node you start an RDP connection to. * **RecordingDestinations** *(dict) --* Determines where recordings of RDP connections are stored. * **S3Buckets** *(list) --* The S3 bucket where RDP connection recordings are stored. * *(dict) --* The S3 bucket where RDP connection recordings are stored. * **BucketName** *(string) --* The name of the S3 bucket where RDP connection recordings are stored. * **BucketOwner** *(string) --* The Amazon Web Services account number that owns the S3 bucket. **Exceptions** * "SSMGUIConnect.Client.exceptions.ServiceQuotaExceededException" * "SSMGUIConnect.Client.exceptions.ValidationException" * "SSMGUIConnect.Client.exceptions.ResourceNotFoundException" * "SSMGUIConnect.Client.exceptions.ConflictException" * "SSMGUIConnect.Client.exceptions.ThrottlingException" * "SSMGUIConnect.Client.exceptions.InternalServerException" * "SSMGUIConnect.Client.exceptions.AccessDeniedException" SSMGUIConnect / Client / get_waiter get_waiter ********** SSMGUIConnect.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" SSMGUIConnect / Client / update_connection_recording_preferences update_connection_recording_preferences *************************************** SSMGUIConnect.Client.update_connection_recording_preferences(**kwargs) Updates the preferences for recording RDP connections. See also: AWS API Documentation **Request Syntax** response = client.update_connection_recording_preferences( ClientToken='string', ConnectionRecordingPreferences={ 'KMSKeyArn': 'string', 'RecordingDestinations': { 'S3Buckets': [ { 'BucketName': 'string', 'BucketOwner': 'string' }, ] } } ) Parameters: * **ClientToken** (*string*) -- User-provided idempotency token. This field is autopopulated if not provided. * **ConnectionRecordingPreferences** (*dict*) -- **[REQUIRED]** The set of preferences used for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region. This includes details such as which S3 bucket recordings are stored in. * **KMSKeyArn** *(string) --* **[REQUIRED]** The ARN of a KMS key that is used to encrypt data while it is being processed by the service. This key must exist in the same Amazon Web Services Region as the node you start an RDP connection to. * **RecordingDestinations** *(dict) --* **[REQUIRED]** Determines where recordings of RDP connections are stored. * **S3Buckets** *(list) --* **[REQUIRED]** The S3 bucket where RDP connection recordings are stored. * *(dict) --* The S3 bucket where RDP connection recordings are stored. * **BucketName** *(string) --* **[REQUIRED]** The name of the S3 bucket where RDP connection recordings are stored. * **BucketOwner** *(string) --* **[REQUIRED]** The Amazon Web Services account number that owns the S3 bucket. Return type: dict Returns: **Response Syntax** { 'ClientToken': 'string', 'ConnectionRecordingPreferences': { 'KMSKeyArn': 'string', 'RecordingDestinations': { 'S3Buckets': [ { 'BucketName': 'string', 'BucketOwner': 'string' }, ] } } } **Response Structure** * *(dict) --* * **ClientToken** *(string) --* Service-provided idempotency token. * **ConnectionRecordingPreferences** *(dict) --* The set of preferences used for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region. This includes details such as which S3 bucket recordings are stored in. * **KMSKeyArn** *(string) --* The ARN of a KMS key that is used to encrypt data while it is being processed by the service. This key must exist in the same Amazon Web Services Region as the node you start an RDP connection to. * **RecordingDestinations** *(dict) --* Determines where recordings of RDP connections are stored. * **S3Buckets** *(list) --* The S3 bucket where RDP connection recordings are stored. * *(dict) --* The S3 bucket where RDP connection recordings are stored. * **BucketName** *(string) --* The name of the S3 bucket where RDP connection recordings are stored. * **BucketOwner** *(string) --* The Amazon Web Services account number that owns the S3 bucket. **Exceptions** * "SSMGUIConnect.Client.exceptions.ServiceQuotaExceededException" * "SSMGUIConnect.Client.exceptions.ValidationException" * "SSMGUIConnect.Client.exceptions.ResourceNotFoundException" * "SSMGUIConnect.Client.exceptions.ConflictException" * "SSMGUIConnect.Client.exceptions.ThrottlingException" * "SSMGUIConnect.Client.exceptions.InternalServerException" * "SSMGUIConnect.Client.exceptions.AccessDeniedException" SSMGUIConnect / Client / close close ***** SSMGUIConnect.Client.close() Closes underlying endpoint connections.