- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeEndpointsCommand
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:
-
You are using VPC endpoints (Amazon Web Services PrivateLink) with Timestream
-
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 and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern .
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { TimestreamQueryClient, DescribeEndpointsCommand } from "@aws-sdk/client-timestream-query"; // ES Modules import
// const { TimestreamQueryClient, DescribeEndpointsCommand } = require("@aws-sdk/client-timestream-query"); // CommonJS import
const client = new TimestreamQueryClient(config);
const input = {};
const command = new DescribeEndpointsCommand(input);
const response = await client.send(command);
// { // DescribeEndpointsResponse
// Endpoints: [ // Endpoints // required
// { // Endpoint
// Address: "STRING_VALUE", // required
// CachePeriodInMinutes: Number("long"), // required
// },
// ],
// };
DescribeEndpointsCommand Input
DescribeEndpointsCommandInput extends DescribeEndpointsRequest DescribeEndpointsCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
EndpointsRequired | Endpoint[] | undefined | An |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalServerException | server | An internal server error occurred while processing the request. |
| ThrottlingException | client | The request was throttled due to excessive requests. |
| ValidationException | client | Invalid or malformed request. |
| TimestreamQueryServiceException | Base exception class for all service exceptions from TimestreamQuery service. |