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) – The SIP media application ID.

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

    The list of SIP rules and details.

    • (dict) –

      The details of a SIP rule, including name, triggers, and target applications. An AWS account can have multiple SIP rules.

      • SipRuleId (string) –

        A SIP rule’s ID.

      • Name (string) –

        A SIP rule’s name.

      • Disabled (boolean) –

        Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

      • TriggerType (string) –

        The type of trigger set for a SIP rule, either a phone number or a URI request host name.

      • TriggerValue (string) –

        The value set for a SIP rule’s trigger type. Either a phone number or a URI hostname.

      • TargetApplications (list) –

        The target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

        • (dict) –

          A target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

          • SipMediaApplicationId (string) –

            The ID of a rule’s target SIP media application.

          • Priority (integer) –

            The priority setting of a rule’s target SIP media application.

          • AwsRegion (string) –

            The AWS Region of a rule’s target SIP media application.

      • CreatedTimestamp (datetime) –

        The time at which the SIP rule was created, in ISO 8601 format.

      • UpdatedTimestamp (datetime) –

        The time at which the SIP rule was updated, in ISO 8601 format.