Class: Aws::QBusiness::Types::ActionReviewPayloadField

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-qbusiness/types.rb

Overview

A user input field in an plugin action review payload.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_format ⇒ String

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.

Returns:

  • (String) 


352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 352

class ActionReviewPayloadField < Struct.new(
  :display_name,
  :display_order,
  :display_description,
  :type,
  :value,
  :allowed_values,
  :allowed_format,
  :array_item_json_schema,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#allowed_values ⇒ Array<Types::ActionReviewPayloadFieldAllowedValue>

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.

Returns:



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 352

class ActionReviewPayloadField < Struct.new(
  :display_name,
  :display_order,
  :display_description,
  :type,
  :value,
  :allowed_values,
  :allowed_format,
  :array_item_json_schema,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#array_item_json_schema ⇒ Hash, ...

Use to create a custom form with array fields (fields with nested objects inside an array).

Returns:

  • (Hash, Array, String, Numeric, Boolean) 


352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 352

class ActionReviewPayloadField < Struct.new(
  :display_name,
  :display_order,
  :display_description,
  :type,
  :value,
  :allowed_values,
  :allowed_format,
  :array_item_json_schema,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#display_description ⇒ String

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.

Returns:

  • (String) 


352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 352

class ActionReviewPayloadField < Struct.new(
  :display_name,
  :display_order,
  :display_description,
  :type,
  :value,
  :allowed_values,
  :allowed_format,
  :array_item_json_schema,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The name of the field.

Returns:

  • (String) 


352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 352

class ActionReviewPayloadField < Struct.new(
  :display_name,
  :display_order,
  :display_description,
  :type,
  :value,
  :allowed_values,
  :allowed_format,
  :array_item_json_schema,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#display_order ⇒ Integer

The display order of fields in a payload.

Returns:

  • (Integer) 


352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 352

class ActionReviewPayloadField < Struct.new(
  :display_name,
  :display_order,
  :display_description,
  :type,
  :value,
  :allowed_values,
  :allowed_format,
  :array_item_json_schema,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#required ⇒ Boolean

Information about whether the field is required.

Returns:

  • (Boolean) 


352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 352

class ActionReviewPayloadField < Struct.new(
  :display_name,
  :display_order,
  :display_description,
  :type,
  :value,
  :allowed_values,
  :allowed_format,
  :array_item_json_schema,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of field.

Returns:

  • (String) 


352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 352

class ActionReviewPayloadField < Struct.new(
  :display_name,
  :display_order,
  :display_description,
  :type,
  :value,
  :allowed_values,
  :allowed_format,
  :array_item_json_schema,
  :required)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ Hash, ...

The field value.

Returns:

  • (Hash, Array, String, Numeric, Boolean) 


352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 352

class ActionReviewPayloadField < Struct.new(
  :display_name,
  :display_order,
  :display_description,
  :type,
  :value,
  :allowed_values,
  :allowed_format,
  :array_item_json_schema,
  :required)
  SENSITIVE = []
  include Aws::Structure
end