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 |
Derived from API version 2018-10-05
of the AWS service descriptions, licensed under Apache 2.0.
IoT Secure Tunneling
IoT Secure Tunneling creates remote connections to devices deployed in the field.
For more information about how IoT Secure Tunneling works, see IoT Secure Tunneling.
Synopsis
- defaultService :: Service
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- data CloseTunnel = CloseTunnel' (Maybe Bool) Text
- newCloseTunnel :: Text -> CloseTunnel
- data CloseTunnelResponse = CloseTunnelResponse' Int
- newCloseTunnelResponse :: Int -> CloseTunnelResponse
- data DescribeTunnel = DescribeTunnel' Text
- newDescribeTunnel :: Text -> DescribeTunnel
- data DescribeTunnelResponse = DescribeTunnelResponse' (Maybe Tunnel) Int
- newDescribeTunnelResponse :: Int -> DescribeTunnelResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (NonEmpty Tag)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListTunnels = ListTunnels' (Maybe Natural) (Maybe Text) (Maybe Text)
- newListTunnels :: ListTunnels
- data ListTunnelsResponse = ListTunnelsResponse' (Maybe Text) (Maybe [TunnelSummary]) Int
- newListTunnelsResponse :: Int -> ListTunnelsResponse
- data OpenTunnel = OpenTunnel' (Maybe Text) (Maybe DestinationConfig) (Maybe (NonEmpty Tag)) (Maybe TimeoutConfig)
- newOpenTunnel :: OpenTunnel
- data OpenTunnelResponse = OpenTunnelResponse' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) Int
- newOpenTunnelResponse :: Int -> OpenTunnelResponse
- data RotateTunnelAccessToken = RotateTunnelAccessToken' (Maybe DestinationConfig) Text ClientMode
- newRotateTunnelAccessToken :: Text -> ClientMode -> RotateTunnelAccessToken
- data RotateTunnelAccessTokenResponse = RotateTunnelAccessTokenResponse' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) Int
- newRotateTunnelAccessTokenResponse :: Int -> RotateTunnelAccessTokenResponse
- data TagResource = TagResource' Text (NonEmpty Tag)
- newTagResource :: Text -> NonEmpty Tag -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- newtype ClientMode where
- ClientMode' { }
- pattern ClientMode_ALL :: ClientMode
- pattern ClientMode_DESTINATION :: ClientMode
- pattern ClientMode_SOURCE :: ClientMode
- newtype ConnectionStatus where
- ConnectionStatus' { }
- pattern ConnectionStatus_CONNECTED :: ConnectionStatus
- pattern ConnectionStatus_DISCONNECTED :: ConnectionStatus
- newtype TunnelStatus where
- TunnelStatus' { }
- pattern TunnelStatus_CLOSED :: TunnelStatus
- pattern TunnelStatus_OPEN :: TunnelStatus
- data ConnectionState = ConnectionState' (Maybe POSIX) (Maybe ConnectionStatus)
- newConnectionState :: ConnectionState
- data DestinationConfig = DestinationConfig' (Maybe Text) (NonEmpty Text)
- newDestinationConfig :: NonEmpty Text -> DestinationConfig
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data TimeoutConfig = TimeoutConfig' (Maybe Natural)
- newTimeoutConfig :: TimeoutConfig
- data Tunnel = Tunnel' (Maybe POSIX) (Maybe Text) (Maybe DestinationConfig) (Maybe ConnectionState) (Maybe POSIX) (Maybe ConnectionState) (Maybe TunnelStatus) (Maybe (NonEmpty Tag)) (Maybe TimeoutConfig) (Maybe Text) (Maybe Text)
- newTunnel :: Tunnel
- data TunnelSummary = TunnelSummary' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe TunnelStatus) (Maybe Text) (Maybe Text)
- newTunnelSummary :: TunnelSummary
Service Configuration
defaultService :: Service Source #
API version 2018-10-05
of the Amazon IoT Secure Tunneling SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by IoTSecureTunneling
.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
Thrown when a tunnel limit is exceeded.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Thrown when an operation is attempted on a resource that does not exist.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CloseTunnel
data CloseTunnel Source #
See: newCloseTunnel
smart constructor.
Instances
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.
data CloseTunnelResponse Source #
See: newCloseTunnelResponse
smart constructor.
Instances
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.
DescribeTunnel
data DescribeTunnel Source #
See: newDescribeTunnel
smart constructor.
Instances
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.
data DescribeTunnelResponse Source #
See: newDescribeTunnelResponse
smart constructor.
Instances
newDescribeTunnelResponse Source #
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.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
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:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The resource ARN.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:
ListTagsForResourceResponse
, listTagsForResourceResponse_tags
- The tags for the specified resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ListTunnels
data ListTunnels Source #
See: newListTunnels
smart constructor.
Instances
newListTunnels :: ListTunnels Source #
Create a value of ListTunnels
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:maxResults:ListTunnels'
, listTunnels_maxResults
- The maximum number of results to return at once.
ListTunnels
, listTunnels_nextToken
- To retrieve the next set of results, the nextToken value from a previous
response; otherwise null to receive the first set of results.
ListTunnels
, listTunnels_thingName
- The name of the IoT thing associated with the destination device.
data ListTunnelsResponse Source #
See: newListTunnelsResponse
smart constructor.
Instances
newListTunnelsResponse Source #
Create a value of ListTunnelsResponse
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:
ListTunnels
, listTunnelsResponse_nextToken
- The token to use to get the next set of results, or null if there are no
additional results.
$sel:tunnelSummaries:ListTunnelsResponse'
, listTunnelsResponse_tunnelSummaries
- A short description of the tunnels in an Amazon Web Services account.
$sel:httpStatus:ListTunnelsResponse'
, listTunnelsResponse_httpStatus
- The response's http status code.
OpenTunnel
data OpenTunnel Source #
See: newOpenTunnel
smart constructor.
OpenTunnel' (Maybe Text) (Maybe DestinationConfig) (Maybe (NonEmpty Tag)) (Maybe TimeoutConfig) |
Instances
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:
OpenTunnel
, openTunnel_description
- A short text description of the tunnel.
OpenTunnel
, openTunnel_destinationConfig
- The destination configuration for the OpenTunnel request.
OpenTunnel
, openTunnel_tags
- A collection of tag metadata.
OpenTunnel
, openTunnel_timeoutConfig
- Timeout configuration for a tunnel.
data OpenTunnelResponse Source #
See: newOpenTunnelResponse
smart constructor.
Instances
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:destinationAccessToken:OpenTunnelResponse'
, openTunnelResponse_destinationAccessToken
- The access token the destination local proxy uses to connect to IoT
Secure Tunneling.
$sel:sourceAccessToken:OpenTunnelResponse'
, openTunnelResponse_sourceAccessToken
- The access token the source local proxy uses to connect to IoT Secure
Tunneling.
OpenTunnelResponse
, openTunnelResponse_tunnelArn
- The Amazon Resource Name for the tunnel.
OpenTunnelResponse
, openTunnelResponse_tunnelId
- A unique alpha-numeric tunnel ID.
$sel:httpStatus:OpenTunnelResponse'
, openTunnelResponse_httpStatus
- The response's http status code.
RotateTunnelAccessToken
data RotateTunnelAccessToken Source #
See: newRotateTunnelAccessToken
smart constructor.
Instances
newRotateTunnelAccessToken Source #
Create a value of RotateTunnelAccessToken
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:
RotateTunnelAccessToken
, rotateTunnelAccessToken_destinationConfig
- Undocumented member.
RotateTunnelAccessToken
, rotateTunnelAccessToken_tunnelId
- The tunnel for which you want to rotate the access tokens.
$sel:clientMode:RotateTunnelAccessToken'
, rotateTunnelAccessToken_clientMode
- The mode of the client that will use the client token, which can be
either the source or destination, or both source and destination.
data RotateTunnelAccessTokenResponse Source #
See: newRotateTunnelAccessTokenResponse
smart constructor.
Instances
newRotateTunnelAccessTokenResponse Source #
Create a value of RotateTunnelAccessTokenResponse
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:destinationAccessToken:RotateTunnelAccessTokenResponse'
, rotateTunnelAccessTokenResponse_destinationAccessToken
- The client access token that the destination local proxy uses to connect
to IoT Secure Tunneling.
$sel:sourceAccessToken:RotateTunnelAccessTokenResponse'
, rotateTunnelAccessTokenResponse_sourceAccessToken
- The client access token that the source local proxy uses to connect to
IoT Secure Tunneling.
RotateTunnelAccessTokenResponse
, rotateTunnelAccessTokenResponse_tunnelArn
- The Amazon Resource Name for the tunnel.
$sel:httpStatus:RotateTunnelAccessTokenResponse'
, rotateTunnelAccessTokenResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:resourceArn:TagResource'
, tagResource_resourceArn
- The ARN of the resource.
TagResource
, tagResource_tags
- The tags for the resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
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:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:resourceArn:UntagResource'
, untagResource_resourceArn
- The resource ARN.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The keys of the tags to remove.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
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:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
Types
ClientMode
newtype ClientMode Source #
pattern ClientMode_ALL :: ClientMode | |
pattern ClientMode_DESTINATION :: ClientMode | |
pattern ClientMode_SOURCE :: ClientMode |
Instances
ConnectionStatus
newtype ConnectionStatus Source #
pattern ConnectionStatus_CONNECTED :: ConnectionStatus | |
pattern ConnectionStatus_DISCONNECTED :: ConnectionStatus |
Instances
TunnelStatus
newtype TunnelStatus Source #
pattern TunnelStatus_CLOSED :: TunnelStatus | |
pattern TunnelStatus_OPEN :: TunnelStatus |
Instances
ConnectionState
data ConnectionState Source #
The state of a connection.
See: newConnectionState
smart constructor.
Instances
newConnectionState :: ConnectionState Source #
Create a value of ConnectionState
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:lastUpdatedAt:ConnectionState'
, connectionState_lastUpdatedAt
- The last time the connection status was updated.
$sel:status:ConnectionState'
, connectionState_status
- The connection status of the tunnel. Valid values are CONNECTED
and
DISCONNECTED
.
DestinationConfig
data DestinationConfig Source #
The destination configuration.
See: newDestinationConfig
smart constructor.
Instances
Create a value of DestinationConfig
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:thingName:DestinationConfig'
, destinationConfig_thingName
- The name of the IoT thing to which you want to connect.
$sel:services:DestinationConfig'
, destinationConfig_services
- A list of service names that identify the target application. The IoT
client running on the destination device reads this value and uses it to
look up a port or an IP address and a port. The IoT client instantiates
the local proxy, which uses this information to connect to the
destination application.
Tag
An arbitary key/value pair used to add searchable metadata to secure tunnel resources.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.IoTSecureTunneling.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.IoTSecureTunneling.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.IoTSecureTunneling.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.IoTSecureTunneling.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.IoTSecureTunneling.Types.Tag" "amazonka-iotsecuretunneling-2.0-B7tp11579Ld35NvrM5xQuK" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Tag
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:key:Tag'
, tag_key
- The key of the tag.
$sel:value:Tag'
, tag_value
- The value of the tag.
TimeoutConfig
data TimeoutConfig Source #
Tunnel timeout configuration.
See: newTimeoutConfig
smart constructor.
Instances
newTimeoutConfig :: TimeoutConfig Source #
Create a value of TimeoutConfig
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:maxLifetimeTimeoutMinutes:TimeoutConfig'
, timeoutConfig_maxLifetimeTimeoutMinutes
- The maximum amount of time (in minutes) a tunnel can remain open. If not
specified, maxLifetimeTimeoutMinutes defaults to 720 minutes. Valid
values are from 1 minute to 12 hours (720 minutes)
Tunnel
A connection between a source computer and a destination device.
See: newTunnel
smart constructor.
Tunnel' (Maybe POSIX) (Maybe Text) (Maybe DestinationConfig) (Maybe ConnectionState) (Maybe POSIX) (Maybe ConnectionState) (Maybe TunnelStatus) (Maybe (NonEmpty Tag)) (Maybe TimeoutConfig) (Maybe Text) (Maybe Text) |
Instances
Create a value of Tunnel
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:createdAt:Tunnel'
, tunnel_createdAt
- The time when the tunnel was created.
$sel:description:Tunnel'
, tunnel_description
- A description of the tunnel.
$sel:destinationConfig:Tunnel'
, tunnel_destinationConfig
- The destination configuration that specifies the thing name of the
destination device and a service name that the local proxy uses to
connect to the destination application.
$sel:destinationConnectionState:Tunnel'
, tunnel_destinationConnectionState
- The connection state of the destination application.
Tunnel
, tunnel_lastUpdatedAt
- The last time the tunnel was updated.
$sel:sourceConnectionState:Tunnel'
, tunnel_sourceConnectionState
- The connection state of the source application.
Tunnel
, tunnel_status
- The status of a tunnel. Valid values are: Open and Closed.
$sel:tags:Tunnel'
, tunnel_tags
- A list of tag metadata associated with the secure tunnel.
$sel:timeoutConfig:Tunnel'
, tunnel_timeoutConfig
- Timeout configuration for the tunnel.
$sel:tunnelArn:Tunnel'
, tunnel_tunnelArn
- The Amazon Resource Name (ARN) of a tunnel.
$sel:tunnelId:Tunnel'
, tunnel_tunnelId
- A unique alpha-numeric ID that identifies a tunnel.
TunnelSummary
data TunnelSummary Source #
Information about the tunnel.
See: newTunnelSummary
smart constructor.
TunnelSummary' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe TunnelStatus) (Maybe Text) (Maybe Text) |
Instances
newTunnelSummary :: TunnelSummary Source #
Create a value of TunnelSummary
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:createdAt:TunnelSummary'
, tunnelSummary_createdAt
- The time the tunnel was created.
$sel:description:TunnelSummary'
, tunnelSummary_description
- A description of the tunnel.
$sel:lastUpdatedAt:TunnelSummary'
, tunnelSummary_lastUpdatedAt
- The time the tunnel was last updated.
$sel:status:TunnelSummary'
, tunnelSummary_status
- The status of a tunnel. Valid values are: Open and Closed.
$sel:tunnelArn:TunnelSummary'
, tunnelSummary_tunnelArn
- The Amazon Resource Name of the tunnel.
$sel:tunnelId:TunnelSummary'
, tunnelSummary_tunnelId
- The unique alpha-numeric identifier for the tunnel.