ChimeSDKVoice / Client / get_sip_media_application

get_sip_media_application#

ChimeSDKVoice.Client.get_sip_media_application(**kwargs)#

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

Request Syntax

response = client.get_sip_media_application(
    SipMediaApplicationId='string'
)

Parameters:

SipMediaApplicationId (string) –

[REQUIRED]

The SIP media application ID .

Return type:

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.

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