DescribeLoggingOptionsCommand

Suggest an Edit

Retrieves the current IoT SiteWise logging options.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IoTSiteWiseClient, DescribeLoggingOptionsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
// const { IoTSiteWiseClient, DescribeLoggingOptionsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
const client = new IoTSiteWiseClient(config);
const input = {};
const command = new DescribeLoggingOptionsCommand(input);
const response = await client.send(command);
// { // DescribeLoggingOptionsResponse
//   loggingOptions: { // LoggingOptions
//     level: "ERROR" || "INFO" || "OFF", // required
//   },
// };

DescribeLoggingOptionsCommand Input

See DescribeLoggingOptionsCommandInput for more details
DescribeLoggingOptionsCommandInput extends DescribeLoggingOptionsRequest

DescribeLoggingOptionsCommand Output

See DescribeLoggingOptionsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
loggingOptions
Required
LoggingOptions | undefined

The current logging options.

Throws

Name
Fault
Details
InternalFailureException
server

IoT SiteWise can't process your request right now. Try again later.

InvalidRequestException
client

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException
client

The requested resource can't be found.

ThrottlingException
client

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas  in the IoT SiteWise User Guide.

IoTSiteWiseServiceException
Base exception class for all service exceptions from IoTSiteWise service.