AWS iotevents documentation change
Summary
Added '**Solution:**' prefix to all diagnostic error/warning explanations to improve documentation structure and clarity.
Security assessment
Changes are purely structural/documentation improvements adding solution labels. No security vulnerabilities, exploits, or weaknesses are mentioned or addressed. Modifications focus on error message explanations without security context.
Diff
diff --git a/iotevents/latest/developerguide/analyze-diagnostic-information.md b/iotevents/latest/developerguide/analyze-diagnostic-information.md index e85993dec..86b7fb1e1 100644 --- a//iotevents/latest/developerguide/analyze-diagnostic-information.md +++ b//iotevents/latest/developerguide/analyze-diagnostic-information.md @@ -85 +85 @@ An analysis result with information about `Location`, corresponds to the followi -You might receive this error message if you specified an action that AWS IoT Events currently doesn't support. For a list of supported actions, see [Supported actions to receive data and trigger actions in AWS IoT Events](./iotevents-supported-actions.html). +**Solution:** You might receive this error message if you specified an action that AWS IoT Events currently doesn't support. For a list of supported actions, see [Supported actions to receive data and trigger actions in AWS IoT Events](./iotevents-supported-actions.html). @@ -96 +96 @@ An analysis result with information about `supported‐actions`, corresponds to -You might receive this error message if you specified an action that AWS IoT Events currently doesn't support. For a list of supported actions, see [Supported actions to receive data and trigger actions in AWS IoT Events](./iotevents-supported-actions.html). +**Solution:** You might receive this error message if you specified an action that AWS IoT Events currently doesn't support. For a list of supported actions, see [Supported actions to receive data and trigger actions in AWS IoT Events](./iotevents-supported-actions.html). @@ -100 +100 @@ You might receive this error message if you specified an action that AWS IoT Eve -You might receive this error message if the action that you specified is supported by AWS IoT Events, but the action isn't available in your current Region. This might occur when you try to send data to an AWS service that isn't available in the Region. You must also choose the same Region for both AWS IoT Events and the AWS services that you're using. +**Solution:** You might receive this error message if the action that you specified is supported by AWS IoT Events, but the action isn't available in your current Region. This might occur when you try to send data to an AWS service that isn't available in the Region. You must also choose the same Region for both AWS IoT Events and the AWS services that you're using. @@ -111 +111 @@ An analysis result with information about `service‐limits`, corresponds to the -You might receive this error message if the content expression for your action payload is greater than 1024 bytes. The size of the content expression for a payload can be up to 1024 bytes. +**Solution:** You might receive this error message if the content expression for your action payload is greater than 1024 bytes. The size of the content expression for a payload can be up to 1024 bytes. @@ -115 +115 @@ You might receive this error message if the content expression for your action p -You might receive this error message if your detector model has more than 20 states. A detector model can have up to 20 states. +**Solution:** You might receive this error message if your detector model has more than 20 states. A detector model can have up to 20 states. @@ -119 +119 @@ You might receive this error message if your detector model has more than 20 sta -You might receive this error message if the duration of your timer is less than 60 seconds. We recommend that the duration of a timer is between 60 and 31622400 seconds. If you specify an expression for the duration of your timer, the evaluated result of the duration expression is rounded down to the nearest whole number. +**Solution:** You might receive this error message if the duration of your timer is less than 60 seconds. We recommend that the duration of a timer is between 60 and 31622400 seconds. If you specify an expression for the duration of your timer, the evaluated result of the duration expression is rounded down to the nearest whole number. @@ -123 +123 @@ You might receive this error message if the duration of your timer is less than -You might receive this error message if the event has more than 10 actions. You can have up to 10 actions for each event in your detector model. +**Solution:** You might receive this error message if the event has more than 10 actions. You can have up to 10 actions for each event in your detector model. @@ -127 +127 @@ You might receive this error message if the event has more than 10 actions. You -You might receive this error message if the state has more than 20 transition events. You can have up to 20 transition events for each state in your detector model. +**Solution:** You might receive this error message if the state has more than 20 transition events. You can have up to 20 transition events for each state in your detector model. @@ -131 +131 @@ You might receive this error message if the state has more than 20 transition ev -You might receive this error message if the state has more than 20 events. You can have up to 20 events for each state in your detector model. +**Solution:** You might receive this error message if the state has more than 20 events. You can have up to 20 events for each state in your detector model. @@ -135 +135 @@ You might receive this error message if the state has more than 20 events. You c -You might receive this warning message if you tried to route an input to more than 10 detector models. You can have up to 10 different detector models associated with a single detector model. +**Solution:** You might receive this warning message if you tried to route an input to more than 10 detector models. You can have up to 10 different detector models associated with a single detector model. @@ -146 +146 @@ An analysis result with information about `structure`, corresponds to the follow -You might receive this error message if you specified two or more actions in a single field by using API operations to create or update your detector model. You can define an array of `Action` objects. Make sure that you define each action as a separate object. +**Solution:** You might receive this error message if you specified two or more actions in a single field by using API operations to create or update your detector model. You can define an array of `Action` objects. Make sure that you define each action as a separate object. @@ -150 +150 @@ You might receive this error message if you specified two or more actions in a s -You might receive this error message if AWS IoT Events couldn't find the next state that your transition event referenced. Make sure that the next state is defined and that you entered the correct state name. +**Solution:** You might receive this error message if AWS IoT Events couldn't find the next state that your transition event referenced. Make sure that the next state is defined and that you entered the correct state name. @@ -154 +154 @@ You might receive this error message if AWS IoT Events couldn't find the next st -You might receive this error message if you use the same name for one or more states. Make sure that you give a unique name to each state in your detector model. The state name must have 1-128 characters. Valid characters: a-z, A-Z, 0-9, _ (underscore), and - (hyphen). +**Solution:** You might receive this error message if you use the same name for one or more states. Make sure that you give a unique name to each state in your detector model. The state name must have 1-128 characters. Valid characters: a-z, A-Z, 0-9, _ (underscore), and - (hyphen). @@ -158 +158 @@ You might receive this error message if you use the same name for one or more st -You might receive this error message if the initial state name is incorrect. The detector model remains in the initial (start) state until an input arrives. Once an input arrives, the detector model immediately transitions to the next state. Make sure that the initial state name is the name of a defined state and that you enter the correct name. +**Solution:** You might receive this error message if the initial state name is incorrect. The detector model remains in the initial (start) state until an input arrives. Once an input arrives, the detector model immediately transitions to the next state. Make sure that the initial state name is the name of a defined state and that you enter the correct name. @@ -162 +162 @@ You might receive this error message if the initial state name is incorrect. The -You might receive this error if you didn't specify an input in a condition. You must use at least one input in at least one condition. Otherwise, AWS IoT Events doesn't evaluate incoming data. +**Solution:** You might receive this error if you didn't specify an input in a condition. You must use at least one input in at least one condition. Otherwise, AWS IoT Events doesn't evaluate incoming data. @@ -166 +166 @@ You might receive this error if you didn't specify an input in a condition. You -You might receive this error message if you used both `seconds` and `durationExpression` for your timer. Make sure that you use either `seconds` or `durationExpression` as the parameters of `SetTimerAction`. For more information, see [SetTimerAction](https://docs.aws.amazon.com/iotevents/latest/apireference/API_SetTimerAction.html) in the _AWS IoT Events API Reference_. +**Solution:** You might receive this error message if you used both `seconds` and `durationExpression` for your timer. Make sure that you use either `seconds` or `durationExpression` as the parameters of `SetTimerAction`. For more information, see [SetTimerAction](https://docs.aws.amazon.com/iotevents/latest/apireference/API_SetTimerAction.html) in the _AWS IoT Events API Reference_. @@ -170 +170 @@ You might receive this error message if you used both `seconds` and `durationExp -If an action in your detector model is unreachable, the event's condition evaluates to false. Check the condition of the event that contains the action, to ensure that it evaluates to true. When the event's condition evaluates to true, the action should become reachable. +**Solution:** If an action in your detector model is unreachable, the event's condition evaluates to false. Check the condition of the event that contains the action, to ensure that it evaluates to true. When the event's condition evaluates to true, the action should become reachable. @@ -174 +174 @@ If an action in your detector model is unreachable, the event's condition evalua -An input attribute’s value can be read when either of the following occurs: +**Solution:** An input attribute’s value can be read when either of the following occurs: @@ -194 +194 @@ where a call to the `triggerType(“Message”)` function comes before the initi -If a state in your detector model is unreachable, a condition that causes an incoming transition to that state evaluates to false. Check that the conditions of the incoming transitions to that unreachable state in your detector model evaluates to true, so the desired state can become reachable. +**Solution:** If a state in your detector model is unreachable, a condition that causes an incoming transition to that state evaluates to false. Check that the conditions of the incoming transitions to that unreachable state in your detector model evaluates to true, so the desired state can become reachable. @@ -198 +198 @@ If a state in your detector model is unreachable, a condition that causes an inc -To prevent your detector model from entering into an infinite state of sending an unexpected amount of messages because a timer has expired, consider using a call to the `triggerType("Message")` function, in the conditions of your detector model as follows: +**Solution:** To prevent your detector model from entering into an infinite state of sending an unexpected amount of messages because a timer has expired, consider using a call to the `triggerType("Message")` function, in the conditions of your detector model as follows: @@ -221 +221 @@ An analysis result with information about `expression‐syntax`, corresponds to -If the specified payload type is JSON, AWS IoT Events first checks if the service can evaluate your expression to a string. The evaluated result can't be a Boolean or number. If the validation doesn't succeed, you might receive this error. +**Solution:** If the specified payload type is JSON, AWS IoT Events first checks if the service can evaluate your expression to a string. The evaluated result can't be a Boolean or number. If the validation doesn't succeed, you might receive this error. @@ -225 +225 @@ If the specified payload type is JSON, AWS IoT Events first checks if the servic -You can use `SetVariableAction` to define a variable with a `name` and `value`. The `value` can be a string, number, or Boolean value. You can also specify an expression for the `value`. For more information, see [SetVariableAction](https://docs.aws.amazon.com/iotevents/latest/apireference/API_SetVariableAction.html), in the _AWS IoT Events API Reference_. +**Solution:** You can use `SetVariableAction` to define a variable with a `name` and `value`. The `value` can be a string, number, or Boolean value. You can also specify an expression for the `value`. For more information, see [SetVariableAction](https://docs.aws.amazon.com/iotevents/latest/apireference/API_SetVariableAction.html), in the _AWS IoT Events API Reference_. @@ -229 +229 @@ You can use `SetVariableAction` to define a variable with a `name` and `value`. -You must use expressions for all parameters in `DynamoDBAction`. substitution templates. For more information, see [DynamoDBAction](https://docs.aws.amazon.com/iotevents/latest/apireference/API_DynamoDBAction.html) in the _AWS IoT Events API Reference_. +**Solution:** You must use expressions for all parameters in `DynamoDBAction`. substitution templates. For more information, see [DynamoDBAction](https://docs.aws.amazon.com/iotevents/latest/apireference/API_DynamoDBAction.html) in the _AWS IoT Events API Reference_. @@ -233 +233 @@ You must use expressions for all parameters in `DynamoDBAction`. substitution te -The `tableName` in `DynamoDBv2Action` must be a string. You must use an expression for the `tableName`. The expressions accept literals, operators, functions, references, and substitution templates. For more information, see [DynamoDBv2Action](https://docs.aws.amazon.com/iotevents/latest/apireference/API_DynamoDBv2Action.html) in the _AWS IoT Events API Reference_. +**Solution:** The `tableName` in `DynamoDBv2Action` must be a string. You must use an expression for the `tableName`. The expressions accept literals, operators, functions, references, and substitution templates. For more information, see [DynamoDBv2Action](https://docs.aws.amazon.com/iotevents/latest/apireference/API_DynamoDBv2Action.html) in the _AWS IoT Events API Reference_. @@ -237 +237 @@ The `tableName` in `DynamoDBv2Action` must be a string. You must use an expressi -The payload type for `DynamoDBv2` must be JSON. Make sure that AWS IoT Events can evaluate your content expression for the payload to valid JSON. For more information, see [DynamoDBv2Action](https://docs.aws.amazon.com/iotevents/latest/apireference/API_DynamoDBv2Action.html), in the _AWS IoT Events API Reference_. +**Solution:** The payload type for `DynamoDBv2` must be JSON. Make sure that AWS IoT Events can evaluate your content expression for the payload to valid JSON. For more information, see [DynamoDBv2Action](https://docs.aws.amazon.com/iotevents/latest/apireference/API_DynamoDBv2Action.html), in the _AWS IoT Events API Reference_. @@ -241 +241 @@ The payload type for `DynamoDBv2` must be JSON. Make sure that AWS IoT Events ca -The content expression can contain strings ('`string`'), variables ($variable.`variable-name`), input values ($input.`input-name`.`path-to-datum`), string concatenations, and strings that contain `${}`. +**Solution:** The content expression can contain strings ('`string`'), variables ($variable.`variable-name`), input values ($input.`input-name`.`path-to-datum`), string concatenations, and strings that contain `${}`. @@ -245 +245 @@ The content expression can contain strings ('`string`'), variables ($variable.`v -You might receive this error message, if you chose **Custom payload** for your action and didn't enter a content expression in the AWS IoT Events console. If you choose **Custom payload** , you must enter a content expression under **Custom payload**. For more information, see [Payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html) in the _AWS IoT Events API Reference_. +**Solution:** You might receive this error message, if you chose **Custom payload** for your action and didn't enter a content expression in the AWS IoT Events console. If you choose **Custom payload** , you must enter a content expression under **Custom payload**. For more information, see [Payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html) in the _AWS IoT Events API Reference_. @@ -249 +249 @@ You might receive this error message, if you chose **Custom payload** for your a -The evaluated result of your duration expression for the timer must be a value between 60–31622400. The evaluated result of the duration is rounded down to the nearest whole number. +**Solution:** The evaluated result of your duration expression for the timer must be a value between 60–31622400. The evaluated result of the duration is rounded down to the nearest whole number. @@ -253 +253 @@ The evaluated result of your duration expression for the timer must be a value b -You might receive this message if the expression for the specified action has incorrect syntax. Make sure that you enter an expression with the correct syntax. For more information, see [Syntax to filter device data and define actions in AWS IoT Events](./iotevents-expressions.html#expression-syntax). +**Solution:** You might receive this message if the expression for the specified action has incorrect syntax. Make sure that you enter an expression with the correct syntax. For more information, see [Syntax to filter device data and define actions in AWS IoT Events](./iotevents-expressions.html#expression-syntax). @@ -257 +257 @@ You might receive this message if the expression for the specified action has in -You might receive this error if AWS IoT Events couldn't parse your `fieldName` for `IotSitewiseAction`. Make sure the `fieldName` uses an expression that AWS IoT Events can parse. For more information, see [IotSiteWiseAction](https://docs.aws.amazon.com/iotevents/latest/apireference/API_IotSiteWiseAction.html) in the _AWS IoT Events API Reference_. +**Solution:** You might receive this error if AWS IoT Events couldn't parse your `fieldName` for `IotSitewiseAction`. Make sure the `fieldName` uses an expression that AWS IoT Events can parse. For more information, see [IotSiteWiseAction](https://docs.aws.amazon.com/iotevents/latest/apireference/API_IotSiteWiseAction.html) in the _AWS IoT Events API Reference_. @@ -268 +268 @@ An analysis result with information about `data‐type`, corresponds to the foll -You might receive this error message if AWS IoT Events couldn't evaluate the duration expression for your timer to a number. Make sure that your `durationExpression` can be converted to a number. Other data types, such as Boolean, aren't supported. +**Solution:** You might receive this error message if AWS IoT Events couldn't evaluate the duration expression for your timer to a number. Make sure that your `durationExpression` can be converted to a number. Other data types, such as Boolean, aren't supported. @@ -272 +272 @@ You might receive this error message if AWS IoT Events couldn't evaluate the dur -You might receive this error message if AWS IoT Events couldn't evaluate your `condition-expression` to a Boolean value. The Boolean value must be either `TRUE` or `FALSE`. Make sure that your condition expression can be converted to a Boolean value. If the result isn't a Boolean value, it's equivalent to `FALSE` and doesn't invoke the actions or transition to the `nextState` specified in the event. +**Solution:** You might receive this error message if AWS IoT Events couldn't evaluate your `condition-expression` to a Boolean value. The Boolean value must be either `TRUE` or `FALSE`. Make sure that your condition expression can be converted to a Boolean value. If the result isn't a Boolean value, it's equivalent to `FALSE` and doesn't invoke the actions or transition to the `nextState` specified in the event. @@ -276 +276 @@ You might receive this error message if AWS IoT Events couldn't evaluate your `c -**Solution** : All expressions for the same input attribute or variable in the detector model must reference the same data type. +**Solution:** **Solution** : All expressions for the same input attribute or variable in the detector model must reference the same data type. @@ -302 +302 @@ For more information, see [AWS IoT Events reference for inputs and variables in -You might receive this warning message if two expressions for the same input attribute or variable reference two data types. Make sure that your expressions for the same input attribute or variable reference the same data type in the detector model. +**Solution:** You might receive this warning message if two expressions for the same input attribute or variable reference two data types. Make sure that your expressions for the same input attribute or variable reference the same data type in the detector model. @@ -306 +306 @@ You might receive this warning message if two expressions for the same input att -You might receive this error message if your expression combines data types that are not compatible with a specified operator. For example, in the following expression, the operator `+` is compatible with Integer, Decimal, and String data types, but not operands of Boolean data type. +**Solution:** You might receive this error message if your expression combines data types that are not compatible with a specified operator. For example, in the following expression, the operator `+` is compatible with Integer, Decimal, and String data types, but not operands of Boolean data type. @@ -314 +314 @@ You must make sure that the data types you use with an operator are compatible. -You might receive this error message if two expressions for the same input attribute reference two data types for either the `OnEnterLifecycle` of a state, or for both the `OnInputLifecycle` and `OnExitLifecycle` of a state. Make sure your expressions in `OnEnterLifecycle` (or, both `OnInputLifecycle` and `OnExitLifecycle`) reference the same data type for each state of your detector model. +**Solution:** You might receive this error message if two expressions for the same input attribute reference two data types for either the `OnEnterLifecycle` of a state, or for both the `OnInputLifecycle` and `OnExitLifecycle` of a state. Make sure your expressions in `OnEnterLifecycle` (or, both `OnInputLifecycle` and `OnExitLifecycle`) reference the same data type for each state of your detector model. @@ -318 +318 @@ You might receive this error message if two expressions for the same input attri -You might receive this error if your specified payload type is JSON, but AWS IoT Events can't evaluate its expression to a String. Make sure the evaluated result is a String, not a Boolean or a number. +**Solution:** You might receive this error if your specified payload type is JSON, but AWS IoT Events can't evaluate its expression to a String. Make sure the evaluated result is a String, not a Boolean or a number. @@ -322 +322 @@ You might receive this error if your specified payload type is JSON, but AWS IoT -You might receive this error message if AWS IoT Events couldn't evaluate your interpolated expression to an integer or a Boolean value. Make sure your interpolated expression can be converted to an integer or a Boolean value, because other data types, such as tring, aren't supported. +**Solution:** You might receive this error message if AWS IoT Events couldn't evaluate your interpolated expression to an integer or a Boolean value. Make sure your interpolated expression can be converted to an integer or a Boolean value, because other data types, such as tring, aren't supported. @@ -326 +326 @@ You might receive this error message if AWS IoT Events couldn't evaluate your in -You might receive this error message if your expression in the `propertyValue` of `IotSitewiseAction` has a data type defined differently than the data type inferred by AWS IoT Events. Make sure you use the same data type for all instances of this expression in your detector model. +**Solution:** You might receive this error message if your expression in the `propertyValue` of `IotSitewiseAction` has a data type defined differently than the data type inferred by AWS IoT Events. Make sure you use the same data type for all instances of this expression in your detector model. @@ -330 +330 @@ You might receive this error message if your expression in the `propertyValue` o -You might receive this error message if the inferred data type for your duration expression isn't Integer or Decimal. Make sure your `durationExpression` can be converted to a number. Other data types, such as Boolean and String, aren't supported. +**Solution:** You might receive this error message if the inferred data type for your duration expression isn't Integer or Decimal. Make sure your `durationExpression` can be converted to a number. Other data types, such as Boolean and String, aren't supported. @@ -334 +334 @@ You might receive this error message if the inferred data type for your duration -The inferred data types for the operands of the `operator` in the conditional expression (`expression`) of your detector model don't match. The operands must be used with the matching data types in all other parts of your detector model. +**Solution:** The inferred data types for the operands of the `operator` in the conditional expression (`expression`) of your detector model don't match. The operands must be used with the matching data types in all other parts of your detector model. @@ -349 +349 @@ An analysis result with information about `referenced‐data`, corresponds to th -You might receive this error message if you use a timer that isn't set. You must set a timer before you use it in an expression. Also, make sure that you enter the correct timer name. +**Solution:** You might receive this error message if you use a timer that isn't set. You must set a timer before you use it in an expression. Also, make sure that you enter the correct timer name. @@ -353 +353 @@ You might receive this error message if you use a timer that isn't set. You must -You might receive this error message if you use a variable that isn't set. You must set a variable before you use it in an expression. Also, make sure that you enter the correct variable name. +**Solution:** You might receive this error message if you use a variable that isn't set. You must set a variable before you use it in an expression. Also, make sure that you enter the correct variable name. @@ -357 +357 @@ You might receive this error message if you use a variable that isn't set. You m -Each variable must be assigned to a value before it can be evaluated in an expression. Set the value of the variable before every use so its value can be retrieved. Also, make sure that you enter the correct variable name. +**Solution:** Each variable must be assigned to a value before it can be evaluated in an expression. Set the value of the variable before every use so its value can be retrieved. Also, make sure that you enter the correct variable name. @@ -368 +368 @@ An analysis result with information about `referenced‐resource`, corresponds t -You might receive this error message if you use expressions to reference an input that doesn't exist. Make sure that your expression references an existing input and enter the correct input name. If you don't have an input, create one first. +**Solution:** You might receive this error message if you use expressions to reference an input that doesn't exist. Make sure that your expression references an existing input and enter the correct input name. If you don't have an input, create one first. @@ -372 +372 @@ You might receive this error message if you use expressions to reference an inpu -You might receive this error message if your detector model contains an invalid input name. Make sure that you enter the correct input name. The input name must have 1-128 characters. Valid characters: a-z, A-Z, 0-9, _ (underscore), and - (hyphen). +**Solution:** You might receive this error message if your detector model contains an invalid input name. Make sure that you enter the correct input name. The input name must have 1-128 characters. Valid characters: a-z, A-Z, 0-9, _ (underscore), and - (hyphen).