Redshift / Client / enable_logging

enable_logging

Redshift.Client.enable_logging(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.enable_logging(
    ClusterIdentifier='string',
    BucketName='string',
    S3KeyPrefix='string',
    LogDestinationType='s3'|'cloudwatch',
    LogExports=[
        'string',
    ]
)

Parameters:

• ClusterIdentifier (string) –

  [REQUIRED]

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

  Example: examplecluster

• BucketName (string) –

  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

• S3KeyPrefix (string) –

  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

• LogDestinationType (string) – The log destination type. An enum with possible values of s3 and cloudwatch.

• LogExports (list) –

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

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'LoggingEnabled': True|False,
    'BucketName': 'string',
    'S3KeyPrefix': 'string',
    'LastSuccessfulDeliveryTime': datetime(2015, 1, 1),
    'LastFailureTime': datetime(2015, 1, 1),
    'LastFailureMessage': 'string',
    'LogDestinationType': 's3'|'cloudwatch',
    'LogExports': [
        'string',
    ]
}

Response Structure

• (dict) –

  Describes the status of logging for a cluster.

  • LoggingEnabled (boolean) –

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

  • BucketName (string) –

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

  • S3KeyPrefix (string) –

    The prefix applied to the log file names.

  • LastSuccessfulDeliveryTime (datetime) –

    The last time that logs were delivered.

  • LastFailureTime (datetime) –

    The last time when logs failed to be delivered.

  • LastFailureMessage (string) –

    The message indicating that logs failed to be delivered.

  • LogDestinationType (string) –

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

  • LogExports (list) –

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

    • (string) –

Exceptions

• Redshift.Client.exceptions.ClusterNotFoundFault

• Redshift.Client.exceptions.BucketNotFoundFault

• Redshift.Client.exceptions.InsufficientS3BucketPolicyFault

• Redshift.Client.exceptions.InvalidS3KeyPrefixFault

• Redshift.Client.exceptions.InvalidS3BucketNameFault

• Redshift.Client.exceptions.InvalidClusterStateFault