[ aws . chime ]

update-sip-rule

Description

Updates the details of the specified SIP rule.

See also: AWS API Documentation

Synopsis

  update-sip-rule
--sip-rule-id <value>
--name <value>
[--disabled | --no-disabled]
[--target-applications <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--sip-rule-id (string)

The SIP rule ID.

--name (string)

The new name for the specified SIP rule.

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

The new value specified to indicate whether the rule is disabled.

--target-applications (list)

The new value of the list of target applications.

(structure)

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 SIP media application ID.

Priority -> (integer)

Priority of the SIP media application in the target list.

AwsRegion -> (string)

The AWS Region of the target application.

Shorthand Syntax:

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

JSON Syntax:

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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

• yaml

• yaml-stream

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64

• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

SipRule -> (structure)

Updated SIP rule details.

SipRuleId -> (string)

The SIP rule ID.

Name -> (string)

The name of the SIP rule.

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 assigned to the SIP rule in TriggerValue , currently RequestUriHostname or ToPhoneNumber .

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)

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)

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 SIP media application ID.

Priority -> (integer)

Priority of the SIP media application in the target list.

AwsRegion -> (string)

The AWS Region of the target 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 last updated, in ISO 8601 format.