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.CloseTunnel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Closes a tunnel identified by the unique tunnel id. When a CloseTunnel request is received, we close the WebSocket connections between the client and proxy server so no data can be transmitted.

Requires permission to access the CloseTunnel action.

Synopsis

data CloseTunnel = CloseTunnel' {
- delete' :: Maybe Bool
- tunnelId :: Text
}
newCloseTunnel :: Text -> CloseTunnel
closeTunnel_delete :: Lens' CloseTunnel (Maybe Bool)
closeTunnel_tunnelId :: Lens' CloseTunnel Text
data CloseTunnelResponse = CloseTunnelResponse' {
- httpStatus :: Int
}
newCloseTunnelResponse :: Int -> CloseTunnelResponse
closeTunnelResponse_httpStatus :: Lens' CloseTunnelResponse Int

Creating a Request

data CloseTunnel Source #

See: newCloseTunnel smart constructor.

Constructors

CloseTunnel'
Fields delete' :: Maybe Bool When set to true, IoT Secure Tunneling deletes the tunnel data immediately. tunnelId :: Text The ID of the tunnel to close.

Instances

Instances details

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

newCloseTunnel Source #

Arguments

:: Text	`CloseTunnel`
-> CloseTunnel

Create a value of CloseTunnel 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:delete':CloseTunnel', closeTunnel_delete - When set to true, IoT Secure Tunneling deletes the tunnel data immediately.

CloseTunnel, closeTunnel_tunnelId - The ID of the tunnel to close.

Request Lenses

closeTunnel_delete :: Lens' CloseTunnel (Maybe Bool) Source #

When set to true, IoT Secure Tunneling deletes the tunnel data immediately.

closeTunnel_tunnelId :: Lens' CloseTunnel Text Source #

The ID of the tunnel to close.

Destructuring the Response

data CloseTunnelResponse Source #

See: newCloseTunnelResponse smart constructor.

Constructors

CloseTunnelResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCloseTunnelResponse Source #

Arguments

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

Create a value of CloseTunnelResponse 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:CloseTunnelResponse', closeTunnelResponse_httpStatus - The response's http status code.

Response Lenses

closeTunnelResponse_httpStatus :: Lens' CloseTunnelResponse Int Source #

The response's http status code.