ChimeSDKVoice / Paginator / ListSipRules

ListSipRules

class ChimeSDKVoice.Paginator.ListSipRules

paginator = client.get_paginator('list_sip_rules')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• SipMediaApplicationId (string) –

• 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

{
    'SipRules': [
        {
            'SipRuleId': 'string',
            'Name': 'string',
            'Disabled': True|False,
            'TriggerType': 'ToPhoneNumber'|'RequestUriHostname',
            'TriggerValue': 'string',
            'TargetApplications': [
                {
                    'SipMediaApplicationId': 'string',
                    'Priority': 123,
                    'AwsRegion': 'string'
                },
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • SipRules (list) –

    • (dict) –

      • SipRuleId (string) –

      • Name (string) –

      • Disabled (boolean) –

      • TriggerType (string) –

      • TriggerValue (string) –

      • TargetApplications (list) –

        • (dict) –

          • SipMediaApplicationId (string) –

          • Priority (integer) –

          • AwsRegion (string) –

      • CreatedTimestamp (datetime) –

      • UpdatedTimestamp (datetime) –