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-sdk-voice ]

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. For more information about SIP rules, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide .

See also: AWS API Documentation

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>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--name (string)

The name of the SIP rule.

--trigger-type (string)

The type of trigger assigned to the SIP rule in TriggerValue , currently RequestUriHostname or ToPhoneNumber .

Possible values:

• ToPhoneNumber
• RequestUriHostname

--trigger-value (string)

If TriggerType is RequestUriHostname , the value can be the outbound host name of a 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 | --no-disabled (boolean)

Disables or enables a SIP rule. You must disable SIP 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)

A 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 ID of a rule's target SIP media application.

Priority -> (integer)

The priority setting of a rule's target SIP media application.

AwsRegion -> (string)

The AWS Region of a rule's target SIP media 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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

SipRule -> (structure)

The SIP rule information, including the rule ID, triggers, and target applications.

SipRuleId -> (string)

A SIP rule's ID.

Name -> (string)

A SIP rule's name.

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 set for a SIP rule, either a phone number or a URI request host name.

TriggerValue -> (string)

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

TargetApplications -> (list)

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.

(structure)

A 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 ID of a rule's target SIP media application.

Priority -> (integer)

The priority setting of a rule's target SIP media application.

AwsRegion -> (string)

The AWS Region of a rule's target SIP media application.

CreatedTimestamp -> (timestamp)

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

UpdatedTimestamp -> (timestamp)

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