ChimeSDKVoice / Client / list_sip_rules

list_sip_rules

ChimeSDKVoice.Client.list_sip_rules(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.list_sip_rules(
    SipMediaApplicationId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

• SipMediaApplicationId (string) –

• MaxResults (integer) –

• NextToken (string) –

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

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

  • NextToken (string) –

Exceptions

• ChimeSDKVoice.Client.exceptions.UnauthorizedClientException

• ChimeSDKVoice.Client.exceptions.ForbiddenException

• ChimeSDKVoice.Client.exceptions.BadRequestException

• ChimeSDKVoice.Client.exceptions.ThrottledClientException

• ChimeSDKVoice.Client.exceptions.ServiceUnavailableException

• ChimeSDKVoice.Client.exceptions.ServiceFailureException