Class: Aws::AmplifyUIBuilder::Types::UpdateFormData

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 UpdateFormData data as a hash:

{
  cta: {
    cancel: {
      children: "String",
      excluded: false,
      position: {
        below: "String",
        fixed: "first", # accepts first
        right_of: "String",
      },
    },
    clear: {
      children: "String",
      excluded: false,
      position: {
        below: "String",
        fixed: "first", # accepts first
        right_of: "String",
      },
    },
    position: "top", # accepts top, bottom, top_and_bottom
    submit: {
      children: "String",
      excluded: false,
      position: {
        below: "String",
        fixed: "first", # accepts first
        right_of: "String",
      },
    },
  },
  data_type: {
    data_source_type: "DataStore", # required, accepts DataStore, Custom
    data_type_name: "String", # required
  },
  fields: {
    "String" => {
      excluded: false,
      input_type: {
        default_checked: false,
        default_country_code: "String",
        default_value: "String",
        descriptive_text: "String",
        is_array: false,
        max_value: 1.0,
        min_value: 1.0,
        name: "String",
        placeholder: "String",
        read_only: false,
        required: false,
        step: 1.0,
        type: "String", # required
        value: "String",
        value_mappings: {
          values: [ # required
            {
              display_value: {
                value: "String",
              },
              value: { # required
                value: "String",
              },
            },
          ],
        },
      },
      label: "String",
      position: {
        below: "String",
        fixed: "first", # accepts first
        right_of: "String",
      },
      validations: [
        {
          num_values: [1],
          str_values: ["String"],
          type: "String", # required
          validation_message: "String",
        },
      ],
    },
  },
  form_action_type: "create", # accepts create, update
  name: "FormName",
  schema_version: "String",
  sectional_elements: {
    "String" => {
      level: 1,
      orientation: "String",
      position: {
        below: "String",
        fixed: "first", # accepts first
        right_of: "String",
      },
      text: "String",
      type: "String", # required
    },
  },
  style: {
    horizontal_gap: {
      token_reference: "String",
      value: "String",
    },
    outer_padding: {
      token_reference: "String",
      value: "String",
    },
    vertical_gap: {
      token_reference: "String",
      value: "String",
    },
  },
}

Updates and saves all of the information about a form, based on form ID.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ctaTypes::FormCTA

The FormCTA object that stores the call to action configuration for the form.

Returns:



9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 9001

class UpdateFormData < Struct.new(
  :cta,
  :data_type,
  :fields,
  :form_action_type,
  :name,
  :schema_version,
  :sectional_elements,
  :style)
  SENSITIVE = []
  include Aws::Structure
end

#data_typeTypes::FormDataTypeConfig

The type of data source to use to create the form.



9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 9001

class UpdateFormData < Struct.new(
  :cta,
  :data_type,
  :fields,
  :form_action_type,
  :name,
  :schema_version,
  :sectional_elements,
  :style)
  SENSITIVE = []
  include Aws::Structure
end

#fieldsHash<String,Types::FieldConfig>

The configuration information for the form's fields.

Returns:



9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 9001

class UpdateFormData < Struct.new(
  :cta,
  :data_type,
  :fields,
  :form_action_type,
  :name,
  :schema_version,
  :sectional_elements,
  :style)
  SENSITIVE = []
  include Aws::Structure
end

#form_action_typeString

Specifies whether to perform a create or update action on the form.

Returns:

  • (String)


9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 9001

class UpdateFormData < Struct.new(
  :cta,
  :data_type,
  :fields,
  :form_action_type,
  :name,
  :schema_version,
  :sectional_elements,
  :style)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the form.

Returns:

  • (String)


9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 9001

class UpdateFormData < Struct.new(
  :cta,
  :data_type,
  :fields,
  :form_action_type,
  :name,
  :schema_version,
  :sectional_elements,
  :style)
  SENSITIVE = []
  include Aws::Structure
end

#schema_versionString

The schema version of the form.

Returns:

  • (String)


9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 9001

class UpdateFormData < Struct.new(
  :cta,
  :data_type,
  :fields,
  :form_action_type,
  :name,
  :schema_version,
  :sectional_elements,
  :style)
  SENSITIVE = []
  include Aws::Structure
end

#sectional_elementsHash<String,Types::SectionalElement>

The configuration information for the visual helper elements for the form. These elements are not associated with any data.

Returns:



9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 9001

class UpdateFormData < Struct.new(
  :cta,
  :data_type,
  :fields,
  :form_action_type,
  :name,
  :schema_version,
  :sectional_elements,
  :style)
  SENSITIVE = []
  include Aws::Structure
end

#styleTypes::FormStyle

The configuration for the form's style.

Returns:



9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
# File 'gems/aws-sdk-amplifyuibuilder/lib/aws-sdk-amplifyuibuilder/types.rb', line 9001

class UpdateFormData < Struct.new(
  :cta,
  :data_type,
  :fields,
  :form_action_type,
  :name,
  :schema_version,
  :sectional_elements,
  :style)
  SENSITIVE = []
  include Aws::Structure
end