Skip to content

SipRule

Source code in docs_src/capo_chime_sdk_voice/types/sip_rule.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
class SipRule(TypedDict, closed=True):
    sip_rule_id: NotRequired[
        "capo_chime_sdk_voice.types.non_empty_string.NonEmptyString"
    ]
    """<p>A SIP rule's ID.</p>"""
    name: NotRequired["capo_chime_sdk_voice.types.sip_rule_name.SipRuleName"]
    """<p>A SIP rule's name.</p>"""
    disabled: NotRequired["capo_chime_sdk_voice.types.boolean.Boolean"]
    """<p>Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.</p>"""
    trigger_type: NotRequired[
        "capo_chime_sdk_voice.types.sip_rule_trigger_type.SipRuleTriggerType"
    ]
    """<p>The type of trigger set for a SIP rule, either a phone number or a URI request host name.</p>"""
    trigger_value: NotRequired[
        "capo_chime_sdk_voice.types.non_empty_string.NonEmptyString"
    ]
    """<p>The value set for a SIP rule's trigger type. Either a phone number or a URI hostname.</p>"""
    target_applications: NotRequired[
        "capo_chime_sdk_voice.types.sip_rule_target_application_list.SipRuleTargetApplicationList"
    ]
    """<p>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.</p>"""
    created_timestamp: NotRequired[
        "capo_chime_sdk_voice.types.iso8601_timestamp.Iso8601Timestamp"
    ]
    """<p>The time at which the SIP rule was created, in ISO 8601 format.</p>"""
    updated_timestamp: NotRequired[
        "capo_chime_sdk_voice.types.iso8601_timestamp.Iso8601Timestamp"
    ]
    """<p>The time at which the SIP rule was updated, in ISO 8601 format.</p>"""

created_timestamp instance-attribute 

created_timestamp: NotRequired[Iso8601Timestamp]

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

disabled instance-attribute 

disabled: NotRequired[Boolean]

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

name instance-attribute 

name: NotRequired[SipRuleName]

A SIP rule's name.

sip_rule_id instance-attribute 

sip_rule_id: NotRequired[NonEmptyString]

A SIP rule's ID.

target_applications instance-attribute 

target_applications: NotRequired[SipRuleTargetApplicationList]

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.

trigger_type instance-attribute 

trigger_type: NotRequired[SipRuleTriggerType]

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

trigger_value instance-attribute 

trigger_value: NotRequired[NonEmptyString]

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

updated_timestamp instance-attribute 

updated_timestamp: NotRequired[Iso8601Timestamp]

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