Skip to content

get_db_cluster

get_db_cluster(
    db_cluster_id: DbClusterId,
    *,
    config_overrides: Optional[TimestreamInfluxDBClientConfig] = None,
) -> GetDbClusterOutput

Retrieves information about a Timestream for InfluxDB cluster.

Parameters:

  • db_cluster_id (DbClusterId) –

    Service-generated unique identifier of the DB cluster to retrieve.

Raises:

Source code in docs_src/capo_timestream_influxdb/_services/timestream_influx_db.py
def get_db_cluster(
    self,
    db_cluster_id: "capo_timestream_influxdb.types.db_cluster_id.DbClusterId",
    *,
    config_overrides: Optional[TimestreamInfluxDBClientConfig] = None,
) -> "capo_timestream_influxdb.types.get_db_cluster_output.GetDbClusterOutput":
    """<p>Retrieves information about a Timestream for InfluxDB cluster.</p>

    Args:
        db_cluster_id: <p>Service-generated unique identifier of the DB cluster to retrieve.</p>

    Raises:
        capo_timestream_influxdb.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_timestream_influxdb.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_timestream_influxdb.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource was not found or does not exist.</p>
        capo_timestream_influxdb.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_timestream_influxdb.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by Timestream for InfluxDB.</p>
        capo_timestream_influxdb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_timestream_influxdb.types.get_db_cluster_input.GetDbClusterInput]",
    ) -> OperationResponse[
        "capo_timestream_influxdb.types.get_db_cluster_output.GetDbClusterOutput"
    ]:
        import capo_timestream_influxdb._operations.amazon_timestream_influx_db.get_db_cluster

        output, http_response = (
            capo_timestream_influxdb._operations.amazon_timestream_influx_db.get_db_cluster.get_db_cluster(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDbCluster")
    )
    input_: capo_timestream_influxdb.types.get_db_cluster_input.GetDbClusterInput = {
        "db_cluster_id": db_cluster_id
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output