Chime / Client / get_sip_media_application

get_sip_media_application#

Chime.Client.get_sip_media_application(**kwargs)#

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

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, GetSipMediaApplication, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

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)
    }
}

Response Structure

(dict) –
- SipMediaApplication (dict) –
  
  The SIP media application details.
  - SipMediaApplicationId (string) –
    
    The SIP media application ID.
  - AwsRegion (string) –
    
    The AWS Region in which the SIP media application is created.
  - Name (string) –
    
    The name of the SIP media application.
  - Endpoints (list) –
    
    List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.
    - (dict) –
      
      The endpoint assigned to the 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 SIP media application updated timestamp, in ISO 8601 format.

Exceptions

Chime.Client.exceptions.UnauthorizedClientException
Chime.Client.exceptions.NotFoundException
Chime.Client.exceptions.ForbiddenException
Chime.Client.exceptions.BadRequestException
Chime.Client.exceptions.ThrottledClientException
Chime.Client.exceptions.ServiceUnavailableException
Chime.Client.exceptions.ServiceFailureException