backend_jobs

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

Overview

Name	backend_jobs
Type	Resource
Id	aws.amplifybackend.backend_jobs

Fields

The following fields are returned by SELECT queries:

get_backend_job

Name	Datatype	Description
app_id	string	The app ID.
backend_environment_name	string	The name of the backend environment.
create_time	string	The time when the job was created.
error	string	If the request fails, this error is returned.
job_id	string	The ID for the job.
operation	string	The name of the operation.
status	string	The current status of the request.
update_time	string	The time when the job was last updated.

list_backend_jobs

Name	Datatype	Description
app_id	string	The app ID.
backend_environment_name	string	The name of the backend environment.
create_time	string	The time when the job was created.
error	string	If the request fails, this error is returned.
job_id	string	The ID for the job.
operation	string	The name of the operation.
status	string	The current status of the request.
update_time	string	The time when the job was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_backend_job	select	app_id, backend_environment_name, job_id, region		Returns information about a specific job.
list_backend_jobs	select	app_id, backend_environment_name, region		Lists the jobs for the backend of an Amplify app.
update_backend_job	update	app_id, backend_environment_name, job_id, region		Updates a specific job.

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 app ID.
backend_environment_name	string	The name of the backend environment.
job_id	string	The ID for the job.
region	string	AWS region (default: us-east-1)

SELECT examples

get_backend_job

Returns information about a specific job.

SELECT
app_id,
backend_environment_name,
create_time,
error,
job_id,
operation,
status,
update_time
FROM aws.amplifybackend.backend_jobs
WHERE app_id = '{{ app_id }}' -- required
AND backend_environment_name = '{{ backend_environment_name }}' -- required
AND job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required
;

list_backend_jobs

Lists the jobs for the backend of an Amplify app.

SELECT
app_id,
backend_environment_name,
create_time,
error,
job_id,
operation,
status,
update_time
FROM aws.amplifybackend.backend_jobs
WHERE app_id = '{{ app_id }}' -- required
AND backend_environment_name = '{{ backend_environment_name }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_backend_job

Updates a specific job.

UPDATE aws.amplifybackend.backend_jobs
SET 
Operation = '{{ Operation }}',
Status = '{{ Status }}'
WHERE 
app_id = '{{ app_id }}' --required
AND backend_environment_name = '{{ backend_environment_name }}' --required
AND job_id = '{{ job_id }}' --required
AND region = '{{ region }}' --required
RETURNING
app_id,
backend_environment_name,
create_time,
error,
job_id,
operation,
status,
update_time;