codegen_jobs

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

Overview

Name	codegen_jobs
Type	Resource
Id	aws.amplifyuibuilder.codegen_jobs

Fields

The following fields are returned by SELECT queries:

get_codegen_job

Name	Datatype	Description
id	string	The unique ID for the code generation job.
app_id	string	The ID of the Amplify app associated with the code generation job. (pattern: <code>d[a-z0-9]+</code>)
asset	object	The CodegenJobAsset to use for the code generation job.
auto_generate_forms	boolean	Specifies whether to autogenerate forms in the code generation job.
created_at	string (date-time)	The time that the code generation job was created.
dependencies	array	Lists the dependency packages that may be required for the project code to run.
environment_name	string	The name of the backend environment associated with the code generation job.
features	object	Describes the feature flags that you can specify for a code generation job.
generic_data_schema	object	Describes the data schema for a code generation job.
modified_at	string (date-time)	The time that the code generation job was modified.
render_config	object	Describes the configuration information for rendering the UI component associated with the code generation job.
status	string	The status of the code generation job. (in_progress, failed, succeeded)
status_message	string	The customized status message for the code generation job.
tags	object	One or more key-value pairs to use when tagging the code generation job.

list_codegen_jobs

Name	Datatype	Description
id	string	The unique ID for the code generation job summary.
app_id	string	The unique ID of the Amplify app associated with the code generation job. (pattern: <code>d[a-z0-9]+</code>)
created_at	string (date-time)	The time that the code generation job summary was created.
environment_name	string	The name of the backend environment associated with the code generation job.
modified_at	string (date-time)	The time that the code generation job summary was modified.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_codegen_job	select	app_id, environment_name, id, region		Returns an existing code generation job.
list_codegen_jobs	select	app_id, environment_name, region	nextToken, maxResults	Retrieves a list of code generation jobs for a specified Amplify app and backend environment.

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 a part of the Amplify app.
id	string	The unique ID of the code generation job.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of jobs to retrieve.
nextToken	string	The token to request the next page of results.

SELECT examples

get_codegen_job

Returns an existing code generation job.

SELECT
id,
app_id,
asset,
auto_generate_forms,
created_at,
dependencies,
environment_name,
features,
generic_data_schema,
modified_at,
render_config,
status,
status_message,
tags
FROM aws.amplifyuibuilder.codegen_jobs
WHERE app_id = '{{ app_id }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_codegen_jobs

Retrieves a list of code generation jobs for a specified Amplify app and backend environment.

SELECT
id,
app_id,
created_at,
environment_name,
modified_at
FROM aws.amplifyuibuilder.codegen_jobs
WHERE app_id = '{{ app_id }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;