AWS API Changes

2021/10/22 - Amazon Chime - 8 updated api methods

Changes Chime VoiceConnector and VoiceConnectorGroup APIs will now return an ARN.

CreateVoiceConnector (updated)

Link ¶
Changes (response)

{'VoiceConnector': {'VoiceConnectorArn': 'string'}}

Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.

Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.

See also: AWS API Documentation

Request Syntax

client.create_voice_connector(
    Name='string',
    AwsRegion='us-east-1'|'us-west-2',
    RequireEncryption=True|False
)

type Name

string

param Name

[REQUIRED]

The name of the Amazon Chime Voice Connector.

type AwsRegion

string

param AwsRegion

The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1 .

type RequireEncryption

boolean

param RequireEncryption

[REQUIRED]

When enabled, requires encryption for the Amazon Chime Voice Connector.

rtype

dict

returns

Response Syntax

{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        'AwsRegion': 'us-east-1'|'us-west-2',
        'Name': 'string',
        'OutboundHostName': 'string',
        'RequireEncryption': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorArn': 'string'
    }
}

Response Structure

(dict) --
- VoiceConnector (dict) --
  
  The Amazon Chime Voice Connector details.
  - VoiceConnectorId (string) --
    
    The Amazon Chime Voice Connector ID.
  - AwsRegion (string) --
    
    The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1 .
  - Name (string) --
    
    The name of the Amazon Chime Voice Connector.
  - OutboundHostName (string) --
    
    The outbound host name for the Amazon Chime Voice Connector.
  - RequireEncryption (boolean) --
    
    Designates whether encryption is required for the Amazon Chime Voice Connector.
  - CreatedTimestamp (datetime) --
    
    The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
  - VoiceConnectorArn (string) --
    
    The ARN of the specified Amazon Chime Voice Connector.

CreateVoiceConnectorGroup (updated)

Link ¶
Changes (response)

{'VoiceConnectorGroup': {'VoiceConnectorGroupArn': 'string'}}

Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request.

You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

See also: AWS API Documentation

Request Syntax

client.create_voice_connector_group(
    Name='string',
    VoiceConnectorItems=[
        {
            'VoiceConnectorId': 'string',
            'Priority': 123
        },
    ]
)

type Name

string

param Name

[REQUIRED]

The name of the Amazon Chime Voice Connector group.

type VoiceConnectorItems

list

param VoiceConnectorItems

The Amazon Chime Voice Connectors to route inbound calls to.

(dict) --

For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
- VoiceConnectorId (string) -- [REQUIRED]
  
  The Amazon Chime Voice Connector ID.
- Priority (integer) -- [REQUIRED]
  
  The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

rtype

dict

returns

Response Syntax

{
    'VoiceConnectorGroup': {
        'VoiceConnectorGroupId': 'string',
        'Name': 'string',
        'VoiceConnectorItems': [
            {
                'VoiceConnectorId': 'string',
                'Priority': 123
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorGroupArn': 'string'
    }
}

Response Structure

(dict) --
- VoiceConnectorGroup (dict) --
  
  The Amazon Chime Voice Connector group details.
  - VoiceConnectorGroupId (string) --
    
    The Amazon Chime Voice Connector group ID.
  - Name (string) --
    
    The name of the Amazon Chime Voice Connector group.
  - VoiceConnectorItems (list) --
    
    The Amazon Chime Voice Connectors to which to route inbound calls.
    - (dict) --
      
      For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
      - VoiceConnectorId (string) --
        
        The Amazon Chime Voice Connector ID.
      - Priority (integer) --
        
        The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
  - CreatedTimestamp (datetime) --
    
    The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
  - VoiceConnectorGroupArn (string) --
    
    The ARN of the specified Amazon Chime Voice Connector group.

GetVoiceConnector (updated)

Link ¶
Changes (response)

{'VoiceConnector': {'VoiceConnectorArn': 'string'}}

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

See also: AWS API Documentation

Request Syntax

client.get_voice_connector(
    VoiceConnectorId='string'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

The Amazon Chime Voice Connector ID.

rtype

dict

returns

Response Syntax

{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        'AwsRegion': 'us-east-1'|'us-west-2',
        'Name': 'string',
        'OutboundHostName': 'string',
        'RequireEncryption': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorArn': 'string'
    }
}

Response Structure

(dict) --
- VoiceConnector (dict) --
  
  The Amazon Chime Voice Connector details.
  - VoiceConnectorId (string) --
    
    The Amazon Chime Voice Connector ID.
  - AwsRegion (string) --
    
    The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1 .
  - Name (string) --
    
    The name of the Amazon Chime Voice Connector.
  - OutboundHostName (string) --
    
    The outbound host name for the Amazon Chime Voice Connector.
  - RequireEncryption (boolean) --
    
    Designates whether encryption is required for the Amazon Chime Voice Connector.
  - CreatedTimestamp (datetime) --
    
    The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
  - VoiceConnectorArn (string) --
    
    The ARN of the specified Amazon Chime Voice Connector.

GetVoiceConnectorGroup (updated)

Link ¶
Changes (response)

{'VoiceConnectorGroup': {'VoiceConnectorGroupArn': 'string'}}

Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems .

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_group(
    VoiceConnectorGroupId='string'
)

type VoiceConnectorGroupId

string

param VoiceConnectorGroupId

[REQUIRED]

The Amazon Chime Voice Connector group ID.

rtype

dict

returns

Response Syntax

{
    'VoiceConnectorGroup': {
        'VoiceConnectorGroupId': 'string',
        'Name': 'string',
        'VoiceConnectorItems': [
            {
                'VoiceConnectorId': 'string',
                'Priority': 123
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorGroupArn': 'string'
    }
}

Response Structure

(dict) --
- VoiceConnectorGroup (dict) --
  
  The Amazon Chime Voice Connector group details.
  - VoiceConnectorGroupId (string) --
    
    The Amazon Chime Voice Connector group ID.
  - Name (string) --
    
    The name of the Amazon Chime Voice Connector group.
  - VoiceConnectorItems (list) --
    
    The Amazon Chime Voice Connectors to which to route inbound calls.
    - (dict) --
      
      For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
      - VoiceConnectorId (string) --
        
        The Amazon Chime Voice Connector ID.
      - Priority (integer) --
        
        The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
  - CreatedTimestamp (datetime) --
    
    The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
  - VoiceConnectorGroupArn (string) --
    
    The ARN of the specified Amazon Chime Voice Connector group.

ListVoiceConnectorGroups (updated)

Link ¶
Changes (response)

{'VoiceConnectorGroups': {'VoiceConnectorGroupArn': 'string'}}

Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.

See also: AWS API Documentation

Request Syntax

client.list_voice_connector_groups(
    NextToken='string',
    MaxResults=123
)

type NextToken

string

param NextToken

The token to use to retrieve the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call.

rtype

dict

returns

Response Syntax

{
    'VoiceConnectorGroups': [
        {
            'VoiceConnectorGroupId': 'string',
            'Name': 'string',
            'VoiceConnectorItems': [
                {
                    'VoiceConnectorId': 'string',
                    'Priority': 123
                },
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'VoiceConnectorGroupArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- VoiceConnectorGroups (list) --
  
  The details of the Amazon Chime Voice Connector groups.
  - (dict) --
    
    The Amazon Chime Voice Connector group configuration, including associated Amazon Chime Voice Connectors. You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.
    - VoiceConnectorGroupId (string) --
      
      The Amazon Chime Voice Connector group ID.
    - Name (string) --
      
      The name of the Amazon Chime Voice Connector group.
    - VoiceConnectorItems (list) --
      
      The Amazon Chime Voice Connectors to which to route inbound calls.
      - (dict) --
        
        For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
        
        VoiceConnectorId (string) --
        
        The Amazon Chime Voice Connector ID.
        
        Priority (integer) --
        
        The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
    - CreatedTimestamp (datetime) --
      
      The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.
    - UpdatedTimestamp (datetime) --
      
      The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
    - VoiceConnectorGroupArn (string) --
      
      The ARN of the specified Amazon Chime Voice Connector group.
- NextToken (string) --
  
  The token to use to retrieve the next page of results.

ListVoiceConnectors (updated)

Link ¶
Changes (response)

{'VoiceConnectors': {'VoiceConnectorArn': 'string'}}

Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

See also: AWS API Documentation

Request Syntax

client.list_voice_connectors(
    NextToken='string',
    MaxResults=123
)

type NextToken

string

param NextToken

The token to use to retrieve the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call.

rtype

dict

returns

Response Syntax

{
    'VoiceConnectors': [
        {
            'VoiceConnectorId': 'string',
            'AwsRegion': 'us-east-1'|'us-west-2',
            'Name': 'string',
            'OutboundHostName': 'string',
            'RequireEncryption': True|False,
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'VoiceConnectorArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- VoiceConnectors (list) --
  
  The details of the Amazon Chime Voice Connectors.
  - (dict) --
    
    The Amazon Chime Voice Connector configuration, including outbound host name and encryption settings.
    - VoiceConnectorId (string) --
      
      The Amazon Chime Voice Connector ID.
    - AwsRegion (string) --
      
      The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1 .
    - Name (string) --
      
      The name of the Amazon Chime Voice Connector.
    - OutboundHostName (string) --
      
      The outbound host name for the Amazon Chime Voice Connector.
    - RequireEncryption (boolean) --
      
      Designates whether encryption is required for the Amazon Chime Voice Connector.
    - CreatedTimestamp (datetime) --
      
      The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
    - UpdatedTimestamp (datetime) --
      
      The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
    - VoiceConnectorArn (string) --
      
      The ARN of the specified Amazon Chime Voice Connector.
- NextToken (string) --
  
  The token to use to retrieve the next page of results.

UpdateVoiceConnector (updated)

Link ¶
Changes (response)

{'VoiceConnector': {'VoiceConnectorArn': 'string'}}

Updates details for the specified Amazon Chime Voice Connector.

See also: AWS API Documentation

Request Syntax

client.update_voice_connector(
    VoiceConnectorId='string',
    Name='string',
    RequireEncryption=True|False
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

The Amazon Chime Voice Connector ID.

type Name

string

param Name

[REQUIRED]

The name of the Amazon Chime Voice Connector.

type RequireEncryption

boolean

param RequireEncryption

[REQUIRED]

When enabled, requires encryption for the Amazon Chime Voice Connector.

rtype

dict

returns

Response Syntax

{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        'AwsRegion': 'us-east-1'|'us-west-2',
        'Name': 'string',
        'OutboundHostName': 'string',
        'RequireEncryption': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorArn': 'string'
    }
}

Response Structure

(dict) --
- VoiceConnector (dict) --
  
  The updated Amazon Chime Voice Connector details.
  - VoiceConnectorId (string) --
    
    The Amazon Chime Voice Connector ID.
  - AwsRegion (string) --
    
    The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1 .
  - Name (string) --
    
    The name of the Amazon Chime Voice Connector.
  - OutboundHostName (string) --
    
    The outbound host name for the Amazon Chime Voice Connector.
  - RequireEncryption (boolean) --
    
    Designates whether encryption is required for the Amazon Chime Voice Connector.
  - CreatedTimestamp (datetime) --
    
    The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
  - VoiceConnectorArn (string) --
    
    The ARN of the specified Amazon Chime Voice Connector.

UpdateVoiceConnectorGroup (updated)

Link ¶
Changes (response)

{'VoiceConnectorGroup': {'VoiceConnectorGroupArn': 'string'}}

Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.

See also: AWS API Documentation

Request Syntax

client.update_voice_connector_group(
    VoiceConnectorGroupId='string',
    Name='string',
    VoiceConnectorItems=[
        {
            'VoiceConnectorId': 'string',
            'Priority': 123
        },
    ]
)

type VoiceConnectorGroupId

string

param VoiceConnectorGroupId

[REQUIRED]

The Amazon Chime Voice Connector group ID.

type Name

string

param Name

[REQUIRED]

The name of the Amazon Chime Voice Connector group.

type VoiceConnectorItems

list

param VoiceConnectorItems

[REQUIRED]

The VoiceConnectorItems to associate with the group.

(dict) --

For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
- VoiceConnectorId (string) -- [REQUIRED]
  
  The Amazon Chime Voice Connector ID.
- Priority (integer) -- [REQUIRED]
  
  The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

rtype

dict

returns

Response Syntax

{
    'VoiceConnectorGroup': {
        'VoiceConnectorGroupId': 'string',
        'Name': 'string',
        'VoiceConnectorItems': [
            {
                'VoiceConnectorId': 'string',
                'Priority': 123
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorGroupArn': 'string'
    }
}

Response Structure

(dict) --
- VoiceConnectorGroup (dict) --
  
  The updated Amazon Chime Voice Connector group details.
  - VoiceConnectorGroupId (string) --
    
    The Amazon Chime Voice Connector group ID.
  - Name (string) --
    
    The name of the Amazon Chime Voice Connector group.
  - VoiceConnectorItems (list) --
    
    The Amazon Chime Voice Connectors to which to route inbound calls.
    - (dict) --
      
      For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
      - VoiceConnectorId (string) --
        
        The Amazon Chime Voice Connector ID.
      - Priority (integer) --
        
        The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
  - CreatedTimestamp (datetime) --
    
    The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
  - VoiceConnectorGroupArn (string) --
    
    The ARN of the specified Amazon Chime Voice Connector group.