Class: Aws::AmplifyUIBuilder::Types::ActionParameters

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb

Overview

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",
  },
}

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#anchor ⇒ Types::ComponentProperty

The HTML anchor link to the location to open. Specify this value for a navigation action.

Returns:



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 431

class ActionParameters < Struct.new(
  :anchor,
  :fields,
  :global,
  :id,
  :model,
  :state,
  :target,
  :type,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#fields ⇒ Hash<String,Types::ComponentProperty>

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.

Returns:



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 431

class ActionParameters < Struct.new(
  :anchor,
  :fields,
  :global,
  :id,
  :model,
  :state,
  :target,
  :type,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#global ⇒ Types::ComponentProperty

Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

Returns:



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 431

class ActionParameters < Struct.new(
  :anchor,
  :fields,
  :global,
  :id,
  :model,
  :state,
  :target,
  :type,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ Types::ComponentProperty

The unique ID of the component that the ActionParameters apply to.

Returns:



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 431

class ActionParameters < Struct.new(
  :anchor,
  :fields,
  :global,
  :id,
  :model,
  :state,
  :target,
  :type,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#model ⇒ String

The name of the data model. Use when the action performs an operation on an Amplify DataStore model.

Returns:

  • (String) 


431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 431

class ActionParameters < Struct.new(
  :anchor,
  :fields,
  :global,
  :id,
  :model,
  :state,
  :target,
  :type,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ Types::MutationActionSetStateParameter

A key-value pair that specifies the state property name and its initial value.

Returns:



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 431

class ActionParameters < Struct.new(
  :anchor,
  :fields,
  :global,
  :id,
  :model,
  :state,
  :target,
  :type,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#target ⇒ Types::ComponentProperty

The element within the same component to modify when the action occurs.

Returns:



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 431

class ActionParameters < Struct.new(
  :anchor,
  :fields,
  :global,
  :id,
  :model,
  :state,
  :target,
  :type,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ Types::ComponentProperty

The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

Returns:



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 431

class ActionParameters < Struct.new(
  :anchor,
  :fields,
  :global,
  :id,
  :model,
  :state,
  :target,
  :type,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#url ⇒ Types::ComponentProperty

The URL to the location to open. Specify this value for a navigation action.

Returns:



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 431

class ActionParameters < Struct.new(
  :anchor,
  :fields,
  :global,
  :id,
  :model,
  :state,
  :target,
  :type,
  :url)
  SENSITIVE = []
  include Aws::Structure
end