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 ]

put-voice-connector-logging-configuration

Description

Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  put-voice-connector-logging-configuration
--voice-connector-id <value>
--logging-configuration <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--voice-connector-id (string)

The Amazon Chime Voice Connector ID.

--logging-configuration (structure)

The logging configuration details to add.

EnableSIPLogs -> (boolean)

When true, enables SIP message logs for sending to Amazon CloudWatch Logs.

Shorthand Syntax:

EnableSIPLogs=boolean

JSON Syntax:

{
  "EnableSIPLogs": true|false
}

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

Examples

To add a logging configuration for an Amazon Chime Voice Connector

The following put-voice-connector-logging-configuration example turns on the SIP logging configuration for the specified Amazon Chime Voice Connector.

aws chime put-voice-connector-logging-configuration \
    --voice-connector-id abcdef1ghij2klmno3pqr4 \
    --logging-configuration EnableSIPLogs=true

Output:

{
    "LoggingConfiguration": {
        "EnableSIPLogs": true
    }
}

For more information, see Streaming Amazon Chime Voice Connector Media to Kinesis in the Amazon Chime Administration Guide.

Output

LoggingConfiguration -> (structure)

The updated logging configuration details.

EnableSIPLogs -> (boolean)

When true, enables SIP message logs for sending to Amazon CloudWatch Logs.