Module Smaws_Client_IoTSecureTunneling.Types

type nonrec untag_resource_response = unit
type nonrec amazon_resource_name = string
type nonrec tag_key = string
type nonrec tag_key_list = tag_key list
type nonrec untag_resource_request = {
  1. tag_keys : tag_key_list;
    (*

    The keys of the tags to remove.

    *)
  2. resource_arn : amazon_resource_name;
    (*

    The resource ARN.

    *)
}
type nonrec error_message = string
type nonrec resource_not_found_exception = {
  1. message : error_message option;
}

Thrown when an operation is attempted on a resource that does not exist.

type nonrec tunnel_id = string
type nonrec tunnel_arn = string
type nonrec tunnel_status =
  1. | CLOSED
  2. | OPEN
type nonrec description = string
type nonrec date_type = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec tunnel_summary = {
  1. last_updated_at : date_type option;
    (*

    The time the tunnel was last updated.

    *)
  2. created_at : date_type option;
    (*

    The time the tunnel was created.

    *)
  3. description : description option;
    (*

    A description of the tunnel.

    *)
  4. status : tunnel_status option;
    (*

    The status of a tunnel. Valid values are: Open and Closed.

    *)
  5. tunnel_arn : tunnel_arn option;
    (*

    The Amazon Resource Name of the tunnel.

    *)
  6. tunnel_id : tunnel_id option;
    (*

    The unique alpha-numeric identifier for the tunnel.

    *)
}

Information about the tunnel.

type nonrec tunnel_summary_list = tunnel_summary list
type nonrec connection_status =
  1. | DISCONNECTED
  2. | CONNECTED
type nonrec connection_state = {
  1. last_updated_at : date_type option;
    (*

    The last time the connection status was updated.

    *)
  2. status : connection_status option;
    (*

    The connection status of the tunnel. Valid values are CONNECTED and DISCONNECTED.

    *)
}

The state of a connection.

type nonrec thing_name = string
type nonrec service = string
type nonrec service_list = service list
type nonrec destination_config = {
  1. services : service_list;
    (*

    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.

    *)
  2. thing_name : thing_name option;
    (*

    The name of the IoT thing to which you want to connect.

    *)
}

The destination configuration.

type nonrec timeout_in_min = int
type nonrec timeout_config = {
  1. max_lifetime_timeout_minutes : timeout_in_min option;
    (*

    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 timeout configuration.

type nonrec tag_value = string
type nonrec tag = {
  1. value : tag_value;
    (*

    The value of the tag.

    *)
  2. key : tag_key;
    (*

    The key of the tag.

    *)
}

An arbitary key/value pair used to add searchable metadata to secure tunnel resources.

type nonrec tag_list = tag list
type nonrec tunnel = {
  1. last_updated_at : date_type option;
    (*

    The last time the tunnel was updated.

    *)
  2. created_at : date_type option;
    (*

    The time when the tunnel was created.

    *)
  3. tags : tag_list option;
    (*

    A list of tag metadata associated with the secure tunnel.

    *)
  4. timeout_config : timeout_config option;
    (*

    Timeout configuration for the tunnel.

    *)
  5. destination_config : destination_config option;
    (*

    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.

    *)
  6. description : description option;
    (*

    A description of the tunnel.

    *)
  7. destination_connection_state : connection_state option;
    (*

    The connection state of the destination application.

    *)
  8. source_connection_state : connection_state option;
    (*

    The connection state of the source application.

    *)
  9. status : tunnel_status option;
    (*

    The status of a tunnel. Valid values are: Open and Closed.

    *)
  10. tunnel_arn : tunnel_arn option;
    (*

    The Amazon Resource Name (ARN) of a tunnel.

    *)
  11. tunnel_id : tunnel_id option;
    (*

    A unique alpha-numeric ID that identifies a tunnel.

    *)
}

A connection between a source computer and a destination device.

type nonrec tag_resource_response = unit
type nonrec tag_resource_request = {
  1. tags : tag_list;
    (*

    The tags for the resource.

    *)
  2. resource_arn : amazon_resource_name;
    (*

    The ARN of the resource.

    *)
}
type nonrec client_access_token = string
type nonrec rotate_tunnel_access_token_response = {
  1. destination_access_token : client_access_token option;
    (*

    The client access token that the destination local proxy uses to connect to IoT Secure Tunneling.

    *)
  2. source_access_token : client_access_token option;
    (*

    The client access token that the source local proxy uses to connect to IoT Secure Tunneling.

    *)
  3. tunnel_arn : tunnel_arn option;
    (*

    The Amazon Resource Name for the tunnel.

    *)
}
type nonrec client_mode =
  1. | ALL
  2. | DESTINATION
  3. | SOURCE
type nonrec rotate_tunnel_access_token_request = {
  1. destination_config : destination_config option;
  2. client_mode : client_mode;
    (*

    The mode of the client that will use the client token, which can be either the source or destination, or both source and destination.

    *)
  3. tunnel_id : tunnel_id;
    (*

    The tunnel for which you want to rotate the access tokens.

    *)
}
type nonrec open_tunnel_response = {
  1. destination_access_token : client_access_token option;
    (*

    The access token the destination local proxy uses to connect to IoT Secure Tunneling.

    *)
  2. source_access_token : client_access_token option;
    (*

    The access token the source local proxy uses to connect to IoT Secure Tunneling.

    *)
  3. tunnel_arn : tunnel_arn option;
    (*

    The Amazon Resource Name for the tunnel.

    *)
  4. tunnel_id : tunnel_id option;
    (*

    A unique alpha-numeric tunnel ID.

    *)
}
type nonrec open_tunnel_request = {
  1. timeout_config : timeout_config option;
    (*

    Timeout configuration for a tunnel.

    *)
  2. destination_config : destination_config option;
    (*

    The destination configuration for the OpenTunnel request.

    *)
  3. tags : tag_list option;
    (*

    A collection of tag metadata.

    *)
  4. description : description option;
    (*

    A short text description of the tunnel.

    *)
}
type nonrec limit_exceeded_exception = {
  1. message : error_message option;
}

Thrown when a tunnel limit is exceeded.

type nonrec next_token = string
type nonrec max_results = int
type nonrec list_tunnels_response = {
  1. next_token : next_token option;
    (*

    The token to use to get the next set of results, or null if there are no additional results.

    *)
  2. tunnel_summaries : tunnel_summary_list option;
    (*

    A short description of the tunnels in an Amazon Web Services account.

    *)
}
type nonrec list_tunnels_request = {
  1. next_token : next_token option;
    (*

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    *)
  2. max_results : max_results option;
    (*

    The maximum number of results to return at once.

    *)
  3. thing_name : thing_name option;
    (*

    The name of the IoT thing associated with the destination device.

    *)
}
type nonrec list_tags_for_resource_response = {
  1. tags : tag_list option;
    (*

    The tags for the specified resource.

    *)
}
type nonrec list_tags_for_resource_request = {
  1. resource_arn : amazon_resource_name;
    (*

    The resource ARN.

    *)
}
type nonrec describe_tunnel_response = {
  1. tunnel : tunnel option;
    (*

    The tunnel being described.

    *)
}
type nonrec describe_tunnel_request = {
  1. tunnel_id : tunnel_id;
    (*

    The tunnel to describe.

    *)
}
type nonrec close_tunnel_response = unit
type nonrec delete_flag = bool
type nonrec close_tunnel_request = {
  1. delete : delete_flag option;
    (*

    When set to true, IoT Secure Tunneling deletes the tunnel data immediately.

    *)
  2. tunnel_id : tunnel_id;
    (*

    The ID of the tunnel to close.

    *)
}