Describes whether information, such as queries and connection attempts, is being logged 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 from which to get the logging status.
Example:
exampleclusterType: String
Length Constraints: Maximum length of 2147483647.
Required: Yes
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
s3andcloudwatch.Type: String
Valid Values:
s3 | cloudwatch - LogExports.member.N
-
The collection of exported log types. Possible values are
connectionlog,useractivitylog, anduserlog.Type: Array of strings
Length Constraints: Maximum length of 2147483647.
- LoggingEnabled
-
trueif logging is on,falseif logging is off.Type: Boolean
- S3KeyPrefix
-
The prefix applied to the log file names.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
[\p{L}\p{Z}\p{N}_.:/=+\-@]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClusterNotFound
-
The
ClusterIdentifierparameter does not refer to an existing cluster.HTTP Status Code: 404
- UnsupportedOperation
-
The requested operation isn't supported.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DescribeLoggingStatus.
Sample Request
https://redshift.us-east-2.amazonaws.com/
?Action=DescribeLoggingStatus
&ClusterIdentifier=mycluster
&SignatureMethod=HmacSHA256&SignatureVersion=4
&Version=2012-12-01
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20190817/us-east-2/redshift/aws4_request
&X-Amz-Date=20190825T160000Z
&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
&X-Amz-Signature=0aa1234bb5cc678ddddd901ee2ff3aa45678b90c12d345e6ff789012345a6b7bSample Response
<DescribeLoggingStatusResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/">
<DescribeLoggingStatusResult>
<LoggingEnabled>false</LoggingEnabled>
</DescribeLoggingStatusResult>
<ResponseMetadata>
<RequestId>9ed2dcec-28cc-11ea-b6af-7126da6f11af</RequestId>
</ResponseMetadata>
</DescribeLoggingStatusResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
