ChimeSDKVoice / Client / get_voice_connector_streaming_configuration

get_voice_connector_streaming_configuration#

ChimeSDKVoice.Client.get_voice_connector_streaming_configuration(**kwargs)#

Retrieves the streaming configuration details for the specified Amazon Chime SDK Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

Request Syntax

response = client.get_voice_connector_streaming_configuration(
    VoiceConnectorId='string'
)

Parameters:

VoiceConnectorId (string) –

[REQUIRED]

The Voice Connector ID.

Return type:

dict

Returns:

Response Syntax

{
    'StreamingConfiguration': {
        'DataRetentionInHours': 123,
        'Disabled': True|False,
        'StreamingNotificationTargets': [
            {
                'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
            },
        ],
        'MediaInsightsConfiguration': {
            'Disabled': True|False,
            'ConfigurationArn': 'string'
        }
    }
}

Response Structure

(dict) –
- StreamingConfiguration (dict) –
  
  The details of the streaming configuration.
  - DataRetentionInHours (integer) –
    
    The amount of time, in hours, to the Kinesis data.
  - Disabled (boolean) –
    
    When true, streaming to Kinesis is off.
  - StreamingNotificationTargets (list) –
    
    The streaming notification targets.
    - (dict) –
      
      The target recipient for a streaming configuration notification.
      - NotificationTarget (string) –
        
        The streaming notification target.
  - MediaInsightsConfiguration (dict) –
    
    The call analytics configuration.
    - Disabled (boolean) –
      
      Denotes the configuration as enabled or disabled.
    - ConfigurationArn (string) –
      
      The configuration’s ARN.

Exceptions

ChimeSDKVoice.Client.exceptions.UnauthorizedClientException
ChimeSDKVoice.Client.exceptions.NotFoundException
ChimeSDKVoice.Client.exceptions.ForbiddenException
ChimeSDKVoice.Client.exceptions.BadRequestException
ChimeSDKVoice.Client.exceptions.ThrottledClientException
ChimeSDKVoice.Client.exceptions.ServiceUnavailableException
ChimeSDKVoice.Client.exceptions.ServiceFailureException