describe-logging-options¶

Description¶

Retrieves the current IoT SiteWise logging options.

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 retrieve the current AWS IoT SiteWise logging options

The following describe-logging-options example retrieves the current AWS IoT SiteWise logging options for your AWS account in the current Region.

aws iotsitewise describe-logging-options

Output:

{
    "loggingOptions": {
        "level": "INFO"
    }
}

For more information, see Monitoring AWS IoT SiteWise with Amazon CloudWatch Logs in the AWS IoT SiteWise User Guide.

Output¶

loggingOptions -> (structure)

The current logging options.

level -> (string)

The IoT SiteWise logging verbosity level.

Table of Contents

Feedback

User Guide