Chime / Client / list_sip_rules

list_sip_rules#

Chime.Client.list_sip_rules(**kwargs)#

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

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, ListSipRules, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

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 to use to retrieve 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) –

      List of SIP rules and rule details.

      • (dict) –

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

        • SipRuleId (string) –

          The SIP rule ID.

        • Name (string) –

          The name of the SIP rule.

        • 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 assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

        • TriggerValue (string) –

          If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

        • TargetApplications (list) –

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

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

            • Priority (integer) –

              Priority of the SIP media application in the target list.

            • AwsRegion (string) –

              The AWS Region of the target 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 last updated, in ISO 8601 format.

    • NextToken (string) –

      The token to use to retrieve the next page of results.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException