# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.AmplifyUIBuilder do
@moduledoc """
The Amplify UI Builder API provides a programmatic interface for creating
and configuring user interface (UI) component libraries and themes for use in
your Amplify applications.
You can then connect these UI components to an application's
backend Amazon Web Services resources.
You can also use the Amplify Studio visual designer to create UI components
and model data for an app. For more information, see
[Introduction](https://docs.amplify.aws/console/adminui/intro) in the *Amplify Docs*.
The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and
documentation for client app development. For more information, see the [Amplify
Framework](https://docs.amplify.aws/). For more information about
deploying an Amplify application to Amazon Web Services, see the [Amplify User Guide](https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html).
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
no_api_render_config() :: %{}
"""
@type no_api_render_config() :: %{}
@typedoc """
## Example:
theme() :: %{
"appId" => [String.t() | atom()],
"createdAt" => [non_neg_integer()],
"environmentName" => [String.t() | atom()],
"id" => String.t() | atom(),
"modifiedAt" => [non_neg_integer()],
"name" => String.t() | atom(),
"overrides" => list(theme_values()),
"tags" => map(),
"values" => list(theme_values())
}
"""
@type theme() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_request() :: %{
required("tags") => map()
}
"""
@type tag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
codegen_generic_data_non_model() :: %{
"fields" => map()
}
"""
@type codegen_generic_data_non_model() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
codegen_generic_data_field() :: %{
"dataType" => list(any()),
"dataTypeValue" => [String.t() | atom()],
"isArray" => [boolean()],
"readOnly" => [boolean()],
"relationship" => codegen_generic_data_relationship_type(),
"required" => [boolean()]
}
"""
@type codegen_generic_data_field() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
exchange_code_for_token_response() :: %{
required("accessToken") => String.t() | atom(),
required("expiresIn") => [integer()],
required("refreshToken") => String.t() | atom()
}
"""
@type exchange_code_for_token_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_theme_request() :: %{}
"""
@type get_theme_request() :: %{}
@typedoc """
## Example:
form() :: %{
"appId" => [String.t() | atom()],
"cta" => form_c_t_a(),
"dataType" => form_data_type_config(),
"environmentName" => [String.t() | atom()],
"fields" => map(),
"formActionType" => list(any()),
"id" => String.t() | atom(),
"labelDecorator" => String.t() | atom(),
"name" => String.t() | atom(),
"schemaVersion" => [String.t() | atom()],
"sectionalElements" => map(),
"style" => form_style(),
"tags" => map()
}
"""
@type form() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
data_store_render_config() :: %{}
"""
@type data_store_render_config() :: %{}
@typedoc """
## Example:
unauthorized_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type unauthorized_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
form_data_type_config() :: %{
"dataSourceType" => String.t() | atom(),
"dataTypeName" => [String.t() | atom()]
}
"""
@type form_data_type_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
codegen_job() :: %{
"appId" => String.t() | atom(),
"asset" => codegen_job_asset(),
"autoGenerateForms" => [boolean()],
"createdAt" => [non_neg_integer()],
"dependencies" => list(codegen_dependency()),
"environmentName" => [String.t() | atom()],
"features" => codegen_feature_flags(),
"genericDataSchema" => codegen_job_generic_data_schema(),
"id" => String.t() | atom(),
"modifiedAt" => [non_neg_integer()],
"renderConfig" => list(),
"status" => list(any()),
"statusMessage" => [String.t() | atom()],
"tags" => map()
}
"""
@type codegen_job() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_response() :: %{}
"""
@type untag_resource_response() :: %{}
@typedoc """
## Example:
form_c_t_a() :: %{
"cancel" => form_button(),
"clear" => form_button(),
"position" => list(any()),
"submit" => form_button()
}
"""
@type form_c_t_a() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
file_uploader_field_config() :: %{
"acceptedFileTypes" => list([String.t() | atom()]()),
"accessLevel" => list(any()),
"isResumable" => [boolean()],
"maxFileCount" => [integer()],
"maxSize" => [integer()],
"showThumbnails" => [boolean()]
}
"""
@type file_uploader_field_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
codegen_job_summary() :: %{
"appId" => String.t() | atom(),
"createdAt" => [non_neg_integer()],
"environmentName" => [String.t() | atom()],
"id" => String.t() | atom(),
"modifiedAt" => [non_neg_integer()]
}
"""
@type codegen_job_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_form_data() :: %{
"cta" => form_c_t_a(),
"dataType" => form_data_type_config(),
"fields" => map(),
"formActionType" => list(any()),
"labelDecorator" => String.t() | atom(),
"name" => String.t() | atom(),
"schemaVersion" => [String.t() | atom()],
"sectionalElements" => map(),
"style" => form_style()
}
"""
@type update_form_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
component_binding_properties_value_properties() :: %{
"bucket" => [String.t() | atom()],
"defaultValue" => [String.t() | atom()],
"field" => [String.t() | atom()],
"key" => [String.t() | atom()],
"model" => [String.t() | atom()],
"predicates" => list(predicate()),
"slotName" => [String.t() | atom()],
"userAttribute" => [String.t() | atom()]
}
"""
@type component_binding_properties_value_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
component_variant() :: %{
"overrides" => map(),
"variantValues" => map()
}
"""
@type component_variant() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_form_response() :: %{
optional("entity") => form()
}
"""
@type update_form_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_theme_data() :: %{
"name" => String.t() | atom(),
"overrides" => list(theme_values()),
"tags" => map(),
"values" => list(theme_values())
}
"""
@type create_theme_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sort_property() :: %{
"direction" => list(any()),
"field" => [String.t() | atom()]
}
"""
@type sort_property() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_component_request() :: %{}
"""
@type delete_component_request() :: %{}
@typedoc """
## Example:
delete_form_request() :: %{}
"""
@type delete_form_request() :: %{}
@typedoc """
## Example:
start_codegen_job_data() :: %{
"autoGenerateForms" => [boolean()],
"features" => codegen_feature_flags(),
"genericDataSchema" => codegen_job_generic_data_schema(),
"renderConfig" => list(),
"tags" => map()
}
"""
@type start_codegen_job_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_component_response() :: %{
optional("component") => component()
}
"""
@type get_component_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_metadata_flag_body() :: %{
"newValue" => [String.t() | atom()]
}
"""
@type put_metadata_flag_body() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
codegen_generic_data_enum() :: %{
"values" => list([String.t() | atom()]())
}
"""
@type codegen_generic_data_enum() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_request() :: %{
required("tagKeys") => list(String.t() | atom())
}
"""
@type untag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
form_binding_element() :: %{
"element" => [String.t() | atom()],
"property" => [String.t() | atom()]
}
"""
@type form_binding_element() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
refresh_token_response() :: %{
required("accessToken") => String.t() | atom(),
required("expiresIn") => [integer()]
}
"""
@type refresh_token_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_theme_response() :: %{
optional("theme") => theme()
}
"""
@type get_theme_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_codegen_job_response() :: %{
"entity" => codegen_job()
}
"""
@type start_codegen_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_theme_request() :: %{}
"""
@type delete_theme_request() :: %{}
@typedoc """
## Example:
update_component_response() :: %{
optional("entity") => component()
}
"""
@type update_component_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
component_summary() :: %{
"appId" => [String.t() | atom()],
"componentType" => String.t() | atom(),
"environmentName" => [String.t() | atom()],
"id" => String.t() | atom(),
"name" => String.t() | atom()
}
"""
@type component_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
form_input_binding_properties_value_properties() :: %{
"model" => [String.t() | atom()]
}
"""
@type form_input_binding_properties_value_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
component_property_binding_properties() :: %{
"field" => [String.t() | atom()],
"property" => [String.t() | atom()]
}
"""
@type component_property_binding_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_metadata_flag_request() :: %{
required("body") => put_metadata_flag_body()
}
"""
@type put_metadata_flag_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
refresh_token_request_body() :: %{
"clientId" => String.t() | atom(),
"token" => String.t() | atom()
}
"""
@type refresh_token_request_body() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_metadata_response() :: %{
required("features") => map()
}
"""
@type get_metadata_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_codegen_jobs_response() :: %{
"entities" => list(codegen_job_summary()),
"nextToken" => [String.t() | atom()]
}
"""
@type list_codegen_jobs_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_theme_response() :: %{
optional("entity") => theme()
}
"""
@type create_theme_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_form_request() :: %{}
"""
@type get_form_request() :: %{}
@typedoc """
## Example:
codegen_feature_flags() :: %{
"isNonModelSupported" => [boolean()],
"isRelationshipSupported" => [boolean()]
}
"""
@type codegen_feature_flags() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_component_response() :: %{
optional("entity") => component()
}
"""
@type create_component_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_component_data() :: %{
"bindingProperties" => map(),
"children" => list(component_child()),
"collectionProperties" => map(),
"componentType" => String.t() | atom(),
"events" => map(),
"name" => String.t() | atom(),
"overrides" => map(),
"properties" => map(),
"schemaVersion" => [String.t() | atom()],
"sourceId" => [String.t() | atom()],
"tags" => map(),
"variants" => list(component_variant())
}
"""
@type create_component_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_codegen_jobs_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => [String.t() | atom()]
}
"""
@type list_codegen_jobs_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_component_request() :: %{
optional("clientToken") => [String.t() | atom()],
required("updatedComponent") => update_component_data()
}
"""
@type update_component_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
export_forms_response() :: %{
optional("nextToken") => [String.t() | atom()],
required("entities") => list(form())
}
"""
@type export_forms_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_themes_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => [String.t() | atom()]
}
"""
@type list_themes_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_not_found_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type resource_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_components_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => [String.t() | atom()]
}
"""
@type list_components_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_metadata_request() :: %{}
"""
@type get_metadata_request() :: %{}
@typedoc """
## Example:
field_config() :: %{
"excluded" => [boolean()],
"inputType" => field_input_config(),
"label" => [String.t() | atom()],
"position" => list(),
"validations" => list(field_validation_configuration())
}
"""
@type field_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_form_response() :: %{
optional("form") => form()
}
"""
@type get_form_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_quota_exceeded_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type service_quota_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
component_child() :: %{
"children" => list(component_child()),
"componentType" => [String.t() | atom()],
"events" => map(),
"name" => [String.t() | atom()],
"properties" => map(),
"sourceId" => [String.t() | atom()]
}
"""
@type component_child() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
component() :: %{
"appId" => [String.t() | atom()],
"bindingProperties" => map(),
"children" => list(component_child()),
"collectionProperties" => map(),
"componentType" => String.t() | atom(),
"createdAt" => [non_neg_integer()],
"environmentName" => [String.t() | atom()],
"events" => map(),
"id" => String.t() | atom(),
"modifiedAt" => [non_neg_integer()],
"name" => String.t() | atom(),
"overrides" => map(),
"properties" => map(),
"schemaVersion" => [String.t() | atom()],
"sourceId" => [String.t() | atom()],
"tags" => map(),
"variants" => list(component_variant())
}
"""
@type component() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
refresh_token_request() :: %{
required("refreshTokenBody") => refresh_token_request_body()
}
"""
@type refresh_token_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_forms_response() :: %{
optional("nextToken") => [String.t() | atom()],
required("entities") => list(form_summary())
}
"""
@type list_forms_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
value_mapping() :: %{
"displayValue" => form_input_value_property(),
"value" => form_input_value_property()
}
"""
@type value_mapping() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
react_start_codegen_job_data() :: %{
"apiConfiguration" => list(),
"dependencies" => map(),
"inlineSourceMap" => [boolean()],
"module" => list(any()),
"renderTypeDeclarations" => [boolean()],
"script" => list(any()),
"target" => list(any())
}
"""
@type react_start_codegen_job_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
export_components_response() :: %{
optional("nextToken") => [String.t() | atom()],
required("entities") => list(component())
}
"""
@type export_components_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_theme_request() :: %{
optional("clientToken") => [String.t() | atom()],
required("updatedTheme") => update_theme_data()
}
"""
@type update_theme_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_theme_request() :: %{
optional("clientToken") => [String.t() | atom()],
required("themeToCreate") => create_theme_data()
}
"""
@type create_theme_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
export_themes_request() :: %{
optional("nextToken") => [String.t() | atom()]
}
"""
@type export_themes_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
exchange_code_for_token_request() :: %{
required("request") => exchange_code_for_token_request_body()
}
"""
@type exchange_code_for_token_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_codegen_job_request() :: %{
optional("clientToken") => [String.t() | atom()],
required("codegenJobToCreate") => start_codegen_job_data()
}
"""
@type start_codegen_job_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_form_request() :: %{
optional("clientToken") => [String.t() | atom()],
required("formToCreate") => create_form_data()
}
"""
@type create_form_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_codegen_job_response() :: %{
"job" => codegen_job()
}
"""
@type get_codegen_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_component_request() :: %{
optional("clientToken") => [String.t() | atom()],
required("componentToCreate") => create_component_data()
}
"""
@type create_component_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sectional_element() :: %{
"excluded" => [boolean()],
"level" => [integer()],
"orientation" => [String.t() | atom()],
"position" => list(),
"text" => [String.t() | atom()],
"type" => [String.t() | atom()]
}
"""
@type sectional_element() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
exchange_code_for_token_request_body() :: %{
"clientId" => String.t() | atom(),
"code" => String.t() | atom(),
"redirectUri" => [String.t() | atom()]
}
"""
@type exchange_code_for_token_request_body() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
mutation_action_set_state_parameter() :: %{
"componentName" => [String.t() | atom()],
"property" => [String.t() | atom()],
"set" => component_property()
}
"""
@type mutation_action_set_state_parameter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_response() :: %{
"tags" => map()
}
"""
@type list_tags_for_resource_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
codegen_job_asset() :: %{
"downloadUrl" => [String.t() | atom()]
}
"""
@type codegen_job_asset() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
field_input_config() :: %{
"defaultChecked" => [boolean()],
"defaultCountryCode" => [String.t() | atom()],
"defaultValue" => [String.t() | atom()],
"descriptiveText" => [String.t() | atom()],
"fileUploaderConfig" => file_uploader_field_config(),
"isArray" => [boolean()],
"maxValue" => [float()],
"minValue" => [float()],
"name" => [String.t() | atom()],
"placeholder" => [String.t() | atom()],
"readOnly" => [boolean()],
"required" => [boolean()],
"step" => [float()],
"type" => [String.t() | atom()],
"value" => [String.t() | atom()],
"valueMappings" => value_mappings()
}
"""
@type field_input_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_codegen_job_request() :: %{}
"""
@type get_codegen_job_request() :: %{}
@typedoc """
## Example:
create_form_data() :: %{
"cta" => form_c_t_a(),
"dataType" => form_data_type_config(),
"fields" => map(),
"formActionType" => list(any()),
"labelDecorator" => String.t() | atom(),
"name" => String.t() | atom(),
"schemaVersion" => [String.t() | atom()],
"sectionalElements" => map(),
"style" => form_style(),
"tags" => map()
}
"""
@type create_form_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
theme_value() :: %{
"children" => list(theme_values()),
"value" => [String.t() | atom()]
}
"""
@type theme_value() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
form_style() :: %{
"horizontalGap" => list(),
"outerPadding" => list(),
"verticalGap" => list()
}
"""
@type form_style() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_form_response() :: %{
optional("entity") => form()
}
"""
@type create_form_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
form_input_value_property() :: %{
"bindingProperties" => form_input_value_property_binding_properties(),
"concat" => list(form_input_value_property()),
"value" => [String.t() | atom()]
}
"""
@type form_input_value_property() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
component_event() :: %{
"action" => [String.t() | atom()],
"bindingEvent" => [String.t() | atom()],
"parameters" => action_parameters()
}
"""
@type component_event() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
form_input_value_property_binding_properties() :: %{
"field" => [String.t() | atom()],
"property" => [String.t() | atom()]
}
"""
@type form_input_value_property_binding_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
form_button() :: %{
"children" => [String.t() | atom()],
"excluded" => [boolean()],
"position" => list()
}
"""
@type form_button() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
internal_server_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type internal_server_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
graph_q_l_render_config() :: %{
"fragmentsFilePath" => [String.t() | atom()],
"mutationsFilePath" => [String.t() | atom()],
"queriesFilePath" => [String.t() | atom()],
"subscriptionsFilePath" => [String.t() | atom()],
"typesFilePath" => [String.t() | atom()]
}
"""
@type graph_q_l_render_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_forms_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => [String.t() | atom()]
}
"""
@type list_forms_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_theme_response() :: %{
optional("entity") => theme()
}
"""
@type update_theme_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
theme_values() :: %{
"key" => [String.t() | atom()],
"value" => theme_value()
}
"""
@type theme_values() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
component_property() :: %{
"bindingProperties" => component_property_binding_properties(),
"bindings" => map(),
"collectionBindingProperties" => component_property_binding_properties(),
"componentName" => [String.t() | atom()],
"concat" => list(component_property()),
"condition" => component_condition_property(),
"configured" => [boolean()],
"defaultValue" => [String.t() | atom()],
"event" => [String.t() | atom()],
"importedValue" => [String.t() | atom()],
"model" => [String.t() | atom()],
"property" => [String.t() | atom()],
"type" => [String.t() | atom()],
"userAttribute" => [String.t() | atom()],
"value" => [String.t() | atom()]
}
"""
@type component_property() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
invalid_parameter_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type invalid_parameter_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
codegen_job_generic_data_schema() :: %{
"dataSourceType" => list(any()),
"enums" => map(),
"models" => map(),
"nonModels" => map()
}
"""
@type codegen_job_generic_data_schema() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
action_parameters() :: %{
"anchor" => component_property(),
"fields" => map(),
"global" => component_property(),
"id" => component_property(),
"model" => [String.t() | atom()],
"state" => mutation_action_set_state_parameter(),
"target" => component_property(),
"type" => component_property(),
"url" => component_property()
}
"""
@type action_parameters() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_response() :: %{}
"""
@type tag_resource_response() :: %{}
@typedoc """
## Example:
form_summary() :: %{
"appId" => [String.t() | atom()],
"dataType" => form_data_type_config(),
"environmentName" => [String.t() | atom()],
"formActionType" => list(any()),
"id" => String.t() | atom(),
"name" => String.t() | atom()
}
"""
@type form_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
theme_summary() :: %{
"appId" => [String.t() | atom()],
"environmentName" => [String.t() | atom()],
"id" => String.t() | atom(),
"name" => String.t() | atom()
}
"""
@type theme_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_theme_data() :: %{
"id" => String.t() | atom(),
"name" => String.t() | atom(),
"overrides" => list(theme_values()),
"values" => list(theme_values())
}
"""
@type update_theme_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_form_request() :: %{
optional("clientToken") => [String.t() | atom()],
required("updatedForm") => update_form_data()
}
"""
@type update_form_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
export_components_request() :: %{
optional("nextToken") => [String.t() | atom()]
}
"""
@type export_components_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_request() :: %{}
"""
@type list_tags_for_resource_request() :: %{}
@typedoc """
## Example:
component_data_configuration() :: %{
"identifiers" => list([String.t() | atom()]()),
"model" => [String.t() | atom()],
"predicate" => predicate(),
"sort" => list(sort_property())
}
"""
@type component_data_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
throttling_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type throttling_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
predicate() :: %{
"and" => list(predicate()),
"field" => [String.t() | atom()],
"operand" => [String.t() | atom()],
"operandType" => String.t() | atom(),
"operator" => [String.t() | atom()],
"or" => list(predicate())
}
"""
@type predicate() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
export_forms_request() :: %{
optional("nextToken") => [String.t() | atom()]
}
"""
@type export_forms_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
codegen_dependency() :: %{
"isSemVer" => [boolean()],
"name" => [String.t() | atom()],
"reason" => [String.t() | atom()],
"supportedVersion" => [String.t() | atom()]
}
"""
@type codegen_dependency() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_components_response() :: %{
optional("nextToken") => [String.t() | atom()],
required("entities") => list(component_summary())
}
"""
@type list_components_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
codegen_generic_data_relationship_type() :: %{
"associatedFields" => list([String.t() | atom()]()),
"belongsToFieldOnRelatedModel" => [String.t() | atom()],
"canUnlinkAssociatedModel" => [boolean()],
"isHasManyIndex" => [boolean()],
"relatedJoinFieldName" => [String.t() | atom()],
"relatedJoinTableName" => [String.t() | atom()],
"relatedModelFields" => list([String.t() | atom()]()),
"relatedModelName" => [String.t() | atom()],
"type" => list(any())
}
"""
@type codegen_generic_data_relationship_type() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
codegen_generic_data_model() :: %{
"fields" => map(),
"isJoinTable" => [boolean()],
"primaryKeys" => list([String.t() | atom()]())
}
"""
@type codegen_generic_data_model() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
field_validation_configuration() :: %{
"numValues" => list([integer()]()),
"strValues" => list([String.t() | atom()]()),
"type" => [String.t() | atom()],
"validationMessage" => [String.t() | atom()]
}
"""
@type field_validation_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
value_mappings() :: %{
"bindingProperties" => map(),
"values" => list(value_mapping())
}
"""
@type value_mappings() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_themes_response() :: %{
optional("nextToken") => [String.t() | atom()],
required("entities") => list(theme_summary())
}
"""
@type list_themes_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
form_input_binding_properties_value() :: %{
"bindingProperties" => form_input_binding_properties_value_properties(),
"type" => [String.t() | atom()]
}
"""
@type form_input_binding_properties_value() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
export_themes_response() :: %{
optional("nextToken") => [String.t() | atom()],
required("entities") => list(theme())
}
"""
@type export_themes_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
component_binding_properties_value() :: %{
"bindingProperties" => component_binding_properties_value_properties(),
"defaultValue" => [String.t() | atom()],
"type" => [String.t() | atom()]
}
"""
@type component_binding_properties_value() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_conflict_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type resource_conflict_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_component_request() :: %{}
"""
@type get_component_request() :: %{}
@typedoc """
## Example:
update_component_data() :: %{
"bindingProperties" => map(),
"children" => list(component_child()),
"collectionProperties" => map(),
"componentType" => String.t() | atom(),
"events" => map(),
"id" => String.t() | atom(),
"name" => String.t() | atom(),
"overrides" => map(),
"properties" => map(),
"schemaVersion" => [String.t() | atom()],
"sourceId" => [String.t() | atom()],
"variants" => list(component_variant())
}
"""
@type update_component_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
component_condition_property() :: %{
"else" => component_property(),
"field" => [String.t() | atom()],
"operand" => [String.t() | atom()],
"operandType" => [String.t() | atom()],
"operator" => [String.t() | atom()],
"property" => [String.t() | atom()],
"then" => component_property()
}
"""
@type component_condition_property() :: %{(String.t() | atom()) => any()}
@type create_component_errors() ::
resource_conflict_exception()
| invalid_parameter_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
@type create_form_errors() ::
resource_conflict_exception()
| invalid_parameter_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
@type create_theme_errors() ::
resource_conflict_exception()
| invalid_parameter_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
@type delete_component_errors() ::
invalid_parameter_exception()
| internal_server_exception()
| resource_not_found_exception()
@type delete_form_errors() ::
invalid_parameter_exception()
| internal_server_exception()
| resource_not_found_exception()
@type delete_theme_errors() ::
invalid_parameter_exception()
| internal_server_exception()
| resource_not_found_exception()
@type exchange_code_for_token_errors() :: invalid_parameter_exception()
@type export_components_errors() :: invalid_parameter_exception() | internal_server_exception()
@type export_forms_errors() :: invalid_parameter_exception() | internal_server_exception()
@type export_themes_errors() :: invalid_parameter_exception() | internal_server_exception()
@type get_codegen_job_errors() ::
throttling_exception()
| invalid_parameter_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_component_errors() ::
invalid_parameter_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_form_errors() ::
invalid_parameter_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_metadata_errors() :: invalid_parameter_exception() | unauthorized_exception()
@type get_theme_errors() ::
invalid_parameter_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_codegen_jobs_errors() ::
throttling_exception() | invalid_parameter_exception() | internal_server_exception()
@type list_components_errors() :: invalid_parameter_exception() | internal_server_exception()
@type list_forms_errors() :: invalid_parameter_exception() | internal_server_exception()
@type list_tags_for_resource_errors() ::
throttling_exception()
| invalid_parameter_exception()
| internal_server_exception()
| resource_not_found_exception()
| unauthorized_exception()
@type list_themes_errors() :: invalid_parameter_exception() | internal_server_exception()
@type put_metadata_flag_errors() :: invalid_parameter_exception() | unauthorized_exception()
@type refresh_token_errors() :: invalid_parameter_exception()
@type start_codegen_job_errors() ::
throttling_exception() | invalid_parameter_exception() | internal_server_exception()
@type tag_resource_errors() ::
throttling_exception()
| invalid_parameter_exception()
| internal_server_exception()
| resource_not_found_exception()
| unauthorized_exception()
@type untag_resource_errors() ::
throttling_exception()
| invalid_parameter_exception()
| internal_server_exception()
| resource_not_found_exception()
| unauthorized_exception()
@type update_component_errors() ::
resource_conflict_exception()
| invalid_parameter_exception()
| internal_server_exception()
@type update_form_errors() ::
resource_conflict_exception()
| invalid_parameter_exception()
| internal_server_exception()
@type update_theme_errors() ::
resource_conflict_exception()
| invalid_parameter_exception()
| internal_server_exception()
def metadata do
%{
api_version: "2021-08-11",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "amplifyuibuilder",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "AmplifyUIBuilder",
signature_version: "v4",
signing_name: "amplifyuibuilder",
target_prefix: nil
}
end
@doc """
Creates a new component for an Amplify app.
"""
@spec create_component(
map(),
String.t() | atom(),
String.t() | atom(),
create_component_request(),
list()
) ::
{:ok, create_component_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_component_errors()}
def create_component(%Client{} = client, app_id, environment_name, input, options \\ []) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/components"
headers = []
custom_headers = []
{query_params, input} =
[
{"clientToken", "clientToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a new form for an Amplify app.
"""
@spec create_form(
map(),
String.t() | atom(),
String.t() | atom(),
create_form_request(),
list()
) ::
{:ok, create_form_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_form_errors()}
def create_form(%Client{} = client, app_id, environment_name, input, options \\ []) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/forms"
headers = []
custom_headers = []
{query_params, input} =
[
{"clientToken", "clientToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a theme to apply to the components in an Amplify app.
"""
@spec create_theme(
map(),
String.t() | atom(),
String.t() | atom(),
create_theme_request(),
list()
) ::
{:ok, create_theme_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_theme_errors()}
def create_theme(%Client{} = client, app_id, environment_name, input, options \\ []) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/themes"
headers = []
custom_headers = []
{query_params, input} =
[
{"clientToken", "clientToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes a component from an Amplify app.
"""
@spec delete_component(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom(),
delete_component_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_component_errors()}
def delete_component(%Client{} = client, app_id, environment_name, id, input, options \\ []) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/components/#{AWS.Util.encode_uri(id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes a form from an Amplify app.
"""
@spec delete_form(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom(),
delete_form_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_form_errors()}
def delete_form(%Client{} = client, app_id, environment_name, id, input, options \\ []) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/forms/#{AWS.Util.encode_uri(id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes a theme from an Amplify app.
"""
@spec delete_theme(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom(),
delete_theme_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_theme_errors()}
def delete_theme(%Client{} = client, app_id, environment_name, id, input, options \\ []) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/themes/#{AWS.Util.encode_uri(id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This is for internal use.
Amplify uses this action to exchange an access code for a token.
"""
@spec exchange_code_for_token(
map(),
String.t() | atom(),
exchange_code_for_token_request(),
list()
) ::
{:ok, exchange_code_for_token_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, exchange_code_for_token_errors()}
def exchange_code_for_token(%Client{} = client, provider, input, options \\ []) do
url_path = "/tokens/#{AWS.Util.encode_uri(provider)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Exports component configurations to code that is ready to integrate into an
Amplify app.
"""
@spec export_components(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom() | nil,
list()
) ::
{:ok, export_components_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, export_components_errors()}
def export_components(
%Client{} = client,
app_id,
environment_name,
next_token \\ nil,
options \\ []
) do
url_path =
"/export/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/components"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Exports form configurations to code that is ready to integrate into an Amplify
app.
"""
@spec export_forms(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom() | nil,
list()
) ::
{:ok, export_forms_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, export_forms_errors()}
def export_forms(%Client{} = client, app_id, environment_name, next_token \\ nil, options \\ []) do
url_path =
"/export/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/forms"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Exports theme configurations to code that is ready to integrate into an Amplify
app.
"""
@spec export_themes(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom() | nil,
list()
) ::
{:ok, export_themes_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, export_themes_errors()}
def export_themes(
%Client{} = client,
app_id,
environment_name,
next_token \\ nil,
options \\ []
) do
url_path =
"/export/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/themes"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns an existing code generation job.
"""
@spec get_codegen_job(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom(),
list()
) ::
{:ok, get_codegen_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_codegen_job_errors()}
def get_codegen_job(%Client{} = client, app_id, environment_name, id, options \\ []) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/codegen-jobs/#{AWS.Util.encode_uri(id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns an existing component for an Amplify app.
"""
@spec get_component(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom(),
list()
) ::
{:ok, get_component_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_component_errors()}
def get_component(%Client{} = client, app_id, environment_name, id, options \\ []) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/components/#{AWS.Util.encode_uri(id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns an existing form for an Amplify app.
"""
@spec get_form(map(), String.t() | atom(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_form_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_form_errors()}
def get_form(%Client{} = client, app_id, environment_name, id, options \\ []) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/forms/#{AWS.Util.encode_uri(id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns existing metadata for an Amplify app.
"""
@spec get_metadata(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_metadata_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_metadata_errors()}
def get_metadata(%Client{} = client, app_id, environment_name, options \\ []) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/metadata"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns an existing theme for an Amplify app.
"""
@spec get_theme(map(), String.t() | atom(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_theme_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_theme_errors()}
def get_theme(%Client{} = client, app_id, environment_name, id, options \\ []) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/themes/#{AWS.Util.encode_uri(id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves a list of code generation jobs for a specified Amplify app and backend
environment.
"""
@spec list_codegen_jobs(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_codegen_jobs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_codegen_jobs_errors()}
def list_codegen_jobs(
%Client{} = client,
app_id,
environment_name,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/codegen-jobs"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves a list of components for a specified Amplify app and backend
environment.
"""
@spec list_components(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_components_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_components_errors()}
def list_components(
%Client{} = client,
app_id,
environment_name,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/components"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves a list of forms for a specified Amplify app and backend environment.
"""
@spec list_forms(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_forms_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_forms_errors()}
def list_forms(
%Client{} = client,
app_id,
environment_name,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/forms"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns a list of tags for a specified Amazon Resource Name (ARN).
"""
@spec list_tags_for_resource(map(), String.t() | atom(), list()) ::
{:ok, list_tags_for_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tags_for_resource_errors()}
def list_tags_for_resource(%Client{} = client, resource_arn, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves a list of themes for a specified Amplify app and backend
environment.
"""
@spec list_themes(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_themes_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_themes_errors()}
def list_themes(
%Client{} = client,
app_id,
environment_name,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/themes"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Stores the metadata information about a feature on a form.
"""
@spec put_metadata_flag(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom(),
put_metadata_flag_request(),
list()
) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_metadata_flag_errors()}
def put_metadata_flag(
%Client{} = client,
app_id,
environment_name,
feature_name,
input,
options \\ []
) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/metadata/features/#{AWS.Util.encode_uri(feature_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
This is for internal use.
Amplify uses this action to refresh a previously issued access token that might
have expired.
"""
@spec refresh_token(map(), String.t() | atom(), refresh_token_request(), list()) ::
{:ok, refresh_token_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, refresh_token_errors()}
def refresh_token(%Client{} = client, provider, input, options \\ []) do
url_path = "/tokens/#{AWS.Util.encode_uri(provider)}/refresh"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Starts a code generation job for a specified Amplify app and backend
environment.
"""
@spec start_codegen_job(
map(),
String.t() | atom(),
String.t() | atom(),
start_codegen_job_request(),
list()
) ::
{:ok, start_codegen_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, start_codegen_job_errors()}
def start_codegen_job(%Client{} = client, app_id, environment_name, input, options \\ []) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/codegen-jobs"
headers = []
custom_headers = []
{query_params, input} =
[
{"clientToken", "clientToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Tags the resource with a tag key and value.
"""
@spec tag_resource(map(), String.t() | atom(), tag_resource_request(), list()) ::
{:ok, tag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Untags a resource with a specified Amazon Resource Name (ARN).
"""
@spec untag_resource(map(), String.t() | atom(), untag_resource_request(), list()) ::
{:ok, untag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"tagKeys", "tagKeys"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an existing component.
"""
@spec update_component(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom(),
update_component_request(),
list()
) ::
{:ok, update_component_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_component_errors()}
def update_component(%Client{} = client, app_id, environment_name, id, input, options \\ []) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/components/#{AWS.Util.encode_uri(id)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"clientToken", "clientToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an existing form.
"""
@spec update_form(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom(),
update_form_request(),
list()
) ::
{:ok, update_form_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_form_errors()}
def update_form(%Client{} = client, app_id, environment_name, id, input, options \\ []) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/forms/#{AWS.Util.encode_uri(id)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"clientToken", "clientToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an existing theme.
"""
@spec update_theme(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom(),
update_theme_request(),
list()
) ::
{:ok, update_theme_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_theme_errors()}
def update_theme(%Client{} = client, app_id, environment_name, id, input, options \\ []) do
url_path =
"/app/#{AWS.Util.encode_uri(app_id)}/environment/#{AWS.Util.encode_uri(environment_name)}/themes/#{AWS.Util.encode_uri(id)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"clientToken", "clientToken"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end
