amazonka-iot-2.0: Amazon IoT SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoT.DescribeEndpoint

Description

Returns a unique endpoint specific to the Amazon Web Services account making the call.

Requires permission to access the DescribeEndpoint action.

Synopsis

Creating a Request

data DescribeEndpoint Source #

The input for the DescribeEndpoint operation.

See: newDescribeEndpoint smart constructor.

Constructors

DescribeEndpoint' 

Fields

  • endpointType :: Maybe Text

    The endpoint type. Valid endpoint types include:

    • iot:Data - Returns a VeriSign signed data endpoint.
    • iot:Data-ATS - Returns an ATS signed data endpoint.
    • iot:CredentialProvider - Returns an IoT credentials provider API endpoint.
    • iot:Jobs - Returns an IoT device management Jobs API endpoint.

    We strongly recommend that customers use the newer iot:Data-ATS endpoint type to avoid issues related to the widespread distrust of Symantec certificate authorities.

Instances

Instances details
ToHeaders DescribeEndpoint Source # 
Instance details

Defined in Amazonka.IoT.DescribeEndpoint

Methods

toHeaders :: DescribeEndpoint -> [Header] #

ToPath DescribeEndpoint Source # 
Instance details

Defined in Amazonka.IoT.DescribeEndpoint

Methods

toPath :: DescribeEndpoint -> ByteString #

ToQuery DescribeEndpoint Source # 
Instance details

Defined in Amazonka.IoT.DescribeEndpoint

Methods

toQuery :: DescribeEndpoint -> QueryString #

AWSRequest DescribeEndpoint Source # 
Instance details

Defined in Amazonka.IoT.DescribeEndpoint

Associated Types

type AWSResponse DescribeEndpoint #

Methods

request :: (Service -> Service) -> DescribeEndpoint -> Request DescribeEndpoint #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEndpoint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEndpoint))) #

Generic DescribeEndpoint Source # 
Instance details

Defined in Amazonka.IoT.DescribeEndpoint

Associated Types

type Rep DescribeEndpoint :: Type -> Type #

Methods

from :: DescribeEndpoint -> Rep DescribeEndpoint x #

to :: Rep DescribeEndpoint x -> DescribeEndpoint #

Read DescribeEndpoint Source # 
Instance details

Defined in Amazonka.IoT.DescribeEndpoint

Methods

readsPrec :: Int -> ReadS DescribeEndpoint #

readList :: ReadS [DescribeEndpoint] #

readPrec :: ReadPrec DescribeEndpoint #

readListPrec :: ReadPrec [DescribeEndpoint] #

Show DescribeEndpoint Source # 
Instance details

Defined in Amazonka.IoT.DescribeEndpoint

Methods

showsPrec :: Int -> DescribeEndpoint -> ShowS #

show :: DescribeEndpoint -> String #

showList :: [DescribeEndpoint] -> ShowS #

NFData DescribeEndpoint Source # 
Instance details

Defined in Amazonka.IoT.DescribeEndpoint

Methods

rnf :: DescribeEndpoint -> () #

Eq DescribeEndpoint Source # 
Instance details

Defined in Amazonka.IoT.DescribeEndpoint

Methods

(==) :: DescribeEndpoint -> DescribeEndpoint -> Bool #

(/=) :: DescribeEndpoint -> DescribeEndpoint -> Bool #

Hashable DescribeEndpoint Source # 
Instance details

Defined in Amazonka.IoT.DescribeEndpoint

Methods

hashWithSalt :: Int -> DescribeEndpoint -> Int #

hash :: DescribeEndpoint -> Int #

type AWSResponse DescribeEndpoint Source # 
Instance details

Defined in Amazonka.IoT.DescribeEndpoint

type AWSResponse DescribeEndpoint = DescribeEndpointResponse
type Rep DescribeEndpoint Source # 
Instance details

Defined in Amazonka.IoT.DescribeEndpoint

type Rep DescribeEndpoint = D1 ('MetaData "DescribeEndpoint" "Amazonka.IoT.DescribeEndpoint" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DescribeEndpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDescribeEndpoint :: DescribeEndpoint Source #

Create a value of DescribeEndpoint 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:endpointType:DescribeEndpoint', describeEndpoint_endpointType - The endpoint type. Valid endpoint types include:

  • iot:Data - Returns a VeriSign signed data endpoint.
  • iot:Data-ATS - Returns an ATS signed data endpoint.
  • iot:CredentialProvider - Returns an IoT credentials provider API endpoint.
  • iot:Jobs - Returns an IoT device management Jobs API endpoint.

We strongly recommend that customers use the newer iot:Data-ATS endpoint type to avoid issues related to the widespread distrust of Symantec certificate authorities.

Request Lenses

describeEndpoint_endpointType :: Lens' DescribeEndpoint (Maybe Text) Source #

The endpoint type. Valid endpoint types include:

  • iot:Data - Returns a VeriSign signed data endpoint.
  • iot:Data-ATS - Returns an ATS signed data endpoint.
  • iot:CredentialProvider - Returns an IoT credentials provider API endpoint.
  • iot:Jobs - Returns an IoT device management Jobs API endpoint.

We strongly recommend that customers use the newer iot:Data-ATS endpoint type to avoid issues related to the widespread distrust of Symantec certificate authorities.

Destructuring the Response

data DescribeEndpointResponse Source #

The output from the DescribeEndpoint operation.

See: newDescribeEndpointResponse smart constructor.

Constructors

DescribeEndpointResponse' 

Fields

Instances

Instances details
Generic DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.IoT.DescribeEndpoint

Associated Types

type Rep DescribeEndpointResponse :: Type -> Type #

Methods

from :: DescribeEndpointResponse -> Rep DescribeEndpointResponse x #

to :: Rep DescribeEndpointResponse x -> DescribeEndpointResponse #

Read DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.IoT.DescribeEndpoint

Methods

readsPrec :: Int -> ReadS DescribeEndpointResponse #

readList :: ReadS [DescribeEndpointResponse] #

readPrec :: ReadPrec DescribeEndpointResponse #

readListPrec :: ReadPrec [DescribeEndpointResponse] #

Show DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.IoT.DescribeEndpoint

Methods

showsPrec :: Int -> DescribeEndpointResponse -> ShowS #

show :: DescribeEndpointResponse -> String #

showList :: [DescribeEndpointResponse] -> ShowS #

NFData DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.IoT.DescribeEndpoint

Methods

rnf :: DescribeEndpointResponse -> () #

Eq DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.IoT.DescribeEndpoint

Methods

(==) :: DescribeEndpointResponse -> DescribeEndpointResponse -> Bool #

(/=) :: DescribeEndpointResponse -> DescribeEndpointResponse -> Bool #

type Rep DescribeEndpointResponse Source # 
Instance details

Defined in Amazonka.IoT.DescribeEndpoint

type Rep DescribeEndpointResponse = D1 ('MetaData "DescribeEndpointResponse" "Amazonka.IoT.DescribeEndpoint" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DescribeEndpointResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endpointAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeEndpointResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeEndpointResponse'

-> DescribeEndpointResponse 

Create a value of DescribeEndpointResponse 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:endpointAddress:DescribeEndpointResponse', describeEndpointResponse_endpointAddress - The endpoint. The format of the endpoint is as follows: identifier.iot.region.amazonaws.com.

$sel:httpStatus:DescribeEndpointResponse', describeEndpointResponse_httpStatus - The response's http status code.

Response Lenses

describeEndpointResponse_endpointAddress :: Lens' DescribeEndpointResponse (Maybe Text) Source #

The endpoint. The format of the endpoint is as follows: identifier.iot.region.amazonaws.com.

describeEndpointResponse_httpStatus :: Lens' DescribeEndpointResponse Int Source #

The response's http status code.