Table Of Contents

Feedback

User Guide

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

[ aws . iotanalytics ]

describe-logging-options

Description

Retrieves the current settings of the AWS IoT Analytics logging options.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-logging-options
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

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

loggingOptions -> (structure)

The current settings of the AWS IoT Analytics logging options.

roleArn -> (string)

The ARN of the role that grants permission to AWS IoT Analytics to perform logging.

level -> (string)

The logging level. Currently, only "ERROR" is supported.

enabled -> (boolean)

If true, logging is enabled for AWS IoT Analytics.