create_sip_rule¶

Chime.Client.create_sip_rule(**kwargs)¶

Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

Request Syntax

response = client.create_sip_rule(
    Name='string',
    TriggerType='ToPhoneNumber'|'RequestUriHostname',
    TriggerValue='string',
    Disabled=True|False,
    TargetApplications=[
        {
            'SipMediaApplicationId': 'string',
            'Priority': 123,
            'AwsRegion': 'string'
        },
    ]
)

Parameters

Name (string) --
[REQUIRED]

The name of the SIP rule.
TriggerType (string) --
[REQUIRED]

The type of trigger assigned to the SIP rule in TriggerValue , currently RequestUriHostname or ToPhoneNumber .
TriggerValue (string) --
[REQUIRED]

If TriggerType is RequestUriHostname , the value can be the outbound host name of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber , the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname , or if the To header in the incoming SIP request matches the ToPhoneNumber value.
Disabled (boolean) -- Enables or disables a rule. You must disable rules before you can delete them.
TargetApplications (list) --
[REQUIRED]

List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.
- (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.

Return type

dict

Returns

Response Syntax

{
    'SipRule': {
        '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) --
- SipRule (dict) --
  
  Returns the SIP rule information, including the rule ID, triggers, and target applications.
  - 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.

Exceptions

Chime.Client.exceptions.BadRequestException
Chime.Client.exceptions.ForbiddenException
Chime.Client.exceptions.AccessDeniedException
Chime.Client.exceptions.UnauthorizedClientException
Chime.Client.exceptions.ThrottledClientException
Chime.Client.exceptions.ResourceLimitExceededException
Chime.Client.exceptions.ConflictException
Chime.Client.exceptions.ServiceUnavailableException
Chime.Client.exceptions.ServiceFailureException

Table Of Contents

create_sip_rule¶