EnableLogging - Amazon Redshift
Request ParametersResponse ElementsErrorsSee Also

EnableLogging

Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ClusterIdentifier

The identifier of the cluster on which logging is to be started.

Example: examplecluster

Type: String

Length Constraints: Maximum length of 2147483647.

Required: Yes

BucketName

The name of an existing S3 bucket where the log files are to be stored.

Constraints:

  • Must be in the same region as the cluster

  • The cluster must have read bucket and put object permissions

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

LogDestinationType

The log destination type. An enum with possible values of s3 and cloudwatch.

Type: String

Valid Values: s3 | cloudwatch

Required: No

LogExports.member.N

The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog.

Type: Array of strings

Length Constraints: Maximum length of 2147483647.

Required: No

S3KeyPrefix

The prefix applied to the log file names.

Constraints:

  • Cannot exceed 512 characters

  • Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash (\), or control characters. The hexadecimal codes for invalid characters are:

    • x00 to x20

    • x22

    • x27

    • x5c

    • x7f or larger

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

Response Elements

The following elements are returned by the service.

BucketName

The name of the S3 bucket where the log files are stored.

Type: String

Length Constraints: Maximum length of 2147483647.

LastFailureMessage

The message indicating that logs failed to be delivered.

Type: String

Length Constraints: Maximum length of 2147483647.

LastFailureTime

The last time when logs failed to be delivered.

Type: Timestamp

LastSuccessfulDeliveryTime

The last time that logs were delivered.

Type: Timestamp

LogDestinationType

The log destination type. An enum with possible values of s3 and cloudwatch.

Type: String

Valid Values: s3 | cloudwatch

LogExports.member.N

The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog.

Type: Array of strings

Length Constraints: Maximum length of 2147483647.

LoggingEnabled

true if logging is on, false if logging is off.

Type: Boolean

S3KeyPrefix

The prefix applied to the log file names.

Type: String

Length Constraints: Maximum length of 2147483647.

Errors

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

BucketNotFoundFault

Could not find the specified S3 bucket.

HTTP Status Code: 400

ClusterNotFound

The ClusterIdentifier parameter does not refer to an existing cluster.

HTTP Status Code: 404

InsufficientS3BucketPolicyFault

The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling logging.

HTTP Status Code: 400

InvalidClusterState

The specified cluster is not in the available state.

HTTP Status Code: 400

InvalidS3BucketNameFault

The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and Limitations in the Amazon Simple Storage Service (S3) Developer Guide.

HTTP Status Code: 400

InvalidS3KeyPrefixFault

The string specified for the logging S3 key prefix does not comply with the documented constraints.

HTTP Status Code: 400

UnsupportedOperation

The requested operation isn't supported.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: