Creates a new tunnel, and returns two client access tokens for clients to use to connect to the IoT Secure Tunneling proxy server.
Requires permission to access the OpenTunnel action.
Parameters:
Raises:
Source code in docs_src/capo_iotsecuretunneling/_services/async_io_t_secure_tunneling.py
| async def open_tunnel(
self,
*,
config_overrides: Optional[AsyncIoTSecureTunnelingClientConfig] = None,
description: Optional[
"capo_iotsecuretunneling.types.description.Description"
] = None,
tags: Optional["capo_iotsecuretunneling.types.tag_list.TagList"] = None,
destination_config: Optional[
"capo_iotsecuretunneling.types.destination_config.DestinationConfig"
] = None,
timeout_config: Optional[
"capo_iotsecuretunneling.types.timeout_config.TimeoutConfig"
] = None,
) -> "capo_iotsecuretunneling.types.open_tunnel_response.OpenTunnelResponse":
"""<p>Creates a new tunnel, and returns two client access tokens for clients to use to connect to the IoT Secure Tunneling proxy server.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">OpenTunnel</a> action.</p>
Args:
description: <p>A short text description of the tunnel. </p>
tags: <p>A collection of tag metadata.</p>
destination_config: <p>The destination configuration for the OpenTunnel request.</p>
timeout_config: <p>Timeout configuration for a tunnel.</p>
Raises:
capo_iotsecuretunneling.errors.limit_exceeded_exception.LimitExceededException: <p>Thrown when a tunnel limit is exceeded.</p>
capo_iotsecuretunneling.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_iotsecuretunneling.types.open_tunnel_request.OpenTunnelRequest]",
) -> AsyncOperationResponse[
"capo_iotsecuretunneling.types.open_tunnel_response.OpenTunnelResponse"
]:
import capo_iotsecuretunneling._operations.io_t_secured_tunneling.open_tunnel
(
output,
http_response,
) = await capo_iotsecuretunneling._operations.io_t_secured_tunneling.open_tunnel.async_open_tunnel(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
def _redact_output(
output: "capo_iotsecuretunneling.types.open_tunnel_response.OpenTunnelResponse",
) -> dict[str, Any]:
import capo_iotsecuretunneling.types.open_tunnel_response
return capo_iotsecuretunneling.types.open_tunnel_response.redact_sensitive(
output
)
interceptors_, options_ = self.operation_options(
config_overrides,
OperationLogging("OpenTunnel", redact_output=_redact_output),
)
input_: capo_iotsecuretunneling.types.open_tunnel_request.OpenTunnelRequest = {}
if description is not None:
input_["description"] = description
if tags is not None:
input_["tags"] = tags
if destination_config is not None:
input_["destination_config"] = destination_config
if timeout_config is not None:
input_["timeout_config"] = timeout_config
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|