[ aws . redshift ]

describe-logging-status

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-logging-status
--cluster-identifier <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--cluster-identifier (string)

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

Example: examplecluster

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe logging status for a cluster

The following describe-logging-status example displays whether information, such as queries and connection attempts, is being logged for a cluster.

aws redshift describe-logging-status \
    --cluster-identifier mycluster

Output:

{
    "LoggingEnabled": false
}

For more information, see Database Audit Logging in the Amazon Redshift Cluster Management Guide.

Output

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 -> (timestamp)

The last time that logs were delivered.

LastFailureTime -> (timestamp)

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. Log types include the connection log, user log and user activity log.

(string)