[ aws . iotanalytics ]



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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]


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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.


To retrieve the current logging options

The following describe-logging-options example displays the current AWS IoT Analytics logging options.

aws iotanalytics describe-logging-options

This command produces no output. Output:

    "loggingOptions": {
        "roleArn": "arn:aws:iam::123456789012:role/service-role/myIoTAnalyticsRole",
        "enabled": true,
        "level": "ERROR"

For more information, see DescribeLoggingOptions in the AWS IoT Analytics API Reference.


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.