Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeLoggingOptions

Retrieves the current settings of the AWS IoT Analytics logging options.

Request Syntax


GET /logging HTTP/1.1

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "loggingOptions": { 
      "enabled": boolean,
      "level": "string",
      "roleArn": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

loggingOptions

The current settings of the AWS IoT Analytics logging options.

Type: LoggingOptions object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the specified name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400