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

CreateLoggingConfiguration

The CreateLoggingConfiguration operation creates rules and alerting logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.

Note

These logging configurations are only for rules and alerting logs.

Request Syntax


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

{
   "clientToken": "string",
   "logGroupArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

workspaceId

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

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

A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

Type: String

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

Pattern: [!-~]+

Required: No

logGroupArn

The ARN of the CloudWatch log group to which the vended log data will be published. This log group must exist prior to calling this operation.

Type: String

Pattern: arn:aws[a-z0-9-]*:logs:[a-z0-9-]+:[0-9]{12}:log-group:[A-Za-z0-9\.\-\_\#/]{1,512}\:\*

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

A structure that displays the current status of the logging configuration.

Type: LoggingConfigurationStatus 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