amazonka-iotsecuretunneling-2.0: Amazon IoT Secure Tunneling 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.IoTSecureTunneling.CloseTunnel

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

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

ToHeaders CloseTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.CloseTunnel

Methods

toHeaders :: CloseTunnel -> [Header] #

ToPath CloseTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.CloseTunnel

ToQuery CloseTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.CloseTunnel

AWSRequest CloseTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.CloseTunnel

Associated Types

type AWSResponse CloseTunnel #

Generic CloseTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.CloseTunnel

Associated Types

type Rep CloseTunnel :: Type -> Type #

Read CloseTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.CloseTunnel

Show CloseTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.CloseTunnel

NFData CloseTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.CloseTunnel

Methods

rnf :: CloseTunnel -> () #

Eq CloseTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.CloseTunnel

Hashable CloseTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.CloseTunnel

type AWSResponse CloseTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.CloseTunnel

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 #

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

Instances

Instances details
Generic CloseTunnelResponse Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.CloseTunnel

Associated Types

type Rep CloseTunnelResponse :: Type -> Type #

Read CloseTunnelResponse Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.CloseTunnel

Show CloseTunnelResponse Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.CloseTunnel

NFData CloseTunnelResponse Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.CloseTunnel

Methods

rnf :: CloseTunnelResponse -> () #

Eq CloseTunnelResponse Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.CloseTunnel

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 #

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