- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeLoggingOptionsCommand
Retrieves the current settings of the AWS IoT Events logging options.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IoTEventsClient, DescribeLoggingOptionsCommand } from "@aws-sdk/client-iot-events"; // ES Modules import
// const { IoTEventsClient, DescribeLoggingOptionsCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import
const client = new IoTEventsClient(config);
const input = {};
const command = new DescribeLoggingOptionsCommand(input);
const response = await client.send(command);
// { // DescribeLoggingOptionsResponse
// loggingOptions: { // LoggingOptions
// roleArn: "STRING_VALUE", // required
// level: "ERROR" || "INFO" || "DEBUG", // required
// enabled: true || false, // required
// detectorDebugOptions: [ // DetectorDebugOptions
// { // DetectorDebugOption
// detectorModelName: "STRING_VALUE", // required
// keyValue: "STRING_VALUE",
// },
// ],
// },
// };
DescribeLoggingOptionsCommand Input
See DescribeLoggingOptionsCommandInput for more details
DescribeLoggingOptionsCommandInput extends DescribeLoggingOptionsRequest DescribeLoggingOptionsCommand Output
See DescribeLoggingOptionsCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
loggingOptions | LoggingOptions | undefined | The current settings of the AWS IoT Events logging options. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalFailureException | server | An internal failure occurred. |
| InvalidRequestException | client | The request was invalid. |
| ResourceNotFoundException | client | The resource was not found. |
| ServiceUnavailableException | server | The service is currently unavailable. |
| ThrottlingException | client | The request could not be completed due to throttling. |
| UnsupportedOperationException | server | The requested operation is not supported. |
| IoTEventsServiceException | Base exception class for all service exceptions from IoTEvents service. |