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.IoTSecureTunneling.DescribeTunnel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about a tunnel identified by the unique tunnel id.

Requires permission to access the DescribeTunnel action.

Creating a Request

data DescribeTunnel Source #

See: newDescribeTunnel smart constructor.

Constructors

DescribeTunnel'
Fields tunnelId :: Text The tunnel to describe.

Instances

Instances details

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

newDescribeTunnel Source #

Arguments

:: Text	`DescribeTunnel`
-> DescribeTunnel

Create a value of DescribeTunnel 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:

DescribeTunnel, describeTunnel_tunnelId - The tunnel to describe.

Request Lenses

describeTunnel_tunnelId :: Lens' DescribeTunnel Text Source #

The tunnel to describe.

Destructuring the Response

data DescribeTunnelResponse Source #

See: newDescribeTunnelResponse smart constructor.

Constructors

DescribeTunnelResponse'
Fields tunnel :: Maybe Tunnel The tunnel being described. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeTunnelResponse Source #

Arguments

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

Create a value of DescribeTunnelResponse 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:tunnel:DescribeTunnelResponse', describeTunnelResponse_tunnel - The tunnel being described.

$sel:httpStatus:DescribeTunnelResponse', describeTunnelResponse_httpStatus - The response's http status code.

Response Lenses

describeTunnelResponse_tunnel :: Lens' DescribeTunnelResponse (Maybe Tunnel) Source #

The tunnel being described.

describeTunnelResponse_httpStatus :: Lens' DescribeTunnelResponse Int Source #

The response's http status code.