Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . chime ]

create-sip-rule

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-sip-rule
--name <value>
--trigger-type <value>
--trigger-value <value>
[--disabled | --no-disabled]
--target-applications <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the SIP rule.

--trigger-type (string)

The type of trigger whose value is assigned to the SIP rule in TriggerValue . Allowed trigger values are RequestUriHostname and ToPhoneNumber .

Possible values:

  • ToPhoneNumber
  • RequestUriHostname

--trigger-value (string)

If TriggerType is RequestUriHostname then the value can be the outbound host name of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber then the value can be a customer-owned phone number in E164 format. SipRule is triggered if the SIP application requests a host name, or a If TriggerType is RequestUriHostname , then the value can be the outbound hostname of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber , then the value can be a customer-owned phone number in E164 format. SipRule is triggered if the SIP application requests a host name, or a ToPhoneNumber value matches the incoming SIP request.

--disabled | --no-disabled (boolean)

Enables or disables a rule. You must disable rules before you can delete them.

--target-applications (list)

List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.

(structure)

Target SIP media application along with other details like 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)

AWS Region of target application.

Shorthand Syntax:

SipMediaApplicationId=string,Priority=integer,AwsRegion=string ...

JSON Syntax:

[
  {
    "SipMediaApplicationId": "string",
    "Priority": integer,
    "AwsRegion": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

SipRule -> (structure)

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 if the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

TriggerType -> (string)

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

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)

List of SIP media applications with priority and AWS Region. You can only use one SIP application per AWS Region and priority combination.

(structure)

Target SIP media application along with other details like 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)

AWS Region of target application.

CreatedTimestamp -> (timestamp)

The SIP rule created timestamp, in ISO 8601 format.

UpdatedTimestamp -> (timestamp)

The SIP rule updated timestamp, in ISO 8601 format.