github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/iotsecuretunneling/2018-10-05/docs-2.json (about)

     1  {
     2    "version": "2.0",
     3    "service": "<fullname>AWS IoT Secure Tunneling</fullname> <p>AWS IoT Secure Tunnling enables you to create remote connections to devices deployed in the field.</p> <p>For more information about how AWS IoT Secure Tunneling works, see <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html\">AWS IoT Secure Tunneling</a>.</p>",
     4    "operations": {
     5      "CloseTunnel": "<p>Closes a tunnel identified by the unique tunnel id. When a <code>CloseTunnel</code> request is received, we close the WebSocket connections between the client and proxy server so no data can be transmitted.</p>",
     6      "DescribeTunnel": "<p>Gets information about a tunnel identified by the unique tunnel id.</p>",
     7      "ListTagsForResource": "<p>Lists the tags for the specified resource.</p>",
     8      "ListTunnels": "<p>List all tunnels for an AWS account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels.</p>",
     9      "OpenTunnel": "<p>Creates a new tunnel, and returns two client access tokens for clients to use to connect to the AWS IoT Secure Tunneling proxy server.</p>",
    10      "TagResource": "<p>A resource tag.</p>",
    11      "UntagResource": "<p>Removes a tag from a resource.</p>"
    12    },
    13    "shapes": {
    14      "AmazonResourceName": {
    15        "base": null,
    16        "refs": {
    17          "ListTagsForResourceRequest$resourceArn": "<p>The resource ARN.</p>",
    18          "TagResourceRequest$resourceArn": "<p>The ARN of the resource.</p>",
    19          "UntagResourceRequest$resourceArn": "<p>The resource ARN.</p>"
    20        }
    21      },
    22      "ClientAccessToken": {
    23        "base": null,
    24        "refs": {
    25          "OpenTunnelResponse$sourceAccessToken": "<p>The access token the source local proxy uses to connect to AWS IoT Secure Tunneling.</p>",
    26          "OpenTunnelResponse$destinationAccessToken": "<p>The access token the destination local proxy uses to connect to AWS IoT Secure Tunneling.</p>"
    27        }
    28      },
    29      "CloseTunnelRequest": {
    30        "base": null,
    31        "refs": {
    32        }
    33      },
    34      "CloseTunnelResponse": {
    35        "base": null,
    36        "refs": {
    37        }
    38      },
    39      "ConnectionState": {
    40        "base": "<p>The state of a connection.</p>",
    41        "refs": {
    42          "Tunnel$sourceConnectionState": "<p>The connection state of the source application.</p>",
    43          "Tunnel$destinationConnectionState": "<p>The connection state of the destination application.</p>"
    44        }
    45      },
    46      "ConnectionStatus": {
    47        "base": null,
    48        "refs": {
    49          "ConnectionState$status": "<p>The connection status of the tunnel. Valid values are <code>CONNECTED</code> and <code>DISCONNECTED</code>.</p>"
    50        }
    51      },
    52      "DateType": {
    53        "base": null,
    54        "refs": {
    55          "ConnectionState$lastUpdatedAt": "<p>The last time the connection status was updated.</p>",
    56          "Tunnel$createdAt": "<p>The time when the tunnel was created.</p>",
    57          "Tunnel$lastUpdatedAt": "<p>The last time the tunnel was updated.</p>",
    58          "TunnelSummary$createdAt": "<p>The time the tunnel was created.</p>",
    59          "TunnelSummary$lastUpdatedAt": "<p>The time the tunnel was last updated.</p>"
    60        }
    61      },
    62      "DeleteFlag": {
    63        "base": null,
    64        "refs": {
    65          "CloseTunnelRequest$delete": "<p>When set to true, AWS IoT Secure Tunneling deletes the tunnel data immediately.</p>"
    66        }
    67      },
    68      "DescribeTunnelRequest": {
    69        "base": null,
    70        "refs": {
    71        }
    72      },
    73      "DescribeTunnelResponse": {
    74        "base": null,
    75        "refs": {
    76        }
    77      },
    78      "Description": {
    79        "base": null,
    80        "refs": {
    81          "OpenTunnelRequest$description": "<p>A short text description of the tunnel. </p>",
    82          "Tunnel$description": "<p>A description of the tunnel.</p>",
    83          "TunnelSummary$description": "<p>A description of the tunnel.</p>"
    84        }
    85      },
    86      "DestinationConfig": {
    87        "base": "<p>The destination configuration.</p>",
    88        "refs": {
    89          "OpenTunnelRequest$destinationConfig": "<p>The destination configuration for the OpenTunnel request.</p>",
    90          "Tunnel$destinationConfig": "<p>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.</p>"
    91        }
    92      },
    93      "ErrorMessage": {
    94        "base": null,
    95        "refs": {
    96          "LimitExceededException$message": null,
    97          "ResourceNotFoundException$message": null
    98        }
    99      },
   100      "LimitExceededException": {
   101        "base": "<p>Thrown when a tunnel limit is exceeded.</p>",
   102        "refs": {
   103        }
   104      },
   105      "ListTagsForResourceRequest": {
   106        "base": null,
   107        "refs": {
   108        }
   109      },
   110      "ListTagsForResourceResponse": {
   111        "base": null,
   112        "refs": {
   113        }
   114      },
   115      "ListTunnelsRequest": {
   116        "base": null,
   117        "refs": {
   118        }
   119      },
   120      "ListTunnelsResponse": {
   121        "base": null,
   122        "refs": {
   123        }
   124      },
   125      "MaxResults": {
   126        "base": null,
   127        "refs": {
   128          "ListTunnelsRequest$maxResults": "<p>The maximum number of results to return at once.</p>"
   129        }
   130      },
   131      "NextToken": {
   132        "base": null,
   133        "refs": {
   134          "ListTunnelsRequest$nextToken": "<p>A token to retrieve the next set of results.</p>",
   135          "ListTunnelsResponse$nextToken": "<p>A token to used to retrieve the next set of results.</p>"
   136        }
   137      },
   138      "OpenTunnelRequest": {
   139        "base": null,
   140        "refs": {
   141        }
   142      },
   143      "OpenTunnelResponse": {
   144        "base": null,
   145        "refs": {
   146        }
   147      },
   148      "ResourceNotFoundException": {
   149        "base": "<p>Thrown when an operation is attempted on a resource that does not exist.</p>",
   150        "refs": {
   151        }
   152      },
   153      "Service": {
   154        "base": null,
   155        "refs": {
   156          "ServiceList$member": null
   157        }
   158      },
   159      "ServiceList": {
   160        "base": null,
   161        "refs": {
   162          "DestinationConfig$services": "<p>A list of service names that identity the target application. The AWS 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 AWS IoT client instantiates the local proxy which uses this information to connect to the destination application.</p>"
   163        }
   164      },
   165      "Tag": {
   166        "base": "<p>An arbitary key/value pair used to add searchable metadata to secure tunnel resources.</p>",
   167        "refs": {
   168          "TagList$member": null
   169        }
   170      },
   171      "TagKey": {
   172        "base": null,
   173        "refs": {
   174          "Tag$key": "<p>The key of the tag.</p>",
   175          "TagKeyList$member": null
   176        }
   177      },
   178      "TagKeyList": {
   179        "base": null,
   180        "refs": {
   181          "UntagResourceRequest$tagKeys": "<p>The keys of the tags to remove.</p>"
   182        }
   183      },
   184      "TagList": {
   185        "base": null,
   186        "refs": {
   187          "ListTagsForResourceResponse$tags": "<p>The tags for the specified resource.</p>",
   188          "OpenTunnelRequest$tags": "<p>A collection of tag metadata.</p>",
   189          "TagResourceRequest$tags": "<p>The tags for the resource.</p>",
   190          "Tunnel$tags": "<p>A list of tag metadata associated with the secure tunnel.</p>"
   191        }
   192      },
   193      "TagResourceRequest": {
   194        "base": null,
   195        "refs": {
   196        }
   197      },
   198      "TagResourceResponse": {
   199        "base": null,
   200        "refs": {
   201        }
   202      },
   203      "TagValue": {
   204        "base": null,
   205        "refs": {
   206          "Tag$value": "<p>The value of the tag.</p>"
   207        }
   208      },
   209      "ThingName": {
   210        "base": null,
   211        "refs": {
   212          "DestinationConfig$thingName": "<p>The name of the IoT thing to which you want to connect.</p>",
   213          "ListTunnelsRequest$thingName": "<p>The name of the IoT thing associated with the destination device.</p>"
   214        }
   215      },
   216      "TimeoutConfig": {
   217        "base": "<p>Tunnel timeout configuration.</p>",
   218        "refs": {
   219          "OpenTunnelRequest$timeoutConfig": "<p>Timeout configuration for a tunnel.</p>",
   220          "Tunnel$timeoutConfig": "<p>Timeout configuration for the tunnel.</p>"
   221        }
   222      },
   223      "TimeoutInMin": {
   224        "base": null,
   225        "refs": {
   226          "TimeoutConfig$maxLifetimeTimeoutMinutes": "<p>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) </p>"
   227        }
   228      },
   229      "Tunnel": {
   230        "base": "<p>A connection between a source computer and a destination device.</p>",
   231        "refs": {
   232          "DescribeTunnelResponse$tunnel": "<p>The tunnel being described.</p>"
   233        }
   234      },
   235      "TunnelArn": {
   236        "base": null,
   237        "refs": {
   238          "OpenTunnelResponse$tunnelArn": "<p>The Amazon Resource Name for the tunnel. The tunnel ARN format is <code>arn:aws:tunnel:&lt;region&gt;:&lt;account-id&gt;:tunnel/&lt;tunnel-id&gt;</code> </p>",
   239          "Tunnel$tunnelArn": "<p>The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is <code>arn:aws:tunnel:&lt;region&gt;:&lt;account-id&gt;:tunnel/&lt;tunnel-id&gt;</code> </p>",
   240          "TunnelSummary$tunnelArn": "<p>The Amazon Resource Name of the tunnel. The tunnel ARN format is <code>arn:aws:tunnel:&lt;region&gt;:&lt;account-id&gt;:tunnel/&lt;tunnel-id&gt;</code> </p>"
   241        }
   242      },
   243      "TunnelId": {
   244        "base": null,
   245        "refs": {
   246          "CloseTunnelRequest$tunnelId": "<p>The ID of the tunnel to close.</p>",
   247          "DescribeTunnelRequest$tunnelId": "<p>The tunnel to describe.</p>",
   248          "OpenTunnelResponse$tunnelId": "<p>A unique alpha-numeric tunnel ID.</p>",
   249          "Tunnel$tunnelId": "<p>A unique alpha-numeric ID that identifies a tunnel.</p>",
   250          "TunnelSummary$tunnelId": "<p>The unique alpha-numeric identifier for the tunnel.</p>"
   251        }
   252      },
   253      "TunnelStatus": {
   254        "base": null,
   255        "refs": {
   256          "Tunnel$status": "<p>The status of a tunnel. Valid values are: Open and Closed.</p>",
   257          "TunnelSummary$status": "<p>The status of a tunnel. Valid values are: Open and Closed.</p>"
   258        }
   259      },
   260      "TunnelSummary": {
   261        "base": "<p>Information about the tunnel.</p>",
   262        "refs": {
   263          "TunnelSummaryList$member": null
   264        }
   265      },
   266      "TunnelSummaryList": {
   267        "base": null,
   268        "refs": {
   269          "ListTunnelsResponse$tunnelSummaries": "<p>A short description of the tunnels in an AWS account.</p>"
   270        }
   271      },
   272      "UntagResourceRequest": {
   273        "base": null,
   274        "refs": {
   275        }
   276      },
   277      "UntagResourceResponse": {
   278        "base": null,
   279        "refs": {
   280        }
   281      }
   282    }
   283  }