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

CreateQueryLoggingConfiguration

Creates a query logging configuration for the specified workspace. This operation enables logging of queries that exceed the specified QSP threshold.

Request Syntax


POST /workspaces/workspaceId/logging/query HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "destinations": [ 
      { 
         "cloudWatchLogs": { 
            "logGroupArn": "string"
         },
         "filters": { 
            "qspThreshold": number
         }
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

workspaceId

The ID of the workspace for which to create the query logging configuration.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: .*[0-9A-Za-z][-.0-9A-Z_a-z]*.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [!-~]+

Required: No

destinations

The destinations where query logs will be sent. Only CloudWatch Logs destination is supported. The list must contain exactly one element.

Type: Array of LoggingDestination objects

Array Members: Fixed number of 1 item.

Required: Yes

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "status": { 
      "statusCode": "string",
      "statusReason": "string"
   }
}

Response Elements

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

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

status

The current status of the query logging configuration.

Type: QueryLoggingConfigurationStatus object

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

message: Description of the error.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred during the processing of the request.

message: Description of the error.
retryAfterSeconds: Advice to clients on when the call can be safely retried.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resources that doesn't exist.

message: Description of the error.
resourceId: Identifier of the resource affected.
resourceType: Type of the resource affected.

HTTP Status Code: 404

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

fieldList: The field that caused the error, if applicable.
message: Description of the error.
reason: Reason the request failed validation.

HTTP Status Code: 400