AWS API Changes

2020/05/19 - Amazon Chime - 2 updated api methods

Changes You can now receive Voice Connector call events through SNS or SQS.

GetVoiceConnectorStreamingConfiguration (updated)

Link ¶
Changes (response)

{'StreamingConfiguration': {'StreamingNotificationTargets': [{'NotificationTarget': 'EventBridge '
                                                                                    '| '
                                                                                    'SNS '
                                                                                    '| '
                                                                                    'SQS'}]}}

Retrieves the streaming configuration details for the specified Amazon Chime 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.

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_streaming_configuration(
    VoiceConnectorId='string'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

The Amazon Chime Voice Connector ID.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- StreamingConfiguration (dict) --
  
  The streaming configuration details.
  - DataRetentionInHours (integer) --
    
    The retention period, in hours, for the Amazon Kinesis data.
  - Disabled (boolean) --
    
    When true, media streaming to Amazon Kinesis is turned off.
  - StreamingNotificationTargets (list) --
    
    The streaming notification targets.
    - (dict) --
      
      The targeted recipient for a streaming configuration notification.
      - NotificationTarget (string) --
        
        The streaming notification target.

PutVoiceConnectorStreamingConfiguration (updated)

Link ¶
Changes (both)

{'StreamingConfiguration': {'StreamingNotificationTargets': [{'NotificationTarget': 'EventBridge '
                                                                                    '| '
                                                                                    'SNS '
                                                                                    '| '
                                                                                    'SQS'}]}}

Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Amazon Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.

See also: AWS API Documentation

Request Syntax

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

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

The Amazon Chime Voice Connector ID.

type StreamingConfiguration

dict

param StreamingConfiguration

[REQUIRED]

The streaming configuration details to add.

DataRetentionInHours (integer) -- [REQUIRED]

The retention period, in hours, for the Amazon Kinesis data.
Disabled (boolean) --

When true, media streaming to Amazon Kinesis is turned off.
StreamingNotificationTargets (list) --

The streaming notification targets.
- (dict) --
  
  The targeted recipient for a streaming configuration notification.
  - NotificationTarget (string) -- [REQUIRED]
    
    The streaming notification target.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- StreamingConfiguration (dict) --
  
  The updated streaming configuration details.
  - DataRetentionInHours (integer) --
    
    The retention period, in hours, for the Amazon Kinesis data.
  - Disabled (boolean) --
    
    When true, media streaming to Amazon Kinesis is turned off.
  - StreamingNotificationTargets (list) --
    
    The streaming notification targets.
    - (dict) --
      
      The targeted recipient for a streaming configuration notification.
      - NotificationTarget (string) --
        
        The streaming notification target.