ChimeSDKVoice / Client / list_sip_rules

list_sip_rules#

ChimeSDKVoice.Client.list_sip_rules(**kwargs)#

Lists the SIP rules under the administrator’s AWS account.

See also: AWS API Documentation

Request Syntax

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

  • SipMediaApplicationId (string) – The SIP media application ID.

  • MaxResults (integer) – The maximum number of results to return in a single call. Defaults to 100.

  • NextToken (string) – The token used to return the next page of results.

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

      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.

    • NextToken (string) –

      The token used to return the next page of results.

Exceptions