metadatas
Creates, updates, deletes, gets or lists a metadatas resource.
Overview
| Name | metadatas |
| Type | Resource |
| Id | aws.amplifyuibuilder.metadatas |
Fields
The following fields are returned by SELECT queries:
- get_metadata
| Name | Datatype | Description |
|---|---|---|
features | object | Represents the configuration settings for the features metadata. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_metadata | select | app_id, environment_name, region | Returns existing metadata for an Amplify app. | |
put_metadata_flag | replace | app_id, environment_name, feature_name, region, body | Stores the metadata information about a feature on a form. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
app_id | string | The unique ID for the Amplify app. |
environment_name | string | The name of the backend environment that is part of the Amplify app. |
feature_name | string | The name of the feature associated with the metadata. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_metadata
Returns existing metadata for an Amplify app.
SELECT
features
FROM aws.amplifyuibuilder.metadatas
WHERE app_id = '{{ app_id }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND region = '{{ region }}' -- required
;
REPLACE examples
- put_metadata_flag
Stores the metadata information about a feature on a form.
REPLACE aws.amplifyuibuilder.metadatas
SET
body = '{{ body }}'
WHERE
app_id = '{{ app_id }}' --required
AND environment_name = '{{ environment_name }}' --required
AND feature_name = '{{ feature_name }}' --required
AND region = '{{ region }}' --required
AND body = '{{ body }}' --required;