[ aws . iot ]

get-v2-logging-options

Description

Gets the fine grained logging options.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-v2-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 list the current logging options

The following get-v2-logging-options example lists the current logging options for AWS IoT.

aws iot get-v2-logging-options

Output:

{
    "roleArn": "arn:aws:iam::094249569039:role/service-role/iotLoggingRole",
    "defaultLogLevel": "WARN",
    "disableAllLogs": false
}

For more information, see title in the AWS IoT Developer Guide.

Output

roleArn -> (string)

The IAM role ARN AWS IoT uses to write to your CloudWatch logs.

defaultLogLevel -> (string)

The default log level.

disableAllLogs -> (boolean)

Disables all logs.