TimestreamQuery / Client / describe_endpoints

describe_endpoints#

TimestreamQuery.Client.describe_endpoints()#

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.

Request Syntax

response = client.describe_endpoints()

Return type:

dict

Returns:

Response Syntax

{
    'Endpoints': [
        {
            'Address': 'string',
            'CachePeriodInMinutes': 123
        },
    ]
}

Response Structure

(dict) –
- Endpoints (list) –
  
  An Endpoints object is returned when a DescribeEndpoints request is made.
  - (dict) –
    
    Represents an available endpoint against which to make API calls against, as well as the TTL for that endpoint.
    - Address (string) –
      
      An endpoint address.
    - CachePeriodInMinutes (integer) –
      
      The TTL for the endpoint, in minutes.

Exceptions

TimestreamQuery.Client.exceptions.InternalServerException
TimestreamQuery.Client.exceptions.ValidationException
TimestreamQuery.Client.exceptions.ThrottlingException