set-v2-logging-options¶

Description¶

Sets the logging options for the V2 logging service.

Synopsis¶

  set-v2-logging-options
[--role-arn <value>]
[--default-log-level <value>]
[--disable-all-logs | --no-disable-all-logs]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--role-arn (string)

The ARN of the role that allows IoT to write to Cloudwatch logs.

--default-log-level (string)

The default logging level.

Possible values:

DEBUG

INFO

ERROR

WARN

DISABLED

--disable-all-logs | --no-disable-all-logs (boolean)

If true all logs are disabled. The default is false.

--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 set the logging options

The following set-v2-logging-options example sets the default logging verbosity level to ERROR and specifies the ARN to use for logging.

aws iot set-v2-logging-options \
    --default-log-level ERROR \
    --role-arn "arn:aws:iam::094249569039:role/service-role/iotLoggingRole"

This command produces no output.

Output¶

None

Table of Contents

Feedback

User Guide