AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Updates the shadow for the specified thing.

Requires permission to access the UpdateThingShadow action.

For more information, see UpdateThingShadow in the IoT Developer Guide.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginUpdateThingShadow and EndUpdateThingShadow.

Namespace: Amazon.IotData
Assembly: AWSSDK.IotData.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<UpdateThingShadowResponse> UpdateThingShadowAsync(
         UpdateThingShadowRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.IotData.Model.UpdateThingShadowRequest

Container for the necessary parameters to execute the UpdateThingShadow service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the UpdateThingShadow service method, as returned by IotData.

Exceptions

ExceptionCondition
ConflictException The specified version does not match the version of the document.
InternalFailureException An unexpected error has occurred.
InvalidRequestException The request is not valid.
MethodNotAllowedException The specified combination of HTTP verb and URI is not supported.
RequestEntityTooLargeException The payload exceeds the maximum size allowed.
ServiceUnavailableException The service is temporarily unavailable.
ThrottlingException The rate exceeds the limit.
UnauthorizedException You are not authorized to perform this operation.
UnsupportedDocumentEncodingException The document encoding is not supported.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also