

# ActionReviewPayloadField
<a name="API_ActionReviewPayloadField"></a>

A user input field in an plugin action review payload.

## Contents
<a name="API_ActionReviewPayloadField_Contents"></a>

 ** allowedFormat **   <a name="qbusiness-Type-ActionReviewPayloadField-allowedFormat"></a>
The expected data format for the action review input field value. For example, in PTO request, `from` and `to` would be of `datetime` allowed format.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** allowedValues **   <a name="qbusiness-Type-ActionReviewPayloadField-allowedValues"></a>
Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.  
Type: Array of [ActionReviewPayloadFieldAllowedValue](API_ActionReviewPayloadFieldAllowedValue.md) objects  
Required: No

 ** arrayItemJsonSchema **   <a name="qbusiness-Type-ActionReviewPayloadField-arrayItemJsonSchema"></a>
Use to create a custom form with array fields (fields with nested objects inside an array).  
Type: JSON value  
Required: No

 ** displayDescription **   <a name="qbusiness-Type-ActionReviewPayloadField-displayDescription"></a>
The field level description of each action review input field. This could be an explanation of the field. In the Amazon Q Business web experience, these descriptions could be used to display as tool tips to help users understand the field.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** displayName **   <a name="qbusiness-Type-ActionReviewPayloadField-displayName"></a>
 The name of the field.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** displayOrder **   <a name="qbusiness-Type-ActionReviewPayloadField-displayOrder"></a>
The display order of fields in a payload.  
Type: Integer  
Required: No

 ** required **   <a name="qbusiness-Type-ActionReviewPayloadField-required"></a>
Information about whether the field is required.  
Type: Boolean  
Required: No

 ** type **   <a name="qbusiness-Type-ActionReviewPayloadField-type"></a>
The type of field.   
Type: String  
Valid Values: `STRING | NUMBER | ARRAY | BOOLEAN`   
Required: No

 ** value **   <a name="qbusiness-Type-ActionReviewPayloadField-value"></a>
The field value.  
Type: JSON value  
Required: No

## See Also
<a name="API_ActionReviewPayloadField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qbusiness-2023-11-27/ActionReviewPayloadField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qbusiness-2023-11-27/ActionReviewPayloadField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qbusiness-2023-11-27/ActionReviewPayloadField) 