DescribeEndpoints - Amazon Timestream

DescribeEndpoints

DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.

Because Timestream’s 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:

  • Your application uses a programming language that does not yet have SDK support

  • You require better control over the client-side implementation

For detailed information on how to use DescribeEndpoints, see The Endpoint Discovery Pattern and REST APIs.

Response Syntax

{ "Endpoints": [ { "Address": "string", "CachePeriodInMinutes": number } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Endpoints

An Endpoints object is returned when a DescribeEndpoints request is made.

Type: Array of Endpoint objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

Timestream was unable to fully process this request because of an internal server error.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

Invalid or malformed request.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: