SipRule - Amazon Chime

SipRule

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

Contents

CreatedTimestamp

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

Type: Timestamp

Required: No

Disabled

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

Type: Boolean

Required: No

Name

The name of the SIP rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

SipRuleId

The SIP rule ID.

Type: String

Pattern: .*\S.*

Required: No

TargetApplications

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.

Type: Array of SipRuleTargetApplication objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: No

TriggerType

The type of trigger whose value is assigned to the SIP rule in TriggerValue.

Type: String

Valid Values: ToPhoneNumber | RequestUriHostname

Required: No

TriggerValue

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.

Type: String

Pattern: .*\S.*

Required: No

UpdatedTimestamp

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

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: