Skip to main content

metadatas

Creates, updates, deletes, gets or lists a metadatas resource.

Overview

Namemetadatas
TypeResource
Idaws.amplifyuibuilder.metadatas

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
featuresobjectRepresents the configuration settings for the features metadata.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_metadataselectapp_id, environment_name, regionReturns existing metadata for an Amplify app.
put_metadata_flagreplaceapp_id, environment_name, feature_name, region, bodyStores 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.

NameDatatypeDescription
app_idstringThe unique ID for the Amplify app.
environment_namestringThe name of the backend environment that is part of the Amplify app.
feature_namestringThe name of the feature associated with the metadata.
regionstringAWS region (default: us-east-1)

SELECT examples

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

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;