update_thing ¶

def update_thing(
    self,
    thing_name: "capo_iot.types.thing_name.ThingName",
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    thing_type_name: Optional[
        "capo_iot.types.thing_type_name.ThingTypeName"
    ] = None,
    attribute_payload: Optional[
        "capo_iot.types.attribute_payload.AttributePayload"
    ] = None,
    expected_version: Optional[
        "capo_iot.types.optional_version.OptionalVersion"
    ] = None,
    remove_thing_type: Optional[
        "capo_iot.types.remove_thing_type.RemoveThingType"
    ] = None,
) -> "capo_iot.types.update_thing_response.UpdateThingResponse":
    r"""<p>Updates the data for a thing.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateThing</a> action.</p>

    Args:
        thing_name: <p>The name of the thing to update.</p> <p>You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.</p>
        thing_type_name: <p>The name of the thing type.</p>
        attribute_payload: <p>A list of thing attributes, a JSON string containing name-value pairs. For example:</p> <p> <code>{\"attributes\":{\"name1\":\"value2\"}}</code> </p> <p>This data is used to add new attributes or update existing attributes.</p>
        expected_version: <p>The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the <code>UpdateThing</code> request is rejected with a <code>VersionConflictException</code>.</p>
        remove_thing_type: <p>Remove a thing type association. If <b>true</b>, the association is removed.</p>

    Raises:
        capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
        capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_iot.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_iot.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
        capo_iot.errors.version_conflict_exception.VersionConflictException: <p>An exception thrown when the version of an entity specified with the <code>expectedVersion</code> parameter does not match the latest version in the system.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot.types.update_thing_request.UpdateThingRequest]",
    ) -> OperationResponse[
        "capo_iot.types.update_thing_response.UpdateThingResponse"
    ]:
        import capo_iot._operations.aws_iot_service.update_thing

        output, http_response = (
            capo_iot._operations.aws_iot_service.update_thing.update_thing(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateThing")
    )
    input_: capo_iot.types.update_thing_request.UpdateThingRequest = {
        "thing_name": thing_name
    }
    if thing_type_name is not None:
        input_["thing_type_name"] = thing_type_name
    if attribute_payload is not None:
        input_["attribute_payload"] = attribute_payload
    if expected_version is not None:
        input_["expected_version"] = expected_version
    if remove_thing_type is not None:
        input_["remove_thing_type"] = remove_thing_type

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output