Redshift / Client / describe_logging_status

describe_logging_status#

Redshift.Client.describe_logging_status(**kwargs)#

Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.

Request Syntax

response = client.describe_logging_status(
    ClusterIdentifier='string'
)

Parameters:

ClusterIdentifier (string) –

[REQUIRED]

The identifier of the cluster from which to get the logging status.

Example: examplecluster

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.UnsupportedOperationFault