View a markdown version of this page

UpdateFlowAttributes - Amazon Connect
Parameter objectResults and conditionsErrorsRestrictionsCorresponding block in the UI

UpdateFlowAttributes

Sets a collection of attributes on the current flow. These attributes are not carried over to the subsequent flows. With this type of operation, either all attributes are set or none are set.

To set attributes that are available to every flow that runs on the current contact, use PersistedFlowAttributes instead of FlowAttributes. Persisted flow attributes are only available in Amazon Connect Customer instances.

Parameter object

{
    "FlowAttributes": { An Object that holds the attributes to be set. Keys are of type String, Values are of type FlowAttribute.
        "attribute-name": {
            "Value": "String"
        }
    },
    "PersistedFlowAttributes": { An Object that holds the attributes to be set on the current contact, instead of FlowAttributes. Keys are of type String, Values are of type FlowAttribute.
        "attribute-name": {
            "Value": "String"
        }
    }
}

Example that sets a flow attribute:

{
  "FlowAttributes": {
    "CardLastFour": { "Value": "$.External.lastFour" }
  }
}

Example that sets a persisted flow attribute:

{
  "PersistedFlowAttributes": {
    "VerificationResult": { "Value": "$.External.verified" }
  }
}

Results and conditions

None. No conditions are supported.

Errors

  • NoMatchingError - if the attributes couldn't be set. For example, the attributes would exceed the size limit (64 KB for flow attributes, 128 KB per contact for persisted flow attributes), or persisted flow attributes couldn't be saved. When this error occurs, no attributes are set and existing persisted flow attributes are left unchanged. To resolve it, reduce the number or size of the attributes.

Restrictions

This action is supported on all channels and in all flow types. PersistedFlowAttributes is only available in Amazon Connect Customer instances.

Corresponding block in the UI

Set contact attributes