SSMGUIConnect / Client / update_connection_recording_preferences

update_connection_recording_preferences¶

SSMGUIConnect.Client.update_connection_recording_preferences(**kwargs)¶

Updates the preferences for recording RDP connections.

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