Returns a list of Timestream for InfluxDB DB instances.
Parameters:
-
next_token
(Optional[NextToken], default:
None
)
–
The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
Raises:
Source code in docs_src/capo_timestream_influxdb/_services/timestream_influx_db.py
| def list_db_instances(
self,
*,
config_overrides: Optional[TimestreamInfluxDBClientConfig] = None,
next_token: Optional[
"capo_timestream_influxdb.types.next_token.NextToken"
] = None,
max_results: Optional[
"capo_timestream_influxdb.types.max_results.MaxResults"
] = None,
) -> (
"capo_timestream_influxdb.types.list_db_instances_output.ListDbInstancesOutput"
):
"""<p>Returns a list of Timestream for InfluxDB DB instances.</p>
Args:
next_token: <p>The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.</p>
max_results: <p>The maximum number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.</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.list_db_instances_input.ListDbInstancesInput]",
) -> OperationResponse[
"capo_timestream_influxdb.types.list_db_instances_output.ListDbInstancesOutput"
]:
import capo_timestream_influxdb._operations.amazon_timestream_influx_db.list_db_instances
output, http_response = (
capo_timestream_influxdb._operations.amazon_timestream_influx_db.list_db_instances.list_db_instances(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListDbInstances")
)
input_: capo_timestream_influxdb.types.list_db_instances_input.ListDbInstancesInput = {}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|