ActionReviewPayloadField¶
Structure Class¶
dataclass
¶
A user input field in an plugin action review payload.
Attributes¶
class-attribute
instance-attribute
¶
allowed_format: str | None = None
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.
class-attribute
instance-attribute
¶
allowed_values: list[ActionReviewPayloadFieldAllowedValue] | None = None
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.
class-attribute
instance-attribute
¶
array_item_json_schema: Document | None = None
Use to create a custom form with array fields (fields with nested objects inside an array).
class-attribute
instance-attribute
¶
display_description: str | None = None
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.
class-attribute
instance-attribute
¶
display_name: str | None = None
The name of the field.
class-attribute
instance-attribute
¶
display_order: int | None = None
The display order of fields in a payload.
class-attribute
instance-attribute
¶
required: bool | None = None
Information about whether the field is required.
class-attribute
instance-attribute
¶
type: ActionPayloadFieldType | None = None
The type of field.