AWS Supply Chain

Get status and details of a BillOfMaterialsImportJob.

See also: AWS API Documentation

Request Syntax

client.get_bill_of_materials_import_job(
    instanceId='string',
    jobId='string'
)

type instanceId

string

param instanceId

[REQUIRED]

The AWS Supply Chain instance identifier.

type jobId

string

param jobId

[REQUIRED]

The BillOfMaterialsImportJob identifier.

rtype

dict

returns

Response Syntax

{
    'job': {
        'instanceId': 'string',
        'jobId': 'string',
        'status': 'NEW'|'FAILED'|'IN_PROGRESS'|'QUEUED'|'SUCCESS',
        's3uri': 'string',
        'message': 'string'
    }
}

Response Structure

• (dict) --

  The response parameters for GetBillOfMaterialsImportJob.

  • job (dict) --

    The BillOfMaterialsImportJob.

    • instanceId (string) --

      The BillOfMaterialsImportJob instanceId.

    • jobId (string) --

      The BillOfMaterialsImportJob jobId.

    • status (string) --

      The BillOfMaterialsImportJob ConfigurationJobStatus.

    • s3uri (string) --

      The S3 URI from which the CSV is read.

    • message (string) --

      When the BillOfMaterialsImportJob has reached a terminal state, there will be a message.

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.

See also: AWS API Documentation

Request Syntax

client.create_bill_of_materials_import_job(
    instanceId='string',
    s3uri='string',
    clientToken='string'
)

type instanceId

string

param instanceId

[REQUIRED]

The AWS Supply Chain instance identifier.

type s3uri

string

param s3uri

[REQUIRED]

The S3 URI of the CSV file to be imported. The bucket must grant permissions for AWS Supply Chain to read the file.

type clientToken

string

param clientToken

An idempotency token.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'jobId': 'string'
}

Response Structure

• (dict) --

  The response parameters of CreateBillOfMaterialsImportJob.

  • jobId (string) --

    The new BillOfMaterialsImportJob identifier.