Skip to content

describe_logging_status async

describe_logging_status(
    *,
    config_overrides: Optional[AsyncRedshiftClientConfig] = None,
    cluster_identifier: Optional[String] = None,
) -> LoggingStatus

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

Parameters:

  • cluster_identifier (Optional[String], default: None ) –

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

    Example: examplecluster

Raises:

Source code in docs_src/capo_redshift/_services/async_redshift.py
async def describe_logging_status(
    self,
    *,
    config_overrides: Optional[AsyncRedshiftClientConfig] = None,
    cluster_identifier: Optional["capo_redshift.types.string.String"] = None,
) -> "capo_redshift.types.logging_status.LoggingStatus":
    """<p>Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.</p>

    Args:
        cluster_identifier: <p>The identifier of the cluster from which to get the logging status.</p> <p>Example: <code>examplecluster</code> </p>

    Raises:
        capo_redshift.errors.cluster_not_found_fault.ClusterNotFoundFault: <p>The <code>ClusterIdentifier</code> parameter does not refer to an existing cluster. </p>
        capo_redshift.errors.unsupported_operation_fault.UnsupportedOperationFault: <p>The requested operation isn't supported.</p>
        capo_redshift.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_redshift.types.describe_logging_status_message.DescribeLoggingStatusMessage]",
    ) -> AsyncOperationResponse["capo_redshift.types.logging_status.LoggingStatus"]:
        import capo_redshift._operations.redshift_service_version20121201.describe_logging_status

        (
            output,
            http_response,
        ) = await capo_redshift._operations.redshift_service_version20121201.describe_logging_status.async_describe_logging_status(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeLoggingStatus")
    )
    input_: capo_redshift.types.describe_logging_status_message.DescribeLoggingStatusMessage = {}
    if cluster_identifier is not None:
        input_["cluster_identifier"] = cluster_identifier

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output