GetLoggingOptionsCommand

Suggest an Edit

Retrieves the logging options.

Example Syntax

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

import { IoTFleetWiseClient, GetLoggingOptionsCommand } from "@aws-sdk/client-iotfleetwise"; // ES Modules import
// const { IoTFleetWiseClient, GetLoggingOptionsCommand } = require("@aws-sdk/client-iotfleetwise"); // CommonJS import
const client = new IoTFleetWiseClient(config);
const input = {};
const command = new GetLoggingOptionsCommand(input);
const response = await client.send(command);
// { // GetLoggingOptionsResponse
//   cloudWatchLogDelivery: { // CloudWatchLogDeliveryOptions
//     logType: "OFF" || "ERROR", // required
//     logGroupName: "STRING_VALUE",
//   },
// };

GetLoggingOptionsCommand Input

See GetLoggingOptionsCommandInput for more details
GetLoggingOptionsCommandInput extends GetLoggingOptionsRequest

GetLoggingOptionsCommand Output

See GetLoggingOptionsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
cloudWatchLogDelivery
Required
CloudWatchLogDeliveryOptions | undefined

Returns information about log delivery to Amazon CloudWatch Logs.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have sufficient permission to perform this action.

ThrottlingException
client

The request couldn't be completed due to throttling.

InternalServerException
server

The request couldn't be completed because the server temporarily failed.

IoTFleetWiseServiceException
Base exception class for all service exceptions from IoTFleetWise service.