Describe Endpoints

timestreamquery_describe_endpoints

R Documentation

DescribeEndpoints returns a list of available endpoints to make Timestream API calls against¶

Description¶

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.

Usage¶

timestreamquery_describe_endpoints()

Value¶

A list with the following syntax:

list(
  Endpoints = list(
    list(
      Address = "string",
      CachePeriodInMinutes = 123
    )
  )
)

Request syntax¶

svc$describe_endpoints()