bill_of_materials_import_jobs

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

Overview

Name	bill_of_materials_import_jobs
Type	Resource
Id	aws.supplychain.bill_of_materials_import_jobs

Fields

The following fields are returned by SELECT queries:

get_bill_of_materials_import_job

Name	Datatype	Description
instance_id	string	The BillOfMaterialsImportJob instanceId. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
job_id	string	The BillOfMaterialsImportJob jobId. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
message	string	When the BillOfMaterialsImportJob has reached a terminal state, there will be a message.
s_3uri	string	The S3 URI from which the CSV is read. (pattern: <code>[sS]3:​//[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.+</code>)
status	string	The BillOfMaterialsImportJob ConfigurationJobStatus. (NEW, FAILED, IN_PROGRESS, QUEUED, SUCCESS)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_bill_of_materials_import_job	select	instance_id, job_id, region		Get status and details of a BillOfMaterialsImportJob.
create_bill_of_materials_import_job	insert	instance_id, region, s3uri		CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials (BOM) entity. For information on the product_bom entity, see the AWS Supply Chain User Guide. The CSV file must be located in an Amazon S3 location accessible to AWS Supply Chain. It is recommended to use the same Amazon S3 bucket created during your AWS Supply Chain instance creation.

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
instance_id	string	The AWS Supply Chain instance identifier.
job_id	string	The BillOfMaterialsImportJob identifier.
region	string	AWS region (default: us-east-1)

SELECT examples

get_bill_of_materials_import_job

Get status and details of a BillOfMaterialsImportJob.

SELECT
instance_id,
job_id,
message,
s_3uri,
status
FROM aws.supplychain.bill_of_materials_import_jobs
WHERE instance_id = '{{ instance_id }}' -- required
AND job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_bill_of_materials_import_job

CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials (BOM) entity. For information on the product_bom entity, see the AWS Supply Chain User Guide. The CSV file must be located in an Amazon S3 location accessible to AWS Supply Chain. It is recommended to use the same Amazon S3 bucket created during your AWS Supply Chain instance creation.

INSERT INTO aws.supplychain.bill_of_materials_import_jobs (
s3uri,
clientToken,
instance_id,
region
)
SELECT 
'{{ s3uri }}' /* required */,
'{{ clientToken }}',
'{{ instance_id }}',
'{{ region }}'
RETURNING
job_id
;

Manifest

# Description fields are for documentation purposes
- name: bill_of_materials_import_jobs
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the bill_of_materials_import_jobs resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the bill_of_materials_import_jobs resource.
  - name: s3uri
    value: "{{ s3uri }}"
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.