ChimeSDKVoice / Client / create_sip_media_application

create_sip_media_application#

ChimeSDKVoice.Client.create_sip_media_application(**kwargs)#

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

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

  • AwsRegion (string) –

    [REQUIRED]

    The AWS Region assigned to the SIP media application.

  • Name (string) –

    [REQUIRED]

    The SIP media application’s name.

  • Endpoints (list) –

    [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.

  • Tags (list) –

    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.

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 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.

Exceptions