ActionReviewPayloadField ¶

class ActionReviewPayloadField(TypedDict, closed=True):
    display_name: NotRequired["capo_qbusiness.types.string.String"]
    """<p> The name of the field. </p>"""
    display_order: NotRequired["capo_qbusiness.types.integer.Integer"]
    """<p>The display order of fields in a payload.</p>"""
    display_description: NotRequired["capo_qbusiness.types.string.String"]
    """<p>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. </p>"""
    type: NotRequired[
        "capo_qbusiness.types.action_payload_field_type.ActionPayloadFieldType"
    ]
    """<p>The type of field. </p>"""
    value: NotRequired[
        "capo_qbusiness.types.action_payload_field_value.ActionPayloadFieldValue"
    ]
    """<p>The field value.</p>"""
    allowed_values: NotRequired[
        "capo_qbusiness.types.action_review_payload_field_allowed_values.ActionReviewPayloadFieldAllowedValues"
    ]
    """<p>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.</p>"""
    allowed_format: NotRequired["capo_qbusiness.types.string.String"]
    """<p>The expected data format for the action review input field value. For example, in PTO request, <code>from</code> and <code>to</code> would be of <code>datetime</code> allowed format. </p>"""
    array_item_json_schema: NotRequired[
        "capo_qbusiness.types.action_review_payload_field_array_item_json_schema.ActionReviewPayloadFieldArrayItemJsonSchema"
    ]
    """<p>Use to create a custom form with array fields (fields with nested objects inside an array).</p>"""
    required: NotRequired["bool"]
    """<p>Information about whether the field is required.</p>"""