[ aws . chime ]

update-sip-media-application-call

Description

Allows you to trigger a Lambda function at any time while a call is active, and replace the current actions with new actions returned by the invocation.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-sip-media-application-call
--sip-media-application-id <value>
--transaction-id <value>
--arguments <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--sip-media-application-id (string)

The ID of the SIP media application handling the call.

--transaction-id (string)

The ID of the call transaction.

--arguments (map)

Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED event. Can contain 0-20 key-value pairs.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "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.

See ‘aws help’ for descriptions of global parameters.

Output

SipMediaApplicationCall -> (structure)

A Call instance for a SIP media application.

TransactionId -> (string)

The transaction ID of a call.