class Aws::AmplifyUIBuilder::Types::ActionParameters
Represents the event action configuration for an element of a ‘Component` or `ComponentChild`. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. `ActionParameters` defines the action that is performed when an event occurs on the component.
@note When making an API call, you may pass ActionParameters
data as a hash: { anchor: { binding_properties: { field: "String", property: "String", # required }, bindings: { "String" => { element: "String", # required property: "String", # required }, }, collection_binding_properties: { field: "String", property: "String", # required }, component_name: "String", concat: [ { # recursive ComponentProperty }, ], condition: { else: { # recursive ComponentProperty }, field: "String", operand: "String", operand_type: "String", operator: "String", property: "String", then: { # recursive ComponentProperty }, }, configured: false, default_value: "String", event: "String", imported_value: "String", model: "String", property: "String", type: "String", user_attribute: "String", value: "String", }, fields: { "String" => { binding_properties: { field: "String", property: "String", # required }, bindings: { "String" => { element: "String", # required property: "String", # required }, }, collection_binding_properties: { field: "String", property: "String", # required }, component_name: "String", concat: [ { # recursive ComponentProperty }, ], condition: { else: { # recursive ComponentProperty }, field: "String", operand: "String", operand_type: "String", operator: "String", property: "String", then: { # recursive ComponentProperty }, }, configured: false, default_value: "String", event: "String", imported_value: "String", model: "String", property: "String", type: "String", user_attribute: "String", value: "String", }, }, global: { binding_properties: { field: "String", property: "String", # required }, bindings: { "String" => { element: "String", # required property: "String", # required }, }, collection_binding_properties: { field: "String", property: "String", # required }, component_name: "String", concat: [ { # recursive ComponentProperty }, ], condition: { else: { # recursive ComponentProperty }, field: "String", operand: "String", operand_type: "String", operator: "String", property: "String", then: { # recursive ComponentProperty }, }, configured: false, default_value: "String", event: "String", imported_value: "String", model: "String", property: "String", type: "String", user_attribute: "String", value: "String", }, id: { binding_properties: { field: "String", property: "String", # required }, bindings: { "String" => { element: "String", # required property: "String", # required }, }, collection_binding_properties: { field: "String", property: "String", # required }, component_name: "String", concat: [ { # recursive ComponentProperty }, ], condition: { else: { # recursive ComponentProperty }, field: "String", operand: "String", operand_type: "String", operator: "String", property: "String", then: { # recursive ComponentProperty }, }, configured: false, default_value: "String", event: "String", imported_value: "String", model: "String", property: "String", type: "String", user_attribute: "String", value: "String", }, model: "String", state: { component_name: "String", # required property: "String", # required set: { # required binding_properties: { field: "String", property: "String", # required }, bindings: { "String" => { element: "String", # required property: "String", # required }, }, collection_binding_properties: { field: "String", property: "String", # required }, component_name: "String", concat: [ { # recursive ComponentProperty }, ], condition: { else: { # recursive ComponentProperty }, field: "String", operand: "String", operand_type: "String", operator: "String", property: "String", then: { # recursive ComponentProperty }, }, configured: false, default_value: "String", event: "String", imported_value: "String", model: "String", property: "String", type: "String", user_attribute: "String", value: "String", }, }, target: { binding_properties: { field: "String", property: "String", # required }, bindings: { "String" => { element: "String", # required property: "String", # required }, }, collection_binding_properties: { field: "String", property: "String", # required }, component_name: "String", concat: [ { # recursive ComponentProperty }, ], condition: { else: { # recursive ComponentProperty }, field: "String", operand: "String", operand_type: "String", operator: "String", property: "String", then: { # recursive ComponentProperty }, }, configured: false, default_value: "String", event: "String", imported_value: "String", model: "String", property: "String", type: "String", user_attribute: "String", value: "String", }, type: { binding_properties: { field: "String", property: "String", # required }, bindings: { "String" => { element: "String", # required property: "String", # required }, }, collection_binding_properties: { field: "String", property: "String", # required }, component_name: "String", concat: [ { # recursive ComponentProperty }, ], condition: { else: { # recursive ComponentProperty }, field: "String", operand: "String", operand_type: "String", operator: "String", property: "String", then: { # recursive ComponentProperty }, }, configured: false, default_value: "String", event: "String", imported_value: "String", model: "String", property: "String", type: "String", user_attribute: "String", value: "String", }, url: { binding_properties: { field: "String", property: "String", # required }, bindings: { "String" => { element: "String", # required property: "String", # required }, }, collection_binding_properties: { field: "String", property: "String", # required }, component_name: "String", concat: [ { # recursive ComponentProperty }, ], condition: { else: { # recursive ComponentProperty }, field: "String", operand: "String", operand_type: "String", operator: "String", property: "String", then: { # recursive ComponentProperty }, }, configured: false, default_value: "String", event: "String", imported_value: "String", model: "String", property: "String", type: "String", user_attribute: "String", value: "String", }, }
@!attribute [rw] anchor
The HTML anchor link to the location to open. Specify this value for a navigation action. @return [Types::ComponentProperty]
@!attribute [rw] fields
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model. @return [Hash<String,Types::ComponentProperty>]
@!attribute [rw] global
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action. @return [Types::ComponentProperty]
@!attribute [rw] id
The unique ID of the component that the `ActionParameters` apply to. @return [Types::ComponentProperty]
@!attribute [rw] model
The name of the data model. Use when the action performs an operation on an Amplify DataStore model. @return [String]
@!attribute [rw] state
A key-value pair that specifies the state property name and its initial value. @return [Types::MutationActionSetStateParameter]
@!attribute [rw] target
The element within the same component to modify when the action occurs. @return [Types::ComponentProperty]
@!attribute [rw] type
The type of navigation action. Valid values are `url` and `anchor`. This value is required for a navigation action. @return [Types::ComponentProperty]
@!attribute [rw] url
The URL to the location to open. Specify this value for a navigation action. @return [Types::ComponentProperty]
@see docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ActionParameters AWS API Documentation
Constants
- SENSITIVE