{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.iotsecuretunneling#AmazonResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1011 } } }, "com.amazonaws.iotsecuretunneling#ClientAccessToken": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.iotsecuretunneling#ClientMode": { "type": "enum", "members": { "SOURCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SOURCE" } }, "DESTINATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DESTINATION" } }, "ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL" } } } }, "com.amazonaws.iotsecuretunneling#CloseTunnel": { "type": "operation", "input": { "target": "com.amazonaws.iotsecuretunneling#CloseTunnelRequest" }, "output": { "target": "com.amazonaws.iotsecuretunneling#CloseTunnelResponse" }, "errors": [ { "target": "com.amazonaws.iotsecuretunneling#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "
Closes a tunnel identified by the unique tunnel id. When a CloseTunnel\n\t\t\trequest is received, we close the WebSocket connections between the client and proxy\n\t\t\tserver so no data can be transmitted.
Requires permission to access the CloseTunnel action.
", "smithy.api#http": { "method": "DELETE", "uri": "/tunnels/{tunnelId}", "code": 200 } } }, "com.amazonaws.iotsecuretunneling#CloseTunnelRequest": { "type": "structure", "members": { "tunnelId": { "target": "com.amazonaws.iotsecuretunneling#TunnelId", "traits": { "smithy.api#documentation": "The ID of the tunnel to close.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "delete": { "target": "com.amazonaws.iotsecuretunneling#DeleteFlag", "traits": { "smithy.api#default": null, "smithy.api#documentation": "When set to true, IoT Secure Tunneling deletes the tunnel data\n\t\t\timmediately.
", "smithy.api#httpQuery": "delete" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotsecuretunneling#CloseTunnelResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotsecuretunneling#ConnectionState": { "type": "structure", "members": { "status": { "target": "com.amazonaws.iotsecuretunneling#ConnectionStatus", "traits": { "smithy.api#documentation": "The connection status of the tunnel. Valid values are CONNECTED and\n\t\t\t\tDISCONNECTED.
The last time the connection status was updated.
" } } }, "traits": { "smithy.api#documentation": "The state of a connection.
" } }, "com.amazonaws.iotsecuretunneling#ConnectionStatus": { "type": "enum", "members": { "CONNECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONNECTED" } }, "DISCONNECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISCONNECTED" } } } }, "com.amazonaws.iotsecuretunneling#DateType": { "type": "timestamp" }, "com.amazonaws.iotsecuretunneling#DeleteFlag": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.iotsecuretunneling#DescribeTunnel": { "type": "operation", "input": { "target": "com.amazonaws.iotsecuretunneling#DescribeTunnelRequest" }, "output": { "target": "com.amazonaws.iotsecuretunneling#DescribeTunnelResponse" }, "errors": [ { "target": "com.amazonaws.iotsecuretunneling#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Gets information about a tunnel identified by the unique tunnel id.
\nRequires permission to access the DescribeTunnel action.
", "smithy.api#http": { "method": "GET", "uri": "/tunnels/{tunnelId}", "code": 200 } } }, "com.amazonaws.iotsecuretunneling#DescribeTunnelRequest": { "type": "structure", "members": { "tunnelId": { "target": "com.amazonaws.iotsecuretunneling#TunnelId", "traits": { "smithy.api#documentation": "The tunnel to describe.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotsecuretunneling#DescribeTunnelResponse": { "type": "structure", "members": { "tunnel": { "target": "com.amazonaws.iotsecuretunneling#Tunnel", "traits": { "smithy.api#documentation": "The tunnel being described.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotsecuretunneling#Description": { "type": "string", "traits": { "smithy.api#pattern": "^[^\\p{C}]{1,2048}$" } }, "com.amazonaws.iotsecuretunneling#DestinationConfig": { "type": "structure", "members": { "thingName": { "target": "com.amazonaws.iotsecuretunneling#ThingName", "traits": { "smithy.api#documentation": "The name of the IoT thing to which you want to connect.
" } }, "services": { "target": "com.amazonaws.iotsecuretunneling#ServiceList", "traits": { "smithy.api#documentation": "A list of service names that identify the target application. The IoT client\n\t\t\trunning on the destination device reads this value and uses it to look up a port or an\n\t\t\tIP address and a port. The IoT client instantiates the local proxy, which uses this\n\t\t\tinformation to connect to the destination application.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The destination configuration.
" } }, "com.amazonaws.iotsecuretunneling#ErrorMessage": { "type": "string" }, "com.amazonaws.iotsecuretunneling#IoTSecuredTunneling": { "type": "service", "version": "2018-10-05", "operations": [ { "target": "com.amazonaws.iotsecuretunneling#CloseTunnel" }, { "target": "com.amazonaws.iotsecuretunneling#DescribeTunnel" }, { "target": "com.amazonaws.iotsecuretunneling#ListTagsForResource" }, { "target": "com.amazonaws.iotsecuretunneling#ListTunnels" }, { "target": "com.amazonaws.iotsecuretunneling#OpenTunnel" }, { "target": "com.amazonaws.iotsecuretunneling#RotateTunnelAccessToken" }, { "target": "com.amazonaws.iotsecuretunneling#TagResource" }, { "target": "com.amazonaws.iotsecuretunneling#UntagResource" } ], "traits": { "aws.api#service": { "sdkId": "IoTSecureTunneling", "arnNamespace": "iotsecuredtunneling", "cloudFormationName": "IoTSecureTunneling", "cloudTrailEventSource": "iotsecuretunneling.amazonaws.com", "endpointPrefix": "api.tunneling.iot" }, "aws.auth#sigv4": { "name": "IoTSecuredTunneling" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "IoT Secure Tunneling creates remote connections to devices deployed in the\n\t\t\tfield.
\nFor more information about how IoT Secure Tunneling works, see IoT\n\t\t\t\tSecure Tunneling.
", "smithy.api#title": "AWS IoT Secure Tunneling", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://api.iot-tunneling-fips.{Region}.api.aws", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://api.iot-tunneling-fips.{Region}.api.amazonwebservices.com.cn", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://api.tunneling.iot-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://api.tunneling.iot-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://api.iot-tunneling.{Region}.api.aws", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://api.iot-tunneling.{Region}.api.amazonwebservices.com.cn", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://api.tunneling.iot.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://api.tunneling.iot.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 19, "nodes": "/////wAAAAH/////AAAAAAAAABIAAAADAAAAAQAAAAQF9eEPAAAAAgAAAAUF9eEPAAAAAwAAAAsAAAAGAAAABAAAAAcF9eEOAAAABQAAAAgF9eENAAAABwX14QoAAAAJAAAACAX14QsAAAAKAAAACQX14QoF9eEMAAAABAAAAA0AAAAMAAAABgX14QgF9eEJAAAABQAAAA4F9eEHAAAABgAAAA8F9eEHAAAABwX14QQAAAAQAAAACAX14QUAAAARAAAACQX14QQF9eEGAAAAAwX14QEAAAATAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ "aws", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://api.iot-tunneling-fips.{Region}.api.aws", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ "aws-cn", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://api.iot-tunneling-fips.{Region}.api.amazonwebservices.com.cn", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ "aws-us-gov", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://api.iot-tunneling-fips.{Region}.api.aws", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://api.tunneling.iot-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://api.tunneling.iot-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ "aws", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://api.iot-tunneling.{Region}.api.aws", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ "aws-cn", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://api.iot-tunneling.{Region}.api.amazonwebservices.com.cn", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ "aws-us-gov", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://api.iot-tunneling.{Region}.api.aws", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://api.tunneling.iot.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://api.tunneling.iot.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.ap-east-1.api.aws" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.ap-northeast-1.api.aws" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.ap-northeast-2.api.aws" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.ap-south-1.api.aws" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.ap-southeast-1.api.aws" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.ap-southeast-2.api.aws" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot-fips.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.ca-central-1.api.aws" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling-fips.ca-central-1.api.aws" } }, "params": { "Region": "ca-central-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.eu-central-1.api.aws" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.eu-north-1.api.aws" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.eu-west-1.api.aws" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.eu-west-2.api.aws" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.eu-west-3.api.aws" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region me-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.me-central-1.amazonaws.com" } }, "params": { "Region": "me-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-central-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.me-central-1.api.aws" } }, "params": { "Region": "me-central-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.me-south-1.api.aws" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.sa-east-1.api.aws" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot-fips.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.us-east-2.api.aws" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling-fips.us-east-2.api.aws" } }, "params": { "Region": "us-east-2", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot-fips.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.us-west-1.api.aws" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling-fips.us-west-1.api.aws" } }, "params": { "Region": "us-west-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot-fips.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.us-west-2.api.aws" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling-fips.us-west-2.api.aws" } }, "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot-fips.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iot-tunneling-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.tunneling.iot-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.iotsecuretunneling#LimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iotsecuretunneling#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "LimitExceededException", "httpResponseCode": 403 }, "smithy.api#documentation": "Thrown when a tunnel limit is exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.iotsecuretunneling#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.iotsecuretunneling#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.iotsecuretunneling#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.iotsecuretunneling#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Lists the tags for the specified resource.
", "smithy.api#http": { "method": "GET", "uri": "/tags", "code": 200 } } }, "com.amazonaws.iotsecuretunneling#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.iotsecuretunneling#AmazonResourceName", "traits": { "smithy.api#documentation": "The resource ARN.
", "smithy.api#httpQuery": "resourceArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotsecuretunneling#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.iotsecuretunneling#TagList", "traits": { "smithy.api#documentation": "The tags for the specified resource.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotsecuretunneling#ListTunnels": { "type": "operation", "input": { "target": "com.amazonaws.iotsecuretunneling#ListTunnelsRequest" }, "output": { "target": "com.amazonaws.iotsecuretunneling#ListTunnelsResponse" }, "traits": { "smithy.api#documentation": "List all tunnels for an Amazon Web Services account. Tunnels are listed by creation time in\n\t\t\tdescending order, newer tunnels will be listed before older tunnels.
\nRequires permission to access the ListTunnels action.
", "smithy.api#http": { "method": "GET", "uri": "/tunnels", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.iotsecuretunneling#ListTunnelsRequest": { "type": "structure", "members": { "thingName": { "target": "com.amazonaws.iotsecuretunneling#ThingName", "traits": { "smithy.api#documentation": "The name of the IoT thing associated with the destination device.
", "smithy.api#httpQuery": "thingName" } }, "maxResults": { "target": "com.amazonaws.iotsecuretunneling#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return at once.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iotsecuretunneling#NextToken", "traits": { "smithy.api#documentation": "To retrieve the next set of results, the nextToken value from a previous response;\n\t\t\totherwise null to receive the first set of results.
", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotsecuretunneling#ListTunnelsResponse": { "type": "structure", "members": { "tunnelSummaries": { "target": "com.amazonaws.iotsecuretunneling#TunnelSummaryList", "traits": { "smithy.api#documentation": "A short description of the tunnels in an Amazon Web Services account.
" } }, "nextToken": { "target": "com.amazonaws.iotsecuretunneling#NextToken", "traits": { "smithy.api#documentation": "The token to use to get the next set of results, or null if there are no additional\n\t\t\tresults.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotsecuretunneling#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.iotsecuretunneling#NextToken": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9_=-]{1,4096}$" } }, "com.amazonaws.iotsecuretunneling#OpenTunnel": { "type": "operation", "input": { "target": "com.amazonaws.iotsecuretunneling#OpenTunnelRequest" }, "output": { "target": "com.amazonaws.iotsecuretunneling#OpenTunnelResponse" }, "errors": [ { "target": "com.amazonaws.iotsecuretunneling#LimitExceededException" } ], "traits": { "smithy.api#documentation": "Creates a new tunnel, and returns two client access tokens for clients to use to\n\t\t\tconnect to the IoT Secure Tunneling proxy server.
\nRequires permission to access the OpenTunnel action.
", "smithy.api#http": { "method": "POST", "uri": "/tunnels", "code": 200 } } }, "com.amazonaws.iotsecuretunneling#OpenTunnelRequest": { "type": "structure", "members": { "description": { "target": "com.amazonaws.iotsecuretunneling#Description", "traits": { "smithy.api#documentation": "A short text description of the tunnel.
" } }, "tags": { "target": "com.amazonaws.iotsecuretunneling#TagList", "traits": { "smithy.api#documentation": "A collection of tag metadata.
" } }, "destinationConfig": { "target": "com.amazonaws.iotsecuretunneling#DestinationConfig", "traits": { "smithy.api#documentation": "The destination configuration for the OpenTunnel request.
" } }, "timeoutConfig": { "target": "com.amazonaws.iotsecuretunneling#TimeoutConfig", "traits": { "smithy.api#documentation": "Timeout configuration for a tunnel.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotsecuretunneling#OpenTunnelResponse": { "type": "structure", "members": { "tunnelId": { "target": "com.amazonaws.iotsecuretunneling#TunnelId", "traits": { "smithy.api#documentation": "A unique alpha-numeric tunnel ID.
" } }, "tunnelArn": { "target": "com.amazonaws.iotsecuretunneling#TunnelArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name for the tunnel.
" } }, "sourceAccessToken": { "target": "com.amazonaws.iotsecuretunneling#ClientAccessToken", "traits": { "smithy.api#documentation": "The access token the source local proxy uses to connect to IoT Secure\n\t\t\tTunneling.
" } }, "destinationAccessToken": { "target": "com.amazonaws.iotsecuretunneling#ClientAccessToken", "traits": { "smithy.api#documentation": "The access token the destination local proxy uses to connect to IoT Secure\n\t\t\tTunneling.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotsecuretunneling#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iotsecuretunneling#ErrorMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ResourceNotFoundException", "httpResponseCode": 404 }, "smithy.api#documentation": "Thrown when an operation is attempted on a resource that does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.iotsecuretunneling#RotateTunnelAccessToken": { "type": "operation", "input": { "target": "com.amazonaws.iotsecuretunneling#RotateTunnelAccessTokenRequest" }, "output": { "target": "com.amazonaws.iotsecuretunneling#RotateTunnelAccessTokenResponse" }, "errors": [ { "target": "com.amazonaws.iotsecuretunneling#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Revokes the current client access token (CAT) and returns new CAT for clients to\n\t\t\tuse when reconnecting to secure tunneling to access the same tunnel.
\nRequires permission to access the RotateTunnelAccessToken action.
\nRotating the CAT doesn't extend the tunnel duration. For example, say the tunnel\n\t\t\t\tduration is 12 hours and the tunnel has already been open for 4 hours. When you\n\t\t\t\trotate the access tokens, the new tokens that are generated can only be used for the\n\t\t\t\tremaining 8 hours.
\nThe tunnel for which you want to rotate the access tokens.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "clientMode": { "target": "com.amazonaws.iotsecuretunneling#ClientMode", "traits": { "smithy.api#documentation": "The mode of the client that will use the client token, which can be either the source\n\t\t\tor destination, or both source and destination.
", "smithy.api#required": {} } }, "destinationConfig": { "target": "com.amazonaws.iotsecuretunneling#DestinationConfig" } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotsecuretunneling#RotateTunnelAccessTokenResponse": { "type": "structure", "members": { "tunnelArn": { "target": "com.amazonaws.iotsecuretunneling#TunnelArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name for the tunnel.
" } }, "sourceAccessToken": { "target": "com.amazonaws.iotsecuretunneling#ClientAccessToken", "traits": { "smithy.api#documentation": "The client access token that the source local proxy uses to connect to IoT Secure\n\t\t\tTunneling.
" } }, "destinationAccessToken": { "target": "com.amazonaws.iotsecuretunneling#ClientAccessToken", "traits": { "smithy.api#documentation": "The client access token that the destination local proxy uses to connect to IoT\n\t\t\tSecure Tunneling.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotsecuretunneling#Service": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9:_-]+$" } }, "com.amazonaws.iotsecuretunneling#ServiceList": { "type": "list", "member": { "target": "com.amazonaws.iotsecuretunneling#Service" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.iotsecuretunneling#Tag": { "type": "structure", "members": { "key": { "target": "com.amazonaws.iotsecuretunneling#TagKey", "traits": { "smithy.api#documentation": "The key of the tag.
", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.iotsecuretunneling#TagValue", "traits": { "smithy.api#documentation": "The value of the tag.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An arbitary key/value pair used to add searchable metadata to secure tunnel\n\t\t\tresources.
" } }, "com.amazonaws.iotsecuretunneling#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.iotsecuretunneling#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.iotsecuretunneling#TagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.iotsecuretunneling#TagList": { "type": "list", "member": { "target": "com.amazonaws.iotsecuretunneling#Tag" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.iotsecuretunneling#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.iotsecuretunneling#TagResourceRequest" }, "output": { "target": "com.amazonaws.iotsecuretunneling#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.iotsecuretunneling#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "A resource tag.
", "smithy.api#http": { "method": "POST", "uri": "/tags", "code": 200 } } }, "com.amazonaws.iotsecuretunneling#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.iotsecuretunneling#AmazonResourceName", "traits": { "smithy.api#documentation": "The ARN of the resource.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.iotsecuretunneling#TagList", "traits": { "smithy.api#documentation": "The tags for the resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotsecuretunneling#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotsecuretunneling#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.iotsecuretunneling#ThingName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9:_-]+$" } }, "com.amazonaws.iotsecuretunneling#TimeoutConfig": { "type": "structure", "members": { "maxLifetimeTimeoutMinutes": { "target": "com.amazonaws.iotsecuretunneling#TimeoutInMin", "traits": { "smithy.api#documentation": "The maximum amount of time (in minutes) a tunnel can remain open. If not specified,\n\t\t\tmaxLifetimeTimeoutMinutes defaults to 720 minutes. Valid values are from 1 minute to 12\n\t\t\thours (720 minutes)
" } } }, "traits": { "smithy.api#documentation": "Tunnel timeout configuration.
" } }, "com.amazonaws.iotsecuretunneling#TimeoutInMin": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 720 } } }, "com.amazonaws.iotsecuretunneling#Tunnel": { "type": "structure", "members": { "tunnelId": { "target": "com.amazonaws.iotsecuretunneling#TunnelId", "traits": { "smithy.api#documentation": "A unique alpha-numeric ID that identifies a tunnel.
" } }, "tunnelArn": { "target": "com.amazonaws.iotsecuretunneling#TunnelArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of a tunnel.
" } }, "status": { "target": "com.amazonaws.iotsecuretunneling#TunnelStatus", "traits": { "smithy.api#documentation": "The status of a tunnel. Valid values are: Open and Closed.
" } }, "sourceConnectionState": { "target": "com.amazonaws.iotsecuretunneling#ConnectionState", "traits": { "smithy.api#documentation": "The connection state of the source application.
" } }, "destinationConnectionState": { "target": "com.amazonaws.iotsecuretunneling#ConnectionState", "traits": { "smithy.api#documentation": "The connection state of the destination application.
" } }, "description": { "target": "com.amazonaws.iotsecuretunneling#Description", "traits": { "smithy.api#documentation": "A description of the tunnel.
" } }, "destinationConfig": { "target": "com.amazonaws.iotsecuretunneling#DestinationConfig", "traits": { "smithy.api#documentation": "The destination configuration that specifies the thing name of the destination\n\t\t\tdevice and a service name that the local proxy uses to connect to the destination\n\t\t\tapplication.
" } }, "timeoutConfig": { "target": "com.amazonaws.iotsecuretunneling#TimeoutConfig", "traits": { "smithy.api#documentation": "Timeout configuration for the tunnel.
" } }, "tags": { "target": "com.amazonaws.iotsecuretunneling#TagList", "traits": { "smithy.api#documentation": "A list of tag metadata associated with the secure tunnel.
" } }, "createdAt": { "target": "com.amazonaws.iotsecuretunneling#DateType", "traits": { "smithy.api#documentation": "The time when the tunnel was created.
" } }, "lastUpdatedAt": { "target": "com.amazonaws.iotsecuretunneling#DateType", "traits": { "smithy.api#documentation": "The last time the tunnel was updated.
" } } }, "traits": { "smithy.api#documentation": "A connection between a source computer and a destination device.
" } }, "com.amazonaws.iotsecuretunneling#TunnelArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1600 } } }, "com.amazonaws.iotsecuretunneling#TunnelId": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9_\\-+=:]{1,128}$" } }, "com.amazonaws.iotsecuretunneling#TunnelStatus": { "type": "enum", "members": { "OPEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OPEN" } }, "CLOSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLOSED" } } } }, "com.amazonaws.iotsecuretunneling#TunnelSummary": { "type": "structure", "members": { "tunnelId": { "target": "com.amazonaws.iotsecuretunneling#TunnelId", "traits": { "smithy.api#documentation": "The unique alpha-numeric identifier for the tunnel.
" } }, "tunnelArn": { "target": "com.amazonaws.iotsecuretunneling#TunnelArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name of the tunnel.
" } }, "status": { "target": "com.amazonaws.iotsecuretunneling#TunnelStatus", "traits": { "smithy.api#documentation": "The status of a tunnel. Valid values are: Open and Closed.
" } }, "description": { "target": "com.amazonaws.iotsecuretunneling#Description", "traits": { "smithy.api#documentation": "A description of the tunnel.
" } }, "createdAt": { "target": "com.amazonaws.iotsecuretunneling#DateType", "traits": { "smithy.api#documentation": "The time the tunnel was created.
" } }, "lastUpdatedAt": { "target": "com.amazonaws.iotsecuretunneling#DateType", "traits": { "smithy.api#documentation": "The time the tunnel was last updated.
" } } }, "traits": { "smithy.api#documentation": "Information about the tunnel.
" } }, "com.amazonaws.iotsecuretunneling#TunnelSummaryList": { "type": "list", "member": { "target": "com.amazonaws.iotsecuretunneling#TunnelSummary" } }, "com.amazonaws.iotsecuretunneling#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.iotsecuretunneling#UntagResourceRequest" }, "output": { "target": "com.amazonaws.iotsecuretunneling#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.iotsecuretunneling#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Removes a tag from a resource.
", "smithy.api#http": { "method": "POST", "uri": "/untag", "code": 200 } } }, "com.amazonaws.iotsecuretunneling#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.iotsecuretunneling#AmazonResourceName", "traits": { "smithy.api#documentation": "The resource ARN.
", "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.iotsecuretunneling#TagKeyList", "traits": { "smithy.api#documentation": "The keys of the tags to remove.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotsecuretunneling#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } } } }