[ aws . iotevents ]

describe-logging-options

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

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

Examples

To get information about logging settings

The following describe-logging-options example retrieves the current settings of the AWS IoT Events logging options.

aws iotevents describe-logging-options

Output:

{
    "loggingOptions": {
        "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole",
        "enabled": false,
        "level": "ERROR"
    }
}

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

Output

loggingOptions -> (structure)

The current settings of the AWS IoT Events logging options.

roleArn -> (string)

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

level -> (string)

The logging level.

enabled -> (boolean)

If TRUE, logging is enabled for AWS IoT Events.

detectorDebugOptions -> (list)

Information that identifies those detector models and their detectors (instances) for which the logging level is given.

(structure)

The detector model and the specific detectors (instances) for which the logging level is given.

detectorModelName -> (string)

The name of the detector model.

keyValue -> (string)

The value of the input attribute key used to create the detector (the instance of the detector model).