TimestreamWrite / Client / describe_endpoints

describe_endpoints#

TimestreamWrite.Client.describe_endpoints()#

Returns a list of available endpoints to make Timestream API calls against. This API operation is available through both the Write and Query APIs.

Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, we don’t recommend that you use this API operation 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

TimestreamWrite.Client.exceptions.InternalServerException
TimestreamWrite.Client.exceptions.ValidationException
TimestreamWrite.Client.exceptions.ThrottlingException