ChimeSDKVoice / Client / list_sip_media_applications

list_sip_media_applications#

ChimeSDKVoice.Client.list_sip_media_applications(**kwargs)#

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

Request Syntax

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

Parameters:

MaxResults (integer) – The maximum number of results to return in a single call. Defaults to 100.
NextToken (string) – The token used to return the next page of results.

Return type:

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.

Exceptions

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