AWS API Changes

2023/04/13 - Amazon Chime SDK Voice - 5 updated api methods

Changes This release adds tagging support for Voice Connectors and SIP Media Applications

CreateSipMediaApplication (updated)

Link ¶
Changes (request, response)
Request

{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Response

{'SipMediaApplication': {'SipMediaApplicationArn': 'string'}}

Creates a SIP media application. For more information about SIP media applications, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide .

See also: AWS API Documentation

Request Syntax

client.create_sip_media_application(
    AwsRegion='string',
    Name='string',
    Endpoints=[
        {
            'LambdaArn': 'string'
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type AwsRegion

string

param AwsRegion

[REQUIRED]

The AWS Region assigned to the SIP media application.

type Name

string

param Name

[REQUIRED]

The SIP media application's name.

type Endpoints

list

param Endpoints

[REQUIRED]

List of endpoints (Lambda ARNs) specified for the SIP media application.

(dict) --

The endpoint assigned to a SIP media application.
- LambdaArn (string) --
  
  Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.

type Tags

list

param Tags

The tags assigned to the SIP media application.

(dict) --

Describes a tag applied to a resource.
- Key (string) -- [REQUIRED]
  
  The tag's key.
- Value (string) -- [REQUIRED]
  
  The tag's value.

rtype

dict

returns

Response Syntax

{
    'SipMediaApplication': {
        'SipMediaApplicationId': 'string',
        'AwsRegion': 'string',
        'Name': 'string',
        'Endpoints': [
            {
                'LambdaArn': 'string'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'SipMediaApplicationArn': 'string'
    }
}

Response Structure

(dict) --
- SipMediaApplication (dict) --
  
  The SIP media application details.
  - SipMediaApplicationId (string) --
    
    A SIP media application's ID.
  - AwsRegion (string) --
    
    The AWS Region in which the SIP media application is created.
  - Name (string) --
    
    The SIP media application's name.
  - Endpoints (list) --
    
    List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted.
    - (dict) --
      
      The endpoint assigned to a SIP media application.
      - LambdaArn (string) --
        
        Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.
  - CreatedTimestamp (datetime) --
    
    The SIP media application creation timestamp, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The time at which the SIP media application was updated.
  - SipMediaApplicationArn (string) --
    
    The ARN of the SIP media application.

CreateVoiceConnector (updated)

Link ¶
Changes (request)

{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Creates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see Managing Amazon Chime SDK Voice Connector groups in the Amazon Chime SDK Administrator Guide .

See also: AWS API Documentation

Request Syntax

client.create_voice_connector(
    Name='string',
    AwsRegion='us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
    RequireEncryption=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Name

string

param Name

[REQUIRED]

The name of the Voice Connector.

type AwsRegion

string

param AwsRegion

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

type RequireEncryption

boolean

param RequireEncryption

[REQUIRED]

Enables or disables encryption for the Voice Connector.

type Tags

list

param Tags

The tags assigned to the Voice Connector.

(dict) --

Describes a tag applied to a resource.
- Key (string) -- [REQUIRED]
  
  The tag's key.
- Value (string) -- [REQUIRED]
  
  The tag's value.

rtype

dict

returns

Response Syntax

{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-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 details of the Voice Connector.
  - VoiceConnectorId (string) --
    
    The Voice Connector's ID.
  - AwsRegion (string) --
    
    The AWS Region in which the Voice Connector is created. Default: us-east-1.
  - Name (string) --
    
    The Voice Connector's name.
  - OutboundHostName (string) --
    
    The outbound host name for the Voice Connector.
  - RequireEncryption (boolean) --
    
    Enables or disables encryption for the Voice Connector.
  - CreatedTimestamp (datetime) --
    
    The Voice Connector's creation timestamp, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The Voice Connector's updated timestamp, in ISO 8601 format.
  - VoiceConnectorArn (string) --
    
    The ARN of the Voice Connector.

GetSipMediaApplication (updated)

Link ¶
Changes (response)

{'SipMediaApplication': {'SipMediaApplicationArn': 'string'}}

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

See also: AWS API Documentation

Request Syntax

client.get_sip_media_application(
    SipMediaApplicationId='string'
)

type SipMediaApplicationId

string

param SipMediaApplicationId

[REQUIRED]

The SIP media application ID .

rtype

dict

returns

Response Syntax

{
    'SipMediaApplication': {
        'SipMediaApplicationId': 'string',
        'AwsRegion': 'string',
        'Name': 'string',
        'Endpoints': [
            {
                'LambdaArn': 'string'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'SipMediaApplicationArn': 'string'
    }
}

Response Structure

(dict) --
- SipMediaApplication (dict) --
  
  The details of the SIP media application.
  - SipMediaApplicationId (string) --
    
    A SIP media application's ID.
  - AwsRegion (string) --
    
    The AWS Region in which the SIP media application is created.
  - Name (string) --
    
    The SIP media application's name.
  - Endpoints (list) --
    
    List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted.
    - (dict) --
      
      The endpoint assigned to a SIP media application.
      - LambdaArn (string) --
        
        Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.
  - CreatedTimestamp (datetime) --
    
    The SIP media application creation timestamp, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The time at which the SIP media application was updated.
  - SipMediaApplicationArn (string) --
    
    The ARN of the SIP media application.

ListSipMediaApplications (updated)

Link ¶
Changes (response)

{'SipMediaApplications': {'SipMediaApplicationArn': 'string'}}

Lists the SIP media applications under the administrator's AWS account.

See also: AWS API Documentation

Request Syntax

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

type MaxResults

integer

param MaxResults

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

type NextToken

string

param NextToken

The token used to return the next page of results.

rtype

dict

returns

Response Syntax

{
    'SipMediaApplications': [
        {
            'SipMediaApplicationId': 'string',
            'AwsRegion': 'string',
            'Name': 'string',
            'Endpoints': [
                {
                    'LambdaArn': 'string'
                },
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'SipMediaApplicationArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- SipMediaApplications (list) --
  
  The list of SIP media applications and application details.
  - (dict) --
    
    The details of the SIP media application, including name and endpoints. An AWS account can have multiple SIP media applications.
    - SipMediaApplicationId (string) --
      
      A SIP media application's ID.
    - AwsRegion (string) --
      
      The AWS Region in which the SIP media application is created.
    - Name (string) --
      
      The SIP media application's name.
    - Endpoints (list) --
      
      List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted.
      - (dict) --
        
        The endpoint assigned to a SIP media application.
        
        LambdaArn (string) --
        
        Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.
    - CreatedTimestamp (datetime) --
      
      The SIP media application creation timestamp, in ISO 8601 format.
    - UpdatedTimestamp (datetime) --
      
      The time at which the SIP media application was updated.
    - SipMediaApplicationArn (string) --
      
      The ARN of the SIP media application.
- NextToken (string) --
  
  The token used to return the next page of results.

UpdateSipMediaApplication (updated)

Link ¶
Changes (response)

{'SipMediaApplication': {'SipMediaApplicationArn': 'string'}}

Updates the details of the specified SIP media application.

See also: AWS API Documentation

Request Syntax

client.update_sip_media_application(
    SipMediaApplicationId='string',
    Name='string',
    Endpoints=[
        {
            'LambdaArn': 'string'
        },
    ]
)

type SipMediaApplicationId

string

param SipMediaApplicationId

[REQUIRED]

The SIP media application ID.

type Name

string

param Name

The new name for the specified SIP media application.

type Endpoints

list

param Endpoints

The new set of endpoints for the specified SIP media application.

(dict) --

The endpoint assigned to a SIP media application.
- LambdaArn (string) --
  
  Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.

rtype

dict

returns

Response Syntax

{
    'SipMediaApplication': {
        'SipMediaApplicationId': 'string',
        'AwsRegion': 'string',
        'Name': 'string',
        'Endpoints': [
            {
                'LambdaArn': 'string'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'SipMediaApplicationArn': 'string'
    }
}

Response Structure

(dict) --
- SipMediaApplication (dict) --
  
  The updated SIP media application’s details.
  - SipMediaApplicationId (string) --
    
    A SIP media application's ID.
  - AwsRegion (string) --
    
    The AWS Region in which the SIP media application is created.
  - Name (string) --
    
    The SIP media application's name.
  - Endpoints (list) --
    
    List of endpoints for a SIP media application. Currently, only one endpoint per SIP media application is permitted.
    - (dict) --
      
      The endpoint assigned to a SIP media application.
      - LambdaArn (string) --
        
        Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.
  - CreatedTimestamp (datetime) --
    
    The SIP media application creation timestamp, in ISO 8601 format.
  - UpdatedTimestamp (datetime) --
    
    The time at which the SIP media application was updated.
  - SipMediaApplicationArn (string) --
    
    The ARN of the SIP media application.