updateThingShadow method

Future<UpdateThingShadowResponse> updateThingShadow({ required Uint8List payload, required String thingName, String? shadowName, })

Updates the shadow for the specified thing.

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

May throw ConflictException. May throw RequestEntityTooLargeException. May throw InvalidRequestException. May throw ThrottlingException. May throw UnauthorizedException. May throw ServiceUnavailableException. May throw InternalFailureException. May throw MethodNotAllowedException. May throw UnsupportedDocumentEncodingException.

Parameter payload : The state information, in JSON format.

Parameter thingName : The name of the thing.

Parameter shadowName : The name of the shadow.

Implementation

Future<UpdateThingShadowResponse> updateThingShadow({
  required Uint8List payload,
  required String thingName,
  String? shadowName,
}) async {
  ArgumentError.checkNotNull(payload, 'payload');
  ArgumentError.checkNotNull(thingName, 'thingName');
  _s.validateStringLength(
    'thingName',
    thingName,
    1,
    128,
    isRequired: true,
  );
  _s.validateStringLength(
    'shadowName',
    shadowName,
    1,
    64,
  );
  final $query = <String, List<String>>{
    if (shadowName != null) 'name': [shadowName],
  };
  final response = await _protocol.sendRaw(
    payload: payload,
    method: 'POST',
    requestUri: '/things/${Uri.encodeComponent(thingName)}/shadow',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return UpdateThingShadowResponse(
    payload: await response.stream.toBytes(),
  );
}