Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow constructing Update messages with key-value pairs in StatusDetails #102

Closed
priyamourya25 opened this issue Jun 13, 2024 · 3 comments
Closed
Labels
enhancement New feature or request

Comments

@priyamourya25
Copy link

priyamourya25 commented Jun 13, 2024

statusDetails is an optional field that can be used to update the Job status with additional details that can be used during verification step.

Please refer the usage of statusDetails field in the documentation: https://docs.aws.amazon.com/iot/latest/apireference/API_iot-jobs-data_UpdateJobExecution.html#iot-iot-jobs-data_UpdateJobExecution-request-statusDetails

Can you add the support to append key-value pairs in status details and statusDetails field when a job update message is sent?
Few example of such message:
{"status":"FAILED","statusDetails":{"self_test":"ready","updatedBy":"0x1e240"}} -> to notify that download is complete and device will go in self-test mode
{"status":"FAILED","statusDetails":{"self_test":"accepted","reason":"v1.0.0"}} ->to notify that new image was committed.

The APIs should provide an interface to construct such messages because these were provided by older ota agent to notify the ota progress and were very helpful

@rawalexe rawalexe added the enhancement New feature or request label Jun 14, 2024
@rawalexe
Copy link
Member

Hello Priya,
Thank you for requesting the feature. I'll forward this to the team. If you would like to get this sooner, we do accept PR request and may merger it, accelerating the feature release time.

Thank you,

Best Regards,
AR

@kstribrnAmzn
Copy link
Member

There are a few ways to go about it, but ultimately I think taking in a pre-formatted StatusDetails string to the function. See #101 for more.

@kstribrnAmzn
Copy link
Member

Closing this as #105 is merged. This will allow you to send any arbitrary JSON key-value structure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants