ChimeSDKVoice / Client / put_voice_connector_streaming_configuration

put_voice_connector_streaming_configuration#

ChimeSDKVoice.Client.put_voice_connector_streaming_configuration(**kwargs)#

Updates a Voice Connector’s streaming configuration settings.

Request Syntax

response = client.put_voice_connector_streaming_configuration(
    VoiceConnectorId='string',
    StreamingConfiguration={
        'DataRetentionInHours': 123,
        'Disabled': True|False,
        'StreamingNotificationTargets': [
            {
                'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
            },
        ],
        'MediaInsightsConfiguration': {
            'Disabled': True|False,
            'ConfigurationArn': 'string'
        }
    }
)

Parameters:

VoiceConnectorId (string) –
[REQUIRED]

The Voice Connector ID.
StreamingConfiguration (dict) –
[REQUIRED]

The streaming settings being updated.
- DataRetentionInHours (integer) – [REQUIRED]
  
  The amount of time, in hours, to the Kinesis data.
- Disabled (boolean) – [REQUIRED]
  
  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 configration as enabled or disabled.
  - ConfigurationArn (string) –
    
    The configuration’s ARN.

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 updated streaming settings.
  - 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 configration 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