ConnectCampaignServiceV2 / Client / get_connect_instance_config

get_connect_instance_config#

ConnectCampaignServiceV2.Client.get_connect_instance_config(**kwargs)#

Get the specific Connect instance config.

Request Syntax

response = client.get_connect_instance_config(
    connectInstanceId='string'
)

Parameters:

connectInstanceId (string) –

[REQUIRED]

Amazon Connect Instance Id

Return type:

dict

Returns:

Response Syntax

{
    'connectInstanceConfig': {
        'connectInstanceId': 'string',
        'serviceLinkedRoleArn': 'string',
        'encryptionConfig': {
            'enabled': True|False,
            'encryptionType': 'KMS',
            'keyArn': 'string'
        }
    }
}

Response Structure

(dict) –

The response for GetConnectInstanceConfig API.
- connectInstanceConfig (dict) –
  
  Instance config object
  - connectInstanceId (string) –
    
    Amazon Connect Instance Id
  - serviceLinkedRoleArn (string) –
    
    Service linked role arn
  - encryptionConfig (dict) –
    
    Encryption config for Connect Instance. Note that sensitive data will always be encrypted. If disabled, service will perform encryption with its own key. If enabled, a KMS key id needs to be provided and KMS charges will apply. KMS is only type supported
    - enabled (boolean) –
      
      Boolean to indicate if custom encryption has been enabled.
    - encryptionType (string) –
      
      Server-side encryption type.
    - keyArn (string) –
      
      KMS key id/arn for encryption config.

Exceptions

ConnectCampaignServiceV2.Client.exceptions.InternalServerException
ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundException
ConnectCampaignServiceV2.Client.exceptions.ValidationException
ConnectCampaignServiceV2.Client.exceptions.AccessDeniedException