sip_rules

Creates, updates, deletes, gets or lists a sip_rules resource.

Overview

Name	sip_rules
Type	Resource
Id	aws.chime_sdk_voice.sip_rules

Fields

The following fields are returned by SELECT queries:

get_sip_rule

Name	Datatype	Description
created_timestamp	string (date-time)	The time at which the SIP rule was created, in ISO 8601 format.
disabled	boolean	Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
name	string	A SIP rule's name. (pattern: <code>[a-zA-Z0-9 _.-]+</code>)
sip_rule_id	string	A SIP rule's ID. (pattern: <code>.\S.</code>)
target_applications	array	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	string	The type of trigger set for a SIP rule, either a phone number or a URI request host name. (ToPhoneNumber, RequestUriHostname)
trigger_value	string	The value set for a SIP rule's trigger type. Either a phone number or a URI hostname. (pattern: <code>.\S.</code>)
updated_timestamp	string (date-time)	The time at which the SIP rule was updated, in ISO 8601 format.

list_sip_rules

Name	Datatype	Description
created_timestamp	string (date-time)	The time at which the SIP rule was created, in ISO 8601 format.
disabled	boolean	Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
name	string	A SIP rule's name. (pattern: <code>[a-zA-Z0-9 _.-]+</code>)
sip_rule_id	string	A SIP rule's ID. (pattern: <code>.\S.</code>)
target_applications	array	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	string	The type of trigger set for a SIP rule, either a phone number or a URI request host name. (ToPhoneNumber, RequestUriHostname)
trigger_value	string	The value set for a SIP rule's trigger type. Either a phone number or a URI hostname. (pattern: <code>.\S.</code>)
updated_timestamp	string (date-time)	The time at which the SIP rule was updated, in ISO 8601 format.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sip_rule	select	sip_rule_id, region		Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
list_sip_rules	select	region	sip-media-application, max-results, next-token	Lists the SIP rules under the administrator's AWS account.
create_sip_rule	insert	region, TriggerType, TriggerValue, TargetApplications		Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type. For more information about SIP rules, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.
update_sip_rule	update	sip_rule_id, region		Updates the details of the specified SIP rule.
delete_sip_rule	delete	sip_rule_id, region		Deletes a SIP rule.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
sip_rule_id	string	The SIP rule ID.
max-results	integer	The maximum number of results to return in a single call. Defaults to 100.
next-token	string	The token used to return the next page of results.
sip-media-application	string	The SIP media application ID.

SELECT examples

get_sip_rule

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

SELECT
created_timestamp,
disabled,
name,
sip_rule_id,
target_applications,
trigger_type,
trigger_value,
updated_timestamp
FROM aws.chime_sdk_voice.sip_rules
WHERE sip_rule_id = '{{ sip_rule_id }}' -- required
AND region = '{{ region }}' -- required
;

list_sip_rules

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

SELECT
created_timestamp,
disabled,
name,
sip_rule_id,
target_applications,
trigger_type,
trigger_value,
updated_timestamp
FROM aws.chime_sdk_voice.sip_rules
WHERE region = '{{ region }}' -- required
AND `sip-media-application` = '{{ sip-media-application }}'
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

INSERT examples

create_sip_rule

Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type. For more information about SIP rules, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

INSERT INTO aws.chime_sdk_voice.sip_rules (
Name,
TriggerType,
TriggerValue,
Disabled,
TargetApplications,
region
)
SELECT 
'{{ Name }}',
'{{ TriggerType }}' /* required */,
'{{ TriggerValue }}' /* required */,
{{ Disabled }},
'{{ TargetApplications }}' /* required */,
'{{ region }}'
RETURNING
sip_rule
;

Manifest

# Description fields are for documentation purposes
- name: sip_rules
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the sip_rules resource.
  - name: Name
    value: "{{ Name }}"
  - name: TriggerType
    value: "{{ TriggerType }}"
    valid_values: ['ToPhoneNumber', 'RequestUriHostname']
  - name: TriggerValue
    value: "{{ TriggerValue }}"
  - name: Disabled
    value: {{ Disabled }}
  - name: TargetApplications
    value:
      - SipMediaApplicationId: "{{ SipMediaApplicationId }}"
        Priority: {{ Priority }}
        AwsRegion: "{{ AwsRegion }}"

UPDATE examples

update_sip_rule

Updates the details of the specified SIP rule.

UPDATE aws.chime_sdk_voice.sip_rules
SET 
Name = '{{ Name }}',
Disabled = {{ Disabled }},
TargetApplications = '{{ TargetApplications }}'
WHERE 
sip_rule_id = '{{ sip_rule_id }}' --required
AND region = '{{ region }}' --required
RETURNING
sip_rule;

DELETE examples

delete_sip_rule

Deletes a SIP rule.

DELETE FROM aws.chime_sdk_voice.sip_rules
WHERE sip_rule_id = '{{ sip_rule_id }}' --required
AND region = '{{ region }}' --required
;