Chime / Client / list_sip_media_applications

list_sip_media_applications#

Chime.Client.list_sip_media_applications(**kwargs)#

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

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, ListSipMediaApplications, 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.

See also: AWS API Documentation

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 to use to retrieve 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)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • SipMediaApplications (list) –

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

          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.

    • NextToken (string) –

      The token to use to retrieve the next page of results.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException