Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.TimeStreamQuery.DescribeEndpoints

Contents

Creating a Request
Destructuring the Response
Response Lenses

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.

Creating a Request

data DescribeEndpoints Source #

See: newDescribeEndpoints smart constructor.

Constructors

DescribeEndpoints'

Instances

Instances details

ToJSON DescribeEndpoints Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints Methods toJSON :: DescribeEndpoints -> Value # toEncoding :: DescribeEndpoints -> Encoding # toJSONList :: [DescribeEndpoints] -> Value # toEncodingList :: [DescribeEndpoints] -> Encoding #
ToHeaders DescribeEndpoints Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints Methods toHeaders :: DescribeEndpoints -> [Header] #
ToPath DescribeEndpoints Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints Methods toPath :: DescribeEndpoints -> ByteString #
ToQuery DescribeEndpoints Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints Methods toQuery :: DescribeEndpoints -> QueryString #
AWSRequest DescribeEndpoints Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints Associated Types type AWSResponse DescribeEndpoints # Methods request :: (Service -> Service) -> DescribeEndpoints -> Request DescribeEndpoints # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEndpoints -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEndpoints))) #
Generic DescribeEndpoints Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints Associated Types type Rep DescribeEndpoints :: Type -> Type # Methods from :: DescribeEndpoints -> Rep DescribeEndpoints x # to :: Rep DescribeEndpoints x -> DescribeEndpoints #
Read DescribeEndpoints Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints Methods readsPrec :: Int -> ReadS DescribeEndpoints # readList :: ReadS [DescribeEndpoints] # readPrec :: ReadPrec DescribeEndpoints # readListPrec :: ReadPrec [DescribeEndpoints] #
Show DescribeEndpoints Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints Methods showsPrec :: Int -> DescribeEndpoints -> ShowS # show :: DescribeEndpoints -> String # showList :: [DescribeEndpoints] -> ShowS #
NFData DescribeEndpoints Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints Methods rnf :: DescribeEndpoints -> () #
Eq DescribeEndpoints Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints Methods (==) :: DescribeEndpoints -> DescribeEndpoints -> Bool # (/=) :: DescribeEndpoints -> DescribeEndpoints -> Bool #
Hashable DescribeEndpoints Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints Methods hashWithSalt :: Int -> DescribeEndpoints -> Int # hash :: DescribeEndpoints -> Int #
type AWSResponse DescribeEndpoints Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints type AWSResponse DescribeEndpoints = DescribeEndpointsResponse
type Rep DescribeEndpoints Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints type Rep DescribeEndpoints = D1 ('MetaData "DescribeEndpoints" "Amazonka.TimeStreamQuery.DescribeEndpoints" "amazonka-timestream-query-2.0-HD7xx47Lw3eG6c52GyReXL" 'False) (C1 ('MetaCons "DescribeEndpoints'" 'PrefixI 'False) (U1 :: Type -> Type))

newDescribeEndpoints :: DescribeEndpoints Source #

Create a value of DescribeEndpoints with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

Destructuring the Response

data DescribeEndpointsResponse Source #

See: newDescribeEndpointsResponse smart constructor.

Constructors

DescribeEndpointsResponse'
Fields httpStatus :: Int The response's http status code. endpoints :: [Endpoint] An `Endpoints` object is returned when a `DescribeEndpoints` request is made.

Instances

Instances details

Generic DescribeEndpointsResponse Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints Associated Types type Rep DescribeEndpointsResponse :: Type -> Type # Methods from :: DescribeEndpointsResponse -> Rep DescribeEndpointsResponse x # to :: Rep DescribeEndpointsResponse x -> DescribeEndpointsResponse #
Read DescribeEndpointsResponse Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints Methods readsPrec :: Int -> ReadS DescribeEndpointsResponse # readList :: ReadS [DescribeEndpointsResponse] # readPrec :: ReadPrec DescribeEndpointsResponse # readListPrec :: ReadPrec [DescribeEndpointsResponse] #
Show DescribeEndpointsResponse Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints Methods showsPrec :: Int -> DescribeEndpointsResponse -> ShowS # show :: DescribeEndpointsResponse -> String # showList :: [DescribeEndpointsResponse] -> ShowS #
NFData DescribeEndpointsResponse Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints Methods rnf :: DescribeEndpointsResponse -> () #
Eq DescribeEndpointsResponse Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints Methods (==) :: DescribeEndpointsResponse -> DescribeEndpointsResponse -> Bool # (/=) :: DescribeEndpointsResponse -> DescribeEndpointsResponse -> Bool #
type Rep DescribeEndpointsResponse Source #
Instance details Defined in Amazonka.TimeStreamQuery.DescribeEndpoints type Rep DescribeEndpointsResponse = D1 ('MetaData "DescribeEndpointsResponse" "Amazonka.TimeStreamQuery.DescribeEndpoints" "amazonka-timestream-query-2.0-HD7xx47Lw3eG6c52GyReXL" 'False) (C1 ('MetaCons "DescribeEndpointsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "endpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Endpoint])))

newDescribeEndpointsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeEndpointsResponse'`
-> DescribeEndpointsResponse

Create a value of DescribeEndpointsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribeEndpointsResponse', describeEndpointsResponse_httpStatus - The response's http status code.

$sel:endpoints:DescribeEndpointsResponse', describeEndpointsResponse_endpoints - An Endpoints object is returned when a DescribeEndpoints request is made.

Response Lenses

describeEndpointsResponse_httpStatus :: Lens' DescribeEndpointsResponse Int Source #

The response's http status code.

describeEndpointsResponse_endpoints :: Lens' DescribeEndpointsResponse [Endpoint] Source #

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