libZSservicesZSamazonka-iotsecuretunnelingZSamazonka-iotsecuretunneling
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTSecureTunneling.OpenTunnel

Description

Creates a new tunnel, and returns two client access tokens for clients to use to connect to the AWS IoT Secure Tunneling proxy server.

Synopsis

Creating a Request

data OpenTunnel Source #

See: newOpenTunnel smart constructor.

Constructors

OpenTunnel' 

Fields

Instances

Instances details
Eq OpenTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.OpenTunnel

Read OpenTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.OpenTunnel

Show OpenTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.OpenTunnel

Generic OpenTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.OpenTunnel

Associated Types

type Rep OpenTunnel :: Type -> Type #

NFData OpenTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.OpenTunnel

Methods

rnf :: OpenTunnel -> () #

Hashable OpenTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.OpenTunnel

ToJSON OpenTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.OpenTunnel

AWSRequest OpenTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.OpenTunnel

Associated Types

type AWSResponse OpenTunnel #

ToHeaders OpenTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.OpenTunnel

Methods

toHeaders :: OpenTunnel -> [Header] #

ToPath OpenTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.OpenTunnel

ToQuery OpenTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.OpenTunnel

type Rep OpenTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.OpenTunnel

type Rep OpenTunnel = D1 ('MetaData "OpenTunnel" "Amazonka.IoTSecureTunneling.OpenTunnel" "libZSservicesZSamazonka-iotsecuretunnelingZSamazonka-iotsecuretunneling" 'False) (C1 ('MetaCons "OpenTunnel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "destinationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DestinationConfig)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "timeoutConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeoutConfig)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))))))
type AWSResponse OpenTunnel Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.OpenTunnel

newOpenTunnel :: OpenTunnel Source #

Create a value of OpenTunnel 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:destinationConfig:OpenTunnel', openTunnel_destinationConfig - The destination configuration for the OpenTunnel request.

$sel:description:OpenTunnel', openTunnel_description - A short text description of the tunnel.

$sel:timeoutConfig:OpenTunnel', openTunnel_timeoutConfig - Timeout configuration for a tunnel.

$sel:tags:OpenTunnel', openTunnel_tags - A collection of tag metadata.

Request Lenses

openTunnel_destinationConfig :: Lens' OpenTunnel (Maybe DestinationConfig) Source #

The destination configuration for the OpenTunnel request.

openTunnel_description :: Lens' OpenTunnel (Maybe Text) Source #

A short text description of the tunnel.

openTunnel_timeoutConfig :: Lens' OpenTunnel (Maybe TimeoutConfig) Source #

Timeout configuration for a tunnel.

openTunnel_tags :: Lens' OpenTunnel (Maybe (NonEmpty Tag)) Source #

A collection of tag metadata.

Destructuring the Response

data OpenTunnelResponse Source #

See: newOpenTunnelResponse smart constructor.

Constructors

OpenTunnelResponse' 

Fields

Instances

Instances details
Eq OpenTunnelResponse Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.OpenTunnel

Show OpenTunnelResponse Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.OpenTunnel

Generic OpenTunnelResponse Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.OpenTunnel

Associated Types

type Rep OpenTunnelResponse :: Type -> Type #

NFData OpenTunnelResponse Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.OpenTunnel

Methods

rnf :: OpenTunnelResponse -> () #

type Rep OpenTunnelResponse Source # 
Instance details

Defined in Amazonka.IoTSecureTunneling.OpenTunnel

type Rep OpenTunnelResponse = D1 ('MetaData "OpenTunnelResponse" "Amazonka.IoTSecureTunneling.OpenTunnel" "libZSservicesZSamazonka-iotsecuretunnelingZSamazonka-iotsecuretunneling" 'False) (C1 ('MetaCons "OpenTunnelResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sourceAccessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "tunnelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "destinationAccessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "tunnelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newOpenTunnelResponse Source #

Create a value of OpenTunnelResponse 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:sourceAccessToken:OpenTunnelResponse', openTunnelResponse_sourceAccessToken - The access token the source local proxy uses to connect to AWS IoT Secure Tunneling.

$sel:tunnelArn:OpenTunnelResponse', openTunnelResponse_tunnelArn - The Amazon Resource Name for the tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>

$sel:destinationAccessToken:OpenTunnelResponse', openTunnelResponse_destinationAccessToken - The access token the destination local proxy uses to connect to AWS IoT Secure Tunneling.

$sel:tunnelId:OpenTunnelResponse', openTunnelResponse_tunnelId - A unique alpha-numeric tunnel ID.

$sel:httpStatus:OpenTunnelResponse', openTunnelResponse_httpStatus - The response's http status code.

Response Lenses

openTunnelResponse_sourceAccessToken :: Lens' OpenTunnelResponse (Maybe Text) Source #

The access token the source local proxy uses to connect to AWS IoT Secure Tunneling.

openTunnelResponse_tunnelArn :: Lens' OpenTunnelResponse (Maybe Text) Source #

The Amazon Resource Name for the tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>

openTunnelResponse_destinationAccessToken :: Lens' OpenTunnelResponse (Maybe Text) Source #

The access token the destination local proxy uses to connect to AWS IoT Secure Tunneling.

openTunnelResponse_tunnelId :: Lens' OpenTunnelResponse (Maybe Text) Source #

A unique alpha-numeric tunnel ID.