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.
Contents
- anchor
-
The HTML anchor link to the location to open. Specify this value for a navigation action.
Type: ComponentProperty object
Required: No
- 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.
Type: String to ComponentProperty object map
Required: No
- global
-
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
Type: ComponentProperty object
Required: No
- id
-
The unique ID of the component that the
ActionParametersapply to.Type: ComponentProperty object
Required: No
- model
-
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
Type: String
Required: No
- state
-
A key-value pair that specifies the state property name and its initial value.
Type: MutationActionSetStateParameter object
Required: No
- target
-
The element within the same component to modify when the action occurs.
Type: ComponentProperty object
Required: No
- type
-
The type of navigation action. Valid values are
urlandanchor. This value is required for a navigation action.Type: ComponentProperty object
Required: No
- url
-
The URL to the location to open. Specify this value for a navigation action.
Type: ComponentProperty object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
