protected_jobs

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

Overview

Name	protected_jobs
Type	Resource
Id	aws.cleanrooms.protected_jobs

Fields

The following fields are returned by SELECT queries:

get_protected_job

Name	Datatype	Description
id	string	The identifier for a protected job instance. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
compute_configuration	object	The compute configuration for the protected job.
create_time	string (date-time)	The creation time of the protected job.
error	object	The error from the protected job.
job_compute_payer_account_id	string	The account ID of the member that pays for the job compute costs. (pattern: <code>\d+</code>)
job_parameters	object	The job parameters for the protected job.
membership_arn	string	The ARN of the membership. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+</code>)
membership_id	string	he identifier for the membership. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
result	object	The result of the protected job.
result_configuration	object	Contains any details needed to write the job results.
statistics	object	The statistics of the protected job.
status	string	The status of the protected job. (SUBMITTED, STARTED, CANCELLED, CANCELLING, FAILED, SUCCESS)

list_protected_jobs

Name	Datatype	Description
id	string	The ID of the protected job. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
create_time	string (date-time)	The time the protected job was created.
job_compute_payer_account_id	string	The account ID of the member that pays for the job compute costs. (pattern: <code>\d+</code>)
membership_arn	string	The unique ARN for the membership that initiated the protected job. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+</code>)
membership_id	string	The unique ID for the membership that initiated the protected job. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
receiver_configurations	array	The receiver configurations for the protected job.
status	string	The status of the protected job. (SUBMITTED, STARTED, CANCELLED, CANCELLING, FAILED, SUCCESS)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_protected_job	select	membership_identifier, protected_job_identifier, region		Returns job processing metadata.
list_protected_jobs	select	membership_identifier, region	status, nextToken, maxResults	Lists protected jobs, sorted by most recent job.
update_protected_job	update	membership_identifier, protected_job_identifier, region, targetStatus		Updates the processing of a currently running 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
membership_identifier	string	The identifier for a member of a protected job instance.
protected_job_identifier	string	The identifier of the protected job to update.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.
nextToken	string	The pagination token that's used to fetch the next set of results.
status	string	A filter on the status of the protected job.

SELECT examples

get_protected_job

Returns job processing metadata.

SELECT
id,
compute_configuration,
create_time,
error,
job_compute_payer_account_id,
job_parameters,
membership_arn,
membership_id,
result,
result_configuration,
statistics,
status
FROM aws.cleanrooms.protected_jobs
WHERE membership_identifier = '{{ membership_identifier }}' -- required
AND protected_job_identifier = '{{ protected_job_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_protected_jobs

Lists protected jobs, sorted by most recent job.

SELECT
id,
create_time,
job_compute_payer_account_id,
membership_arn,
membership_id,
receiver_configurations,
status
FROM aws.cleanrooms.protected_jobs
WHERE membership_identifier = '{{ membership_identifier }}' -- required
AND region = '{{ region }}' -- required
AND status = '{{ status }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

UPDATE examples

update_protected_job

Updates the processing of a currently running job.

UPDATE aws.cleanrooms.protected_jobs
SET 
targetStatus = '{{ targetStatus }}'
WHERE 
membership_identifier = '{{ membership_identifier }}' --required
AND protected_job_identifier = '{{ protected_job_identifier }}' --required
AND region = '{{ region }}' --required
AND targetStatus = '{{ targetStatus }}' --required
RETURNING
protected_job;