DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.
Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API unless:
For detailed information on how and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern.
Raises:
Source code in docs_src/capo_timestream_query/_services/async_timestream_query.py
| async def describe_endpoints(
self, *, config_overrides: Optional[AsyncTimestreamQueryClientConfig] = None
) -> "capo_timestream_query.types.describe_endpoints_response.DescribeEndpointsResponse":
"""<p>DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.</p> <p>Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, <i>it is not recommended that you use this API unless</i>:</p> <ul> <li> <p>You are using <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints">VPC endpoints (Amazon Web Services PrivateLink) with Timestream </a> </p> </li> <li> <p>Your application uses a programming language that does not yet have SDK support</p> </li> <li> <p>You require better control over the client-side implementation</p> </li> </ul> <p>For detailed information on how and when to use and implement DescribeEndpoints, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery">The Endpoint Discovery Pattern</a>.</p>
Raises:
capo_timestream_query.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred while processing the request.</p>
capo_timestream_query.errors.throttling_exception.ThrottlingException: <p>The request was throttled due to excessive requests.</p>
capo_timestream_query.errors.validation_exception.ValidationException: <p> Invalid or malformed request. </p>
capo_timestream_query.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_timestream_query.types.describe_endpoints_request.DescribeEndpointsRequest]",
) -> AsyncOperationResponse[
"capo_timestream_query.types.describe_endpoints_response.DescribeEndpointsResponse"
]:
import capo_timestream_query._operations.timestream_20181101.describe_endpoints
(
output,
http_response,
) = await capo_timestream_query._operations.timestream_20181101.describe_endpoints.async_describe_endpoints(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeEndpoints")
)
input_: capo_timestream_query.types.describe_endpoints_request.DescribeEndpointsRequest = {}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|