CloseTunnel

$result = $client->closeTunnel([/* ... */]);
$promise = $client->closeTunnelAsync([/* ... */]);

Closes a tunnel identified by the unique tunnel id. When a CloseTunnel request is received, we close the WebSocket connections between the client and proxy server so no data can be transmitted.

Requires permission to access the CloseTunnel action.

Parameter Syntax

$result = $client->closeTunnel([
    'delete' => true || false,
    'tunnelId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

DescribeTunnel

$result = $client->describeTunnel([/* ... */]);
$promise = $client->describeTunnelAsync([/* ... */]);

Gets information about a tunnel identified by the unique tunnel id.

Requires permission to access the DescribeTunnel action.

Parameter Syntax

$result = $client->describeTunnel([
    'tunnelId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tunnel' => [
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'destinationConfig' => [
            'services' => ['<string>', ...],
            'thingName' => '<string>',
        ],
        'destinationConnectionState' => [
            'lastUpdatedAt' => <DateTime>,
            'status' => 'CONNECTED|DISCONNECTED',
        ],
        'lastUpdatedAt' => <DateTime>,
        'sourceConnectionState' => [
            'lastUpdatedAt' => <DateTime>,
            'status' => 'CONNECTED|DISCONNECTED',
        ],
        'status' => 'OPEN|CLOSED',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'timeoutConfig' => [
            'maxLifetimeTimeoutMinutes' => <integer>,
        ],
        'tunnelArn' => '<string>',
        'tunnelId' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

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

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags for the specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

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

ListTunnels

$result = $client->listTunnels([/* ... */]);
$promise = $client->listTunnelsAsync([/* ... */]);

List all tunnels for an Amazon Web Services account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels.

Requires permission to access the ListTunnels action.

Parameter Syntax

$result = $client->listTunnels([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'thingName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'tunnelSummaries' => [
        [
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'status' => 'OPEN|CLOSED',
            'tunnelArn' => '<string>',
            'tunnelId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

OpenTunnel

$result = $client->openTunnel([/* ... */]);
$promise = $client->openTunnelAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->openTunnel([
    'description' => '<string>',
    'destinationConfig' => [
        'services' => ['<string>', ...], // REQUIRED
        'thingName' => '<string>',
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'timeoutConfig' => [
        'maxLifetimeTimeoutMinutes' => <integer>,
    ],
]);

Parameter Details

Result Syntax

[
    'destinationAccessToken' => '<string>',
    'sourceAccessToken' => '<string>',
    'tunnelArn' => '<string>',
    'tunnelId' => '<string>',
]

Result Details

Errors

LimitExceededException:

Thrown when a tunnel limit is exceeded.

RotateTunnelAccessToken

$result = $client->rotateTunnelAccessToken([/* ... */]);
$promise = $client->rotateTunnelAccessTokenAsync([/* ... */]);

Revokes the current client access token (CAT) and returns new CAT for clients to use when reconnecting to secure tunneling to access the same tunnel.

Requires permission to access the RotateTunnelAccessToken action.

Parameter Syntax

$result = $client->rotateTunnelAccessToken([
    'clientMode' => 'SOURCE|DESTINATION|ALL', // REQUIRED
    'destinationConfig' => [
        'services' => ['<string>', ...], // REQUIRED
        'thingName' => '<string>',
    ],
    'tunnelId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'destinationAccessToken' => '<string>',
    'sourceAccessToken' => '<string>',
    'tunnelArn' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

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

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

A resource tag.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a tag from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

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