ChimeSDKVoice / Paginator / ListSipMediaApplications

ListSipMediaApplications#

class ChimeSDKVoice.Paginator.ListSipMediaApplications#
paginator = client.get_paginator('list_sip_media_applications')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from ChimeSDKVoice.Client.list_sip_media_applications().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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'
        },
    ],

}

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.