AWS IoT Data Plane 2015-05-28
- Client: Aws\IotDataPlane\IotDataPlaneClient
- Service ID: data.iot
- Version: 2015-05-28
This page describes the parameters and results for the operations of the AWS IoT Data Plane (2015-05-28), and shows how to use the Aws\IotDataPlane\IotDataPlaneClient object to call the described operations. This documentation is specific to the 2015-05-28 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- DeleteThingShadow ( array $params = [] )
Deletes the shadow for the specified thing.
- GetThingShadow ( array $params = [] )
Gets the shadow for the specified thing.
- ListNamedShadowsForThing ( array $params = [] )
Lists the shadows for the specified thing.
- Publish ( array $params = [] )
Publishes state information.
- UpdateThingShadow ( array $params = [] )
Updates the shadow for the specified thing.
Operations
DeleteThingShadow
$result = $client->deleteThingShadow([/* ... */]); $promise = $client->deleteThingShadowAsync([/* ... */]);
Deletes the shadow for the specified thing.
For more information, see DeleteThingShadow in the AWS IoT Developer Guide.
Parameter Syntax
$result = $client->deleteThingShadow([
'shadowName' => '<string>',
'thingName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'payload' => <string || resource || Psr\Http\Message\StreamInterface>,
]
Result Details
Members
Errors
-
The specified resource does not exist.
-
The request is not valid.
-
The rate exceeds the limit.
-
You are not authorized to perform this operation.
-
The service is temporarily unavailable.
-
An unexpected error has occurred.
-
The specified combination of HTTP verb and URI is not supported.
-
UnsupportedDocumentEncodingException:
The document encoding is not supported.
GetThingShadow
$result = $client->getThingShadow([/* ... */]); $promise = $client->getThingShadowAsync([/* ... */]);
Gets the shadow for the specified thing.
For more information, see GetThingShadow in the AWS IoT Developer Guide.
Parameter Syntax
$result = $client->getThingShadow([
'shadowName' => '<string>',
'thingName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'payload' => <string || resource || Psr\Http\Message\StreamInterface>,
]
Result Details
Members
Errors
-
The request is not valid.
-
The specified resource does not exist.
-
The rate exceeds the limit.
-
You are not authorized to perform this operation.
-
The service is temporarily unavailable.
-
An unexpected error has occurred.
-
The specified combination of HTTP verb and URI is not supported.
-
UnsupportedDocumentEncodingException:
The document encoding is not supported.
ListNamedShadowsForThing
$result = $client->listNamedShadowsForThing([/* ... */]); $promise = $client->listNamedShadowsForThingAsync([/* ... */]);
Lists the shadows for the specified thing.
Parameter Syntax
$result = $client->listNamedShadowsForThing([
'nextToken' => '<string>',
'pageSize' => <integer>,
'thingName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'nextToken' => '<string>',
'results' => ['<string>', ...],
'timestamp' => <integer>,
]
Result Details
Members
Errors
-
The specified resource does not exist.
-
The request is not valid.
-
The rate exceeds the limit.
-
You are not authorized to perform this operation.
-
The service is temporarily unavailable.
-
An unexpected error has occurred.
-
The specified combination of HTTP verb and URI is not supported.
Publish
$result = $client->publish([/* ... */]); $promise = $client->publishAsync([/* ... */]);
Publishes state information.
For more information, see HTTP Protocol in the AWS IoT Developer Guide.
Parameter Syntax
$result = $client->publish([
'payload' => <string || resource || Psr\Http\Message\StreamInterface>,
'qos' => <integer>,
'topic' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
An unexpected error has occurred.
-
The request is not valid.
-
You are not authorized to perform this operation.
-
The specified combination of HTTP verb and URI is not supported.
UpdateThingShadow
$result = $client->updateThingShadow([/* ... */]); $promise = $client->updateThingShadowAsync([/* ... */]);
Updates the shadow for the specified thing.
For more information, see UpdateThingShadow in the AWS IoT Developer Guide.
Parameter Syntax
$result = $client->updateThingShadow([
'payload' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
'shadowName' => '<string>',
'thingName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'payload' => <string || resource || Psr\Http\Message\StreamInterface>,
]
Result Details
Members
Errors
-
The specified version does not match the version of the document.
-
RequestEntityTooLargeException:
The payload exceeds the maximum size allowed.
-
The request is not valid.
-
The rate exceeds the limit.
-
You are not authorized to perform this operation.
-
The service is temporarily unavailable.
-
An unexpected error has occurred.
-
The specified combination of HTTP verb and URI is not supported.
-
UnsupportedDocumentEncodingException:
The document encoding is not supported.
Shapes
ConflictException
Description
The specified version does not match the version of the document.
Members
InternalFailureException
Description
An unexpected error has occurred.
Members
InvalidRequestException
MethodNotAllowedException
Description
The specified combination of HTTP verb and URI is not supported.
Members
RequestEntityTooLargeException
Description
The payload exceeds the maximum size allowed.
Members
ResourceNotFoundException
Description
The specified resource does not exist.
Members
ServiceUnavailableException
Description
The service is temporarily unavailable.
Members
ThrottlingException
UnauthorizedException
Description
You are not authorized to perform this operation.