redfish-core/include/error_messages.hpp

31  * @brief Formats Success message into JSON
32  * Message body: "The request completed successfully."
35  * @returns Message Success formatted to JSON */
41  * @brief Formats GeneralError message into JSON
42  * Message body: "A general error has occurred.  See Resolution for information
43  * on how to resolve the error, or @Message.ExtendedInfo if Resolution is not
47  * @returns Message GeneralError formatted to JSON */
53  * @brief Formats Created message into JSON
54  * Message body: "The resource was created successfully."
57  * @returns Message Created formatted to JSON */
63  * @brief Formats NoOperation message into JSON
64  * Message body: "The request body submitted contain no data to act upon and no
68  * @returns Message NoOperation formatted to JSON */
74  * @brief Formats PropertyDuplicate message into JSON
75  * Message body: "The property <arg1> was duplicated in the request."
77  * @param[in] arg1 Parameter of message that will replace %1 in its body.
79  * @returns Message PropertyDuplicate formatted to JSON */
85  * @brief Formats PropertyUnknown message into JSON
86  * Message body: "The property <arg1> is not in the list of valid properties for
89  * @param[in] arg1 Parameter of message that will replace %1 in its body.
91  * @returns Message PropertyUnknown formatted to JSON */
97  * @brief Formats PropertyValueTypeError message into JSON
98  * Message body: "The value <arg1> for the property <arg2> is not a type that
101  * @param[in] arg1 Parameter of message that will replace %1 in its body.
102  * @param[in] arg2 Parameter of message that will replace %2 in its body.
104  * @returns Message PropertyValueTypeError formatted to JSON */
112  * @brief Formats PropertyValueFormatError message into JSON
113  * Message body: "The value <arg1> for the property <arg2> is not a format that
116  * @param[in] arg1 Parameter of message that will replace %1 in its body.
117  * @param[in] arg2 Parameter of message that will replace %2 in its body.
119  * @returns Message PropertyValueFormatError formatted to JSON */
127  * @brief Formats PropertyValueNotInList message into JSON
128  * Message body: "The value <arg1> for the property <arg2> is not in the list of
131  * @param[in] arg1 Parameter of message that will replace %1 in its body.
132  * @param[in] arg2 Parameter of message that will replace %2 in its body.
134  * @returns Message PropertyValueNotInList formatted to JSON */
142  * @brief Formats PropertyValueOutOfRange message into JSON
143  * Message body: "The value <arg1> for the property <arg2> is not in the
146  * @param[in] arg1 Parameter of message that will replace %1 in its body.
147  * @param[in] arg2 Parameter of message that will replace %2 in its body.
149  * @returns Message PropertyValueOutOfRange formatted to JSON */
157  * @brief Formats PropertyValueError message into JSON
158  * Message body: "The value provided for the property <arg1> is not valid."
160  * @param[in] arg1 Parameter of message that will replace %1 in its body.
162  * @returns Message PropertyValueError formatted to JSON */
168  * @brief Formats PropertyNotWritable message into JSON
169  * Message body: "The property <arg1> is a read-only property and cannot be
172  * @param[in] arg1 Parameter of message that will replace %1 in its body.
174  * @returns Message PropertyNotWritable formatted to JSON */
180  * @brief Formats PropertyNotUpdated message into JSON
181  * Message body: "The property <arg1> was not updated due to an internal service
184  * @param[in] arg1 Parameter of message that will replace %1 in its body.
186  * @returns Message PropertyNotUpdated formatted to JSON */
192  * @brief Formats PropertyMissing message into JSON
193  * Message body: "The property <arg1> is a required property and must be
196  * @param[in] arg1 Parameter of message that will replace %1 in its body.
198  * @returns Message PropertyMissing formatted to JSON */
204  * @brief Formats MalformedJSON message into JSON
205  * Message body: "The request body submitted was malformed JSON and could not be
209  * @returns Message MalformedJSON formatted to JSON */
215  * @brief Formats InvalidJSON message into JSON
216  * Message body: "The request body submitted is invalid JSON starting at line
219  * @param[in] arg1 Parameter of message that will replace %1 in its body.
221  * @returns Message InvalidJSON formatted to JSON */
227  * @brief Formats EmptyJSON message into JSON
228  * Message body: "The request body submitted contained an empty JSON object and
232  * @returns Message EmptyJSON formatted to JSON */
238  * @brief Formats ActionNotSupported message into JSON
239  * Message body: "The action <arg1> is not supported by the resource."
241  * @param[in] arg1 Parameter of message that will replace %1 in its body.
243  * @returns Message ActionNotSupported formatted to JSON */
249  * @brief Formats ActionParameterMissing message into JSON
250  * Message body: "The action <arg1> requires the parameter <arg2> to be present
253  * @param[in] arg1 Parameter of message that will replace %1 in its body.
254  * @param[in] arg2 Parameter of message that will replace %2 in its body.
256  * @returns Message ActionParameterMissing formatted to JSON */
264  * @brief Formats ActionParameterDuplicate message into JSON
265  * Message body: "The action <arg1> was submitted with more than one value for
268  * @param[in] arg1 Parameter of message that will replace %1 in its body.
269  * @param[in] arg2 Parameter of message that will replace %2 in its body.
271  * @returns Message ActionParameterDuplicate formatted to JSON */
279  * @brief Formats ActionParameterUnknown message into JSON
280  * Message body: "The action <arg1> was submitted with the invalid parameter
283  * @param[in] arg1 Parameter of message that will replace %1 in its body.
284  * @param[in] arg2 Parameter of message that will replace %2 in its body.
286  * @returns Message ActionParameterUnknown formatted to JSON */
294  * @brief Formats ActionParameterValueTypeError message into JSON
295  * Message body: "The value <arg1> for the parameter <arg2> in the action <arg3>
298  * @param[in] arg1 Parameter of message that will replace %1 in its body.
299  * @param[in] arg2 Parameter of message that will replace %2 in its body.
300  * @param[in] arg3 Parameter of message that will replace %3 in its body.
302  * @returns Message ActionParameterValueTypeError formatted to JSON */
311  * @brief Formats ActionParameterValueFormatError message into JSON
312  * Message body: "The value <arg1> for the parameter <arg2> in the action <arg3>
315  * @param[in] arg1 Parameter of message that will replace %1 in its body.
316  * @param[in] arg2 Parameter of message that will replace %2 in its body.
317  * @param[in] arg3 Parameter of message that will replace %3 in its body.
319  * @returns Message ActionParameterValueFormatError formatted to JSON */
328  * @brief Formats ActionParameterValueNotInList message into JSON
329  * Message body: "The value <arg1> for the parameter <arg2> in the action <arg3>
332  * @param[in] arg1 Parameter of message that will replace %1 in its body.
333  * @param[in] arg2 Parameter of message that will replace %2 in its body.
334  * @param[in] arg3 Parameter of message that will replace %3 in its body.
336  * @returns Message ActionParameterValueNotInList formatted to JSON */
345  * @brief Formats ActionParameterValueOutOfRange message into JSON
346  * Message body: "The value <arg1> for the parameter <arg2> in the action <arg3>
349  * @param[in] arg1 Parameter of message that will replace %1 in its body.
350  * @param[in] arg2 Parameter of message that will replace %2 in its body.
351  * @param[in] arg3 Parameter of message that will replace %3 in its body.
353  * @returns Message ActionParameterValueOutOfRange formatted to JSON */
362  * @brief Formats ActionParameterValueError message into JSON
363  * Message body: "The value for the parameter <arg1> in the action <arg2> is
366  * @param[in] arg1 Parameter of message that will replace %1 in its body.
367  * @param[in] arg2 Parameter of message that will replace %2 in its body.
369  * @returns Message ActionParameterValueError formatted to JSON */
377  * @brief Formats ActionParameterNotSupported message into JSON
378  * Message body: "The parameter <arg1> for the action <arg2> is not supported on
381  * @param[in] arg1 Parameter of message that will replace %1 in its body.
382  * @param[in] arg2 Parameter of message that will replace %2 in its body.
384  * @returns Message ActionParameterNotSupported formatted to JSON */
392  * @brief Formats ArraySizeTooLong message into JSON
393  * Message body: "The array provided for property <arg1> exceeds the size limit
396  * @param[in] arg1 Parameter of message that will replace %1 in its body.
397  * @param[in] arg2 Parameter of message that will replace %2 in its body.
399  * @returns Message ArraySizeTooLong formatted to JSON */
406  * @brief Formats ArraySizeTooShort message into JSON
407  * Message body: "The array provided for property <arg1> is under the minimum
410  * @param[in] arg1 Parameter of message that will replace %1 in its body.
411  * @param[in] arg2 Parameter of message that will replace %2 in its body.
413  * @returns Message ArraySizeTooShort formatted to JSON */
421  * @brief Formats QueryParameterValueTypeError message into JSON
422  * Message body: "The value <arg1> for the query parameter <arg2> is not a type
425  * @param[in] arg1 Parameter of message that will replace %1 in its body.
426  * @param[in] arg2 Parameter of message that will replace %2 in its body.
428  * @returns Message QueryParameterValueTypeError formatted to JSON */
436  * @brief Formats QueryParameterValueFormatError message into JSON
437  * Message body: "The value <arg1> for the parameter <arg2> is not a format that
440  * @param[in] arg1 Parameter of message that will replace %1 in its body.
441  * @param[in] arg2 Parameter of message that will replace %2 in its body.
443  * @returns Message QueryParameterValueFormatError formatted to JSON */
451  * @brief Formats QueryParameterValueError message into JSON
452  * Message body: "The value for the parameter <arg1> is invalid."
454  * @param[in] arg1 Parameter of message that will replace %1 in its body.
456  * @returns Message QueryParameterValueError formatted to JSON */
462  * @brief Formats QueryParameterOutOfRange message into JSON
463  * Message body: "The value <arg1> for the query parameter <arg2> is out of
466  * @param[in] arg1 Parameter of message that will replace %1 in its body.
467  * @param[in] arg2 Parameter of message that will replace %2 in its body.
468  * @param[in] arg3 Parameter of message that will replace %3 in its body.
470  * @returns Message QueryParameterOutOfRange formatted to JSON */
478  * @brief Formats QueryNotSupportedOnResource message into JSON
479  * Message body: "Querying is not supported on the requested resource."
482  * @returns Message QueryNotSupportedOnResource formatted to JSON */
488  * @brief Formats QueryNotSupportedOnOperation message into JSON
489  * Message body: "Querying is not supported with the requested operation."
492  * @returns Message QueryNotSupportedOnOperation formatted to JSON */
498  * @brief Formats QueryNotSupported message into JSON
499  * Message body: "Querying is not supported by the implementation."
502  * @returns Message QueryNotSupported formatted to JSON */
508  * @brief Formats QueryCombinationInvalid message into JSON
509  * Message body: "Two or more query parameters in the request cannot be used
513  * @returns Message QueryCombinationInvalid formatted to JSON */
519  * @brief Formats QueryParameterUnsupported message into JSON
520  * Message body: "Query parameter <arg1> is not supported."
522  * @param[in] arg1 Parameter of message that will replace %1 in its body.
524  * @returns Message QueryParameterUnsupported formatted to JSON */
530  * @brief Formats SessionLimitExceeded message into JSON
531  * Message body: "The session establishment failed due to the number of
535  * @returns Message SessionLimitExceeded formatted to JSON */
541  * @brief Formats EventSubscriptionLimitExceeded message into JSON
542  * Message body: "The event subscription failed due to the number of
546  * @returns Message EventSubscriptionLimitExceeded formatted to JSON */
552  * @brief Formats ResourceCannotBeDeleted message into JSON
553  * Message body: "The delete request failed because the resource requested
557  * @returns Message ResourceCannotBeDeleted formatted to JSON */
563  * @brief Formats ResourceInUse message into JSON
564  * Message body: "The change to the requested resource failed because the
568  * @returns Message ResourceInUse formatted to JSON */
574  * @brief Formats ResourceAlreadyExists message into JSON
575  * Message body: "The requested resource of type <arg1> with the property <arg2>
578  * @param[in] arg1 Parameter of message that will replace %1 in its body.
579  * @param[in] arg2 Parameter of message that will replace %2 in its body.
580  * @param[in] arg3 Parameter of message that will replace %3 in its body.
582  * @returns Message ResourceAlreadyExists formatted to JSON */
590  * @brief Formats ResourceNotFound message into JSON
591  * Message body: "The requested resource of type <arg1> named <arg2> was not
594  * @param[in] arg1 Parameter of message that will replace %1 in its body.
595  * @param[in] arg2 Parameter of message that will replace %2 in its body.
597  * @returns Message ResourceNotFound formatted to JSON */
605  * @brief Formats PayloadTooLarge message into JSON
606  * Message body: "The supplied payload exceeds the maximum size supported by the
610  * @returns Message PayloadTooLarge formatted to JSON */
616  * @brief Formats InsufficientStorage message into JSON
617  * Message body: "Insufficient storage or memory available to complete the
621  * @returns Message InsufficientStorage formatted to JSON */
627  * @brief Formats MissingOrMalformedPart message into JSON
628  * Message body: "The multipart request contains malformed parts or is missing
632  * @returns Message MissingOrMalformedPart formatted to JSON */
638  * @brief Formats InvalidURI message into JSON
639  * Message body: "The URI <arg1> was not found."
641  * @param[in] arg1 Parameter of message that will replace %1 in its body.
643  * @returns Message InvalidURI formatted to JSON */
649  * @brief Formats CreateFailedMissingReqProperties message into JSON
650  * Message body: "The create operation failed because the required property
653  * @param[in] arg1 Parameter of message that will replace %1 in its body.
655  * @returns Message CreateFailedMissingReqProperties formatted to JSON */
663  * @brief Formats CreateLimitReachedForResource message into JSON
664  * Message body: "The create operation failed because the resource has reached
668  * @returns Message CreateLimitReachedForResource formatted to JSON */
674  * @brief Formats ServiceShuttingDown message into JSON
675  * Message body: "The operation failed because the service is shutting down and
679  * @returns Message ServiceShuttingDown formatted to JSON */
685  * @brief Formats ServiceInUnknownState message into JSON
686  * Message body: "The operation failed because the service is in an unknown
690  * @returns Message ServiceInUnknownState formatted to JSON */
696  * @brief Formats NoValidSession message into JSON
697  * Message body: "There is no valid session established with the
701  * @returns Message NoValidSession formatted to JSON */
707  * @brief Formats InsufficientPrivilege message into JSON
708  * Message body: "There are insufficient privileges for the account or
713  * @returns Message InsufficientPrivilege formatted to JSON */
719  * @brief Formats AccountModified message into JSON
720  * Message body: "The account was successfully modified."
723  * @returns Message AccountModified formatted to JSON */
729  * @brief Formats AccountNotModified message into JSON
730  * Message body: "The account modification request failed."
733  * @returns Message AccountNotModified formatted to JSON */
739  * @brief Formats AccountRemoved message into JSON
740  * Message body: "The account was successfully removed."
743  * @returns Message AccountRemoved formatted to JSON */
749  * @brief Formats AccountForSessionNoLongerExists message into JSON
750  * Message body: "The account for the current session was removed, and so the
754  * @returns Message AccountForSessionNoLongerExists formatted to JSON */
760  * @brief Formats InvalidObject message into JSON
761  * Message body: "The object at <arg1> is invalid."
763  * @param[in] arg1 Parameter of message that will replace %1 in its body.
765  * @returns Message InvalidObject formatted to JSON */
771  * @brief Formats InternalError message into JSON
772  * Message body: "The request failed due to an internal service error.  The
776  * @returns Message InternalError formatted to JSON */
783  * @brief Formats UnrecognizedRequestBody message into JSON
784  * Message body: "The service detected a malformed request body that it was
788  * @returns Message UnrecognizedRequestBody formatted to JSON */
794  * @brief Formats ResourceMissingAtURI message into JSON
795  * Message body: "The resource at the URI <arg1> was not found."
797  * @param[in] arg1 Parameter of message that will replace %1 in its body.
799  * @returns Message ResourceMissingAtURI formatted to JSON */
807  * @brief Formats ResourceAtUriInUnknownFormat message into JSON
808  * Message body: "The resource at <arg1> is in a format not recognized by the
811  * @param[in] arg1 Parameter of message that will replace %1 in its body.
813  * @returns Message ResourceAtUriInUnknownFormat formatted to JSON */
821  * @brief Formats ResourceAtUriUnauthorized message into JSON
822  * Message body: "While accessing the resource at <arg1>, the service received
825  * @param[in] arg1 Parameter of message that will replace %1 in its body.
826  * @param[in] arg2 Parameter of message that will replace %2 in its body.
828  * @returns Message ResourceAtUriUnauthorized formatted to JSON */
837  * @brief Formats CouldNotEstablishConnection message into JSON
838  * Message body: "The service failed to establish a connection with the URI
841  * @param[in] arg1 Parameter of message that will replace %1 in its body.
843  * @returns Message CouldNotEstablishConnection formatted to JSON */
851  * @brief Formats SourceDoesNotSupportProtocol message into JSON
852  * Message body: "The other end of the connection at <arg1> does not support the
855  * @param[in] arg1 Parameter of message that will replace %1 in its body.
856  * @param[in] arg2 Parameter of message that will replace %2 in its body.
858  * @returns Message SourceDoesNotSupportProtocol formatted to JSON */
867  * @brief Formats AccessDenied message into JSON
868  * Message body: "While attempting to establish a connection to <arg1>, the
871  * @param[in] arg1 Parameter of message that will replace %1 in its body.
873  * @returns Message AccessDenied formatted to JSON */
879  * @brief Formats ServiceTemporarilyUnavailable message into JSON
880  * Message body: "The service is temporarily unavailable.  Retry in <arg1>
883  * @param[in] arg1 Parameter of message that will replace %1 in its body.
885  * @returns Message ServiceTemporarilyUnavailable formatted to JSON */
891  * @brief Formats InvalidIndex message into JSON
892  * Message body: "The index <arg1> is not a valid offset into the array."
894  * @param[in] arg1 Parameter of message that will replace %1 in its body.
896  * @returns Message InvalidIndex formatted to JSON */
902  * @brief Formats PropertyValueModified message into JSON
903  * Message body: "The property <arg1> was assigned the value <arg2> due to
906  * @param[in] arg1 Parameter of message that will replace %1 in its body.
907  * @param[in] arg2 Parameter of message that will replace %2 in its body.
909  * @returns Message PropertyValueModified formatted to JSON */
917  * @brief Formats ResourceInStandby message into JSON
918  * Message body: "The request could not be performed because the resource is in
922  * @returns Message ResourceInStandby formatted to JSON */
928  * @brief Formats ResourceExhaustion message into JSON
929  * Message body: "The resource <arg1> was unable to satisfy the request due to
932  * @param[in] arg1 Parameter of message that will replace %1 in its body.
934  * @returns Message ResourceExhaustion formatted to JSON */
940  * @brief Formats StringValueTooLong message into JSON
941  * Message body: "The string <arg1> exceeds the length limit <arg2>."
943  * @param[in] arg1 Parameter of message that will replace %1 in its body.
944  * @param[in] arg2 Parameter of message that will replace %2 in its body.
946  * @returns Message StringValueTooLong formatted to JSON */
954  * @brief Formats StringValueTooShort message into JSON
955  * Message body: "The string <arg1> was under the minimum required length
958  * @param[in] arg1 Parameter of message that will replace %1 in its body.
959  * @param[in] arg2 Parameter of message that will replace %2 in its body.
961  * @returns Message StringValueTooShort formatted to JSON */
969  * @brief Formats SessionTerminated message into JSON
970  * Message body: "The session was successfully terminated."
973  * @returns Message SessionTerminated formatted to JSON */
979  * @brief Formats SubscriptionTerminated message into JSON
980  * Message body: "The event subscription was terminated."
983  * @returns Message SubscriptionTerminated formatted to JSON */
989  * @brief Formats ResourceTypeIncompatible message into JSON
990  * Message body: "The @odata.type of the request body <arg1> is incompatible
993  * @param[in] arg1 Parameter of message that will replace %1 in its body.
994  * @param[in] arg2 Parameter of message that will replace %2 in its body.
996  * @returns Message ResourceTypeIncompatible formatted to JSON */
1004  * @brief Formats PasswordChangeRequired message into JSON
1005  * Message body: "The password provided for this account must be changed before
1009  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1011  * @returns Message PasswordChangeRequired formatted to JSON */
1019  * @brief Formats ResetRequired message into JSON
1020  * Message body: "In order to apply changes, recover from errors, or complete
1024  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1025  * @param[in] arg2 Parameter of message that will replace %2 in its body.
1027  * @returns Message ResetRequired formatted to JSON */
1035  * @brief Formats ResetRecommended message into JSON
1036  * Message body: "In order to recover from errors, a component reset is
1039  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1040  * @param[in] arg2 Parameter of message that will replace %2 in its body.
1042  * @returns Message ResetRecommended formatted to JSON */
1050  * @brief Formats ChassisPowerStateOnRequired message into JSON
1051  * Message body: "The chassis with Id <arg1> is required to be powered on to
1054  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1056  * @returns Message ChassisPowerStateOnRequired formatted to JSON */
1062  * @brief Formats ChassisPowerStateOffRequired message into JSON
1063  * Message body: "The chassis with Id <arg1> is required to be powered off to
1066  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1068  * @returns Message ChassisPowerStateOffRequired formatted to JSON */
1074  * @brief Formats PropertyValueConflict message into JSON
1075  * Message body: "The property <arg1> could not be written because its value
1078  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1079  * @param[in] arg2 Parameter of message that will replace %2 in its body.
1081  * @returns Message PropertyValueConflict formatted to JSON */
1089  * @brief Formats PropertyValueResourceConflict message into JSON
1090  * Message body: "The property <arg1> with the requested value of <arg2> could
1094  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1095  * @param[in] arg2 Parameter of message that will replace %2 in its body.
1096  * @param[in] arg3 Parameter of message that will replace %3 in its body.
1098  * @returns Message PropertyValueResourceConflict formatted to JSON */
1108  * @brief Formats PropertyValueExternalConflict message into JSON
1109  * Message body: "The property <arg1> with the requested value of <arg2> could
1113  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1114  * @param[in] arg2 Parameter of message that will replace %2 in its body.
1116  * @returns Message PropertyValueExternalConflict formatted to JSON */
1124  * @brief Formats PropertyValueIncorrect message into JSON
1125  * Message body: "The property <arg1> with the requested value of <arg2> could
1129  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1130  * @param[in] arg2 Parameter of message that will replace %2 in its body.
1132  * @returns Message PropertyValueIncorrect formatted to JSON */
1140  * @brief Formats ResourceCreationConflict message into JSON
1141  * Message body: "The resource could not be created.  The service has a resource
1144  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1146  * @returns Message ResourceCreationConflict formatted to JSON */
1154  * @brief Formats ActionParameterValueConflict message into JSON
1155  * Message body: "The parameter <arg1> with the requested value of <arg2> does
1158  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1159  * @param[in] arg2 Parameter of message that will replace %2 in its body.
1161  * @returns Message ActionParameterValueConflict formatted to JSON */
1169  * @brief Formats MaximumErrorsExceeded message into JSON
1170  * Message body: "Too many errors have occurred to report them all."
1173  * @returns Message MaximumErrorsExceeded formatted to JSON */
1179  * @brief Formats PreconditionFailed message into JSON
1180  * Message body: "The ETag supplied did not match the ETag required to change
1184  * @returns Message PreconditionFailed formatted to JSON */
1190  * @brief Formats PreconditionRequired message into JSON
1191  * Message body: "A precondition header or annotation is required to change this
1195  * @returns Message PreconditionRequired formatted to JSON */
1201  * @brief Formats HeaderMissing message into JSON
1202  * Message body: "Required header <arg1> is missing in the request."
1204  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1206  * @returns Message HeaderMissing formatted to JSON */
1212  * @brief Formats HeaderInvalid message into JSON
1213  * Message body: "Header <arg1> is invalid."
1215  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1217  * @returns Message HeaderInvalid formatted to JSON */
1223  * @brief Formats OperationFailed message into JSON
1224  * Message body: "An error occurred internal to the service as part of the
1228  * @returns Message OperationFailed formatted to JSON */
1234  * @brief Formats OperationTimeout message into JSON
1235  * Message body: "A timeout internal to the service occurred as part of the
1239  * @returns Message OperationTimeout formatted to JSON */
1245  * @brief Formats OperationNotAllowed message into JSON
1246  * Message body: "The HTTP method is not allowed on this resource."
1249  * @returns Message OperationNotAllowed formatted to JSON */
1255  * @brief Formats UndeterminedFault message into JSON
1256  * Message body: "An undetermined fault condition was reported by <arg1>."
1258  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1260  * @returns Message UndeterminedFault formatted to JSON */
1266  * @brief Formats ConditionInRelatedResource message into JSON
1267  * Message body: "One or more conditions exist in a related resource.  See the
1271  * @returns Message ConditionInRelatedResource formatted to JSON */
1277  * @brief Formats RestrictedRole message into JSON
1278  * Message body: "The operation was not successful because the role <arg1> is
1281  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1283  * @returns Message RestrictedRole formatted to JSON */
1289  * @brief Formats RestrictedPrivilege message into JSON
1290  * Message body: "The operation was not successful because the privilege <arg1>
1293  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1295  * @returns Message RestrictedPrivilege formatted to JSON */
1301  * @brief Formats StrictAccountTypes message into JSON
1302  * Message body: "The request could not be fulfilled with the account types
1306  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1308  * @returns Message StrictAccountTypes formatted to JSON */
1314  * @brief Formats PropertyDeprecated message into JSON
1315  * Message body: "The deprecated property <arg1> was included in the request
1318  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1320  * @returns Message PropertyDeprecated formatted to JSON */
1326  * @brief Formats ResourceDeprecated message into JSON
1327  * Message body: "The operation was performed on a deprecated resource <arg1>."
1329  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1331  * @returns Message ResourceDeprecated formatted to JSON */
1337  * @brief Formats PropertyValueDeprecated message into JSON
1338  * Message body: "The value <arg1> for the property <arg2> is deprecated."
1340  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1341  * @param[in] arg2 Parameter of message that will replace %2 in its body.
1343  * @returns Message PropertyValueDeprecated formatted to JSON */
1351  * @brief Formats ActionDeprecated message into JSON
1352  * Message body: "The action <arg1> is deprecated."
1354  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1356  * @returns Message ActionDeprecated formatted to JSON */
1362  * @brief Formats NetworkNameResolutionNotConfigured message into JSON
1363  * Message body: "Network name resolution is not configured on this service."
1366  * @returns Message NetworkNameResolutionNotConfigured formatted to JSON */
1372  * @brief Formats NetworkNameResolutionNotSupported message into JSON
1373  * Message body: "Resolution of network-based names is not supported by this
1377  * @returns Message NetworkNameResolutionNotSupported formatted to JSON */
1383  * @brief Formats ServiceDisabled message into JSON
1384  * Message body: "The operation failed because the service at <arg1> is disabled
1387  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1389  * @returns Message ServiceDisabled formatted to JSON */
1395  * @brief Formats EventBufferExceeded message into JSON
1396  * Message body: "Undelivered events may have been lost due to exceeding the
1400  * @returns Message EventBufferExceeded formatted to JSON */
1406  * @brief Formats AuthenticationTokenRequired message into JSON
1407  * Message body: "The request could not be performed because an authentication
1411  * @returns Message AuthenticationTokenRequired formatted to JSON */
1417  * @brief Formats OneTimePasscodeSent message into JSON
1418  * Message body: "A one-time passcode was sent to: <arg1>.  Supply the passcode
1421  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1423  * @returns Message OneTimePasscodeSent formatted to JSON */
1429  * @brief Formats LicenseRequired message into JSON
1430  * Message body: "A license is required for this operation: <arg1>."
1432  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1434  * @returns Message LicenseRequired formatted to JSON */
1440  * @brief Formats PropertyModified message into JSON
1441  * Message body: "One or more properties were successfully modified."
1444  * @returns Message PropertyModified formatted to JSON */
1450  * @brief Formats GenerateSecretKeyRequired message into JSON
1451  * Message body: "The Time-based One-Time Password (TOTP) secret key for this
1456  * @param[in] arg1 Parameter of message that will replace %1 in its body.
1458  * @returns Message GenerateSecretKeyRequired formatted to JSON */