SipRule - Amazon Chime SDK

SipRule

The details of a SIP rule, 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

A SIP rule's name.

Type: String

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

Pattern: [a-zA-Z0-9 _.-]+

Required: No

SipRuleId

A SIP rule's ID.

Type: String

Pattern: .*\S.*

Required: No

TargetApplications

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.

Type: Array of SipRuleTargetApplication objects

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

Required: No

TriggerType

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

Type: String

Valid Values: ToPhoneNumber | RequestUriHostname

Required: No

TriggerValue

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

Type: String

Pattern: .*\S.*

Required: No

UpdatedTimestamp

The time at which the SIP rule was 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: