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

     1  {
     2    "version":"2.0",
     3    "metadata":{
     4      "apiVersion":"2018-10-05",
     5      "endpointPrefix":"api.tunneling.iot",
     6      "jsonVersion":"1.1",
     7      "protocol":"json",
     8      "serviceFullName":"AWS IoT Secure Tunneling",
     9      "serviceId":"IoTSecureTunneling",
    10      "signatureVersion":"v4",
    11      "signingName":"IoTSecuredTunneling",
    12      "targetPrefix":"IoTSecuredTunneling",
    13      "uid":"iotsecuretunneling-2018-10-05"
    14    },
    15    "operations":{
    16      "CloseTunnel":{
    17        "name":"CloseTunnel",
    18        "http":{
    19          "method":"POST",
    20          "requestUri":"/"
    21        },
    22        "input":{"shape":"CloseTunnelRequest"},
    23        "output":{"shape":"CloseTunnelResponse"},
    24        "errors":[
    25          {"shape":"ResourceNotFoundException"}
    26        ]
    27      },
    28      "DescribeTunnel":{
    29        "name":"DescribeTunnel",
    30        "http":{
    31          "method":"POST",
    32          "requestUri":"/"
    33        },
    34        "input":{"shape":"DescribeTunnelRequest"},
    35        "output":{"shape":"DescribeTunnelResponse"},
    36        "errors":[
    37          {"shape":"ResourceNotFoundException"}
    38        ]
    39      },
    40      "ListTagsForResource":{
    41        "name":"ListTagsForResource",
    42        "http":{
    43          "method":"POST",
    44          "requestUri":"/"
    45        },
    46        "input":{"shape":"ListTagsForResourceRequest"},
    47        "output":{"shape":"ListTagsForResourceResponse"},
    48        "errors":[
    49          {"shape":"ResourceNotFoundException"}
    50        ]
    51      },
    52      "ListTunnels":{
    53        "name":"ListTunnels",
    54        "http":{
    55          "method":"POST",
    56          "requestUri":"/"
    57        },
    58        "input":{"shape":"ListTunnelsRequest"},
    59        "output":{"shape":"ListTunnelsResponse"}
    60      },
    61      "OpenTunnel":{
    62        "name":"OpenTunnel",
    63        "http":{
    64          "method":"POST",
    65          "requestUri":"/"
    66        },
    67        "input":{"shape":"OpenTunnelRequest"},
    68        "output":{"shape":"OpenTunnelResponse"},
    69        "errors":[
    70          {"shape":"LimitExceededException"}
    71        ]
    72      },
    73      "TagResource":{
    74        "name":"TagResource",
    75        "http":{
    76          "method":"POST",
    77          "requestUri":"/"
    78        },
    79        "input":{"shape":"TagResourceRequest"},
    80        "output":{"shape":"TagResourceResponse"},
    81        "errors":[
    82          {"shape":"ResourceNotFoundException"}
    83        ]
    84      },
    85      "UntagResource":{
    86        "name":"UntagResource",
    87        "http":{
    88          "method":"POST",
    89          "requestUri":"/"
    90        },
    91        "input":{"shape":"UntagResourceRequest"},
    92        "output":{"shape":"UntagResourceResponse"},
    93        "errors":[
    94          {"shape":"ResourceNotFoundException"}
    95        ]
    96      }
    97    },
    98    "shapes":{
    99      "AmazonResourceName":{
   100        "type":"string",
   101        "max":1011,
   102        "min":1
   103      },
   104      "ClientAccessToken":{
   105        "type":"string",
   106        "sensitive":true
   107      },
   108      "CloseTunnelRequest":{
   109        "type":"structure",
   110        "required":["tunnelId"],
   111        "members":{
   112          "tunnelId":{"shape":"TunnelId"},
   113          "delete":{
   114            "shape":"DeleteFlag",
   115            "box":true
   116          }
   117        }
   118      },
   119      "CloseTunnelResponse":{
   120        "type":"structure",
   121        "members":{
   122        }
   123      },
   124      "ConnectionState":{
   125        "type":"structure",
   126        "members":{
   127          "status":{"shape":"ConnectionStatus"},
   128          "lastUpdatedAt":{"shape":"DateType"}
   129        }
   130      },
   131      "ConnectionStatus":{
   132        "type":"string",
   133        "enum":[
   134          "CONNECTED",
   135          "DISCONNECTED"
   136        ]
   137      },
   138      "DateType":{"type":"timestamp"},
   139      "DeleteFlag":{"type":"boolean"},
   140      "DescribeTunnelRequest":{
   141        "type":"structure",
   142        "required":["tunnelId"],
   143        "members":{
   144          "tunnelId":{"shape":"TunnelId"}
   145        }
   146      },
   147      "DescribeTunnelResponse":{
   148        "type":"structure",
   149        "members":{
   150          "tunnel":{"shape":"Tunnel"}
   151        }
   152      },
   153      "Description":{
   154        "type":"string",
   155        "pattern":"[^\\p{C}]{1,2048}"
   156      },
   157      "DestinationConfig":{
   158        "type":"structure",
   159        "required":["services"],
   160        "members":{
   161          "thingName":{"shape":"ThingName"},
   162          "services":{"shape":"ServiceList"}
   163        }
   164      },
   165      "ErrorMessage":{"type":"string"},
   166      "LimitExceededException":{
   167        "type":"structure",
   168        "members":{
   169          "message":{"shape":"ErrorMessage"}
   170        },
   171        "exception":true
   172      },
   173      "ListTagsForResourceRequest":{
   174        "type":"structure",
   175        "required":["resourceArn"],
   176        "members":{
   177          "resourceArn":{"shape":"AmazonResourceName"}
   178        }
   179      },
   180      "ListTagsForResourceResponse":{
   181        "type":"structure",
   182        "members":{
   183          "tags":{"shape":"TagList"}
   184        }
   185      },
   186      "ListTunnelsRequest":{
   187        "type":"structure",
   188        "members":{
   189          "thingName":{"shape":"ThingName"},
   190          "maxResults":{
   191            "shape":"MaxResults",
   192            "box":true
   193          },
   194          "nextToken":{"shape":"NextToken"}
   195        }
   196      },
   197      "ListTunnelsResponse":{
   198        "type":"structure",
   199        "members":{
   200          "tunnelSummaries":{"shape":"TunnelSummaryList"},
   201          "nextToken":{"shape":"NextToken"}
   202        }
   203      },
   204      "MaxResults":{
   205        "type":"integer",
   206        "max":100,
   207        "min":1
   208      },
   209      "NextToken":{
   210        "type":"string",
   211        "pattern":"[a-zA-Z0-9_=-]{1,4096}"
   212      },
   213      "OpenTunnelRequest":{
   214        "type":"structure",
   215        "members":{
   216          "description":{"shape":"Description"},
   217          "tags":{"shape":"TagList"},
   218          "destinationConfig":{"shape":"DestinationConfig"},
   219          "timeoutConfig":{"shape":"TimeoutConfig"}
   220        }
   221      },
   222      "OpenTunnelResponse":{
   223        "type":"structure",
   224        "members":{
   225          "tunnelId":{"shape":"TunnelId"},
   226          "tunnelArn":{"shape":"TunnelArn"},
   227          "sourceAccessToken":{"shape":"ClientAccessToken"},
   228          "destinationAccessToken":{"shape":"ClientAccessToken"}
   229        }
   230      },
   231      "ResourceNotFoundException":{
   232        "type":"structure",
   233        "members":{
   234          "message":{"shape":"ErrorMessage"}
   235        },
   236        "exception":true
   237      },
   238      "Service":{
   239        "type":"string",
   240        "max":128,
   241        "min":1,
   242        "pattern":"[a-zA-Z0-9:_-]+"
   243      },
   244      "ServiceList":{
   245        "type":"list",
   246        "member":{"shape":"Service"},
   247        "min":1
   248      },
   249      "Tag":{
   250        "type":"structure",
   251        "required":[
   252          "key",
   253          "value"
   254        ],
   255        "members":{
   256          "key":{"shape":"TagKey"},
   257          "value":{"shape":"TagValue"}
   258        }
   259      },
   260      "TagKey":{
   261        "type":"string",
   262        "max":128,
   263        "min":1,
   264        "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
   265      },
   266      "TagKeyList":{
   267        "type":"list",
   268        "member":{"shape":"TagKey"},
   269        "max":200,
   270        "min":0
   271      },
   272      "TagList":{
   273        "type":"list",
   274        "member":{"shape":"Tag"},
   275        "max":200,
   276        "min":1
   277      },
   278      "TagResourceRequest":{
   279        "type":"structure",
   280        "required":[
   281          "resourceArn",
   282          "tags"
   283        ],
   284        "members":{
   285          "resourceArn":{"shape":"AmazonResourceName"},
   286          "tags":{"shape":"TagList"}
   287        }
   288      },
   289      "TagResourceResponse":{
   290        "type":"structure",
   291        "members":{
   292        }
   293      },
   294      "TagValue":{
   295        "type":"string",
   296        "max":256,
   297        "min":0,
   298        "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
   299      },
   300      "ThingName":{
   301        "type":"string",
   302        "max":128,
   303        "min":1,
   304        "pattern":"[a-zA-Z0-9:_-]+"
   305      },
   306      "TimeoutConfig":{
   307        "type":"structure",
   308        "members":{
   309          "maxLifetimeTimeoutMinutes":{
   310            "shape":"TimeoutInMin",
   311            "box":true
   312          }
   313        }
   314      },
   315      "TimeoutInMin":{
   316        "type":"integer",
   317        "max":720,
   318        "min":1
   319      },
   320      "Tunnel":{
   321        "type":"structure",
   322        "members":{
   323          "tunnelId":{"shape":"TunnelId"},
   324          "tunnelArn":{"shape":"TunnelArn"},
   325          "status":{"shape":"TunnelStatus"},
   326          "sourceConnectionState":{"shape":"ConnectionState"},
   327          "destinationConnectionState":{"shape":"ConnectionState"},
   328          "description":{"shape":"Description"},
   329          "destinationConfig":{"shape":"DestinationConfig"},
   330          "timeoutConfig":{"shape":"TimeoutConfig"},
   331          "tags":{"shape":"TagList"},
   332          "createdAt":{"shape":"DateType"},
   333          "lastUpdatedAt":{"shape":"DateType"}
   334        }
   335      },
   336      "TunnelArn":{
   337        "type":"string",
   338        "max":1600,
   339        "min":1
   340      },
   341      "TunnelId":{
   342        "type":"string",
   343        "pattern":"[a-zA-Z0-9_\\-+=:]{1,128}"
   344      },
   345      "TunnelStatus":{
   346        "type":"string",
   347        "enum":[
   348          "OPEN",
   349          "CLOSED"
   350        ]
   351      },
   352      "TunnelSummary":{
   353        "type":"structure",
   354        "members":{
   355          "tunnelId":{"shape":"TunnelId"},
   356          "tunnelArn":{"shape":"TunnelArn"},
   357          "status":{"shape":"TunnelStatus"},
   358          "description":{"shape":"Description"},
   359          "createdAt":{"shape":"DateType"},
   360          "lastUpdatedAt":{"shape":"DateType"}
   361        }
   362      },
   363      "TunnelSummaryList":{
   364        "type":"list",
   365        "member":{"shape":"TunnelSummary"}
   366      },
   367      "UntagResourceRequest":{
   368        "type":"structure",
   369        "required":[
   370          "resourceArn",
   371          "tagKeys"
   372        ],
   373        "members":{
   374          "resourceArn":{"shape":"AmazonResourceName"},
   375          "tagKeys":{"shape":"TagKeyList"}
   376        }
   377      },
   378      "UntagResourceResponse":{
   379        "type":"structure",
   380        "members":{
   381        }
   382      }
   383    }
   384  }