AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::SageMaker::ProcessingJob

CfnProcessingJob

An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information, see [Process Data and Evaluate Models](https://docs.aws.amazon.com/sagemaker/latest/dg/processing-job.html) . Also, note the following details specific to processing jobs created using CloudFormation stacks: - When you delete a CloudFormation stack with a processing job resource, the processing job is stopped using the [StopProcessingJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopProcessingJob.html) API but not deleted. Any tags associated with the processing job are deleted using the [DeleteTags](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteTags.html) API. - If any part of your CloudFormation stack deployment fails and a rollback initiates, processing jobs with a specified `ProcessingJobName` value might cause the stack to become stuck in a failed state. This occurs because during a rollback, CloudFormation attempts to recreate the stack resources. Processing job names must be unique, so when CloudFormation attempts to recreate a processing job using the already defined name, this results in an `AlreadyExists` error. To prevent this, we recommend that you don't specify the optional `ProcessingJobName` property, thereby allowing SageMaker to auto-generate a unique name for your processing job. This ensures successful stack rollbacks when necessary. If you must use custom job names, you have to manually modify the `ProcessingJobName` and redeploy the stack to recover from a failed rollback.

Import

import { CfnProcessingJob } from 'aws-cdk-lib/aws-sagemaker';

Or use the module namespace:

import * as sagemaker from 'aws-cdk-lib/aws-sagemaker';
// sagemaker.CfnProcessingJob

Properties

Configuration passed to the constructor as CfnProcessingJobProps.

appSpecificationRequired
IResolvable | AppSpecificationProperty

Configuration to run a processing job in a specified container image.

processingResourcesRequired
IResolvable | ProcessingResourcesProperty

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

roleArnRequired
string

The ARN of the role used to create the processing job.

environmentOptional
{ [key: string]: string } | IResolvable

Sets the environment variables in the Docker container.

experimentConfigOptional
IResolvable | ExperimentConfigProperty

Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the [CreateProcessingJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) API.

networkConfigOptional
IResolvable | NetworkConfigProperty

Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

processingInputsOptional
IResolvable | IResolvable | ProcessingInputsObjectProperty[]

List of input configurations for the processing job.

processingJobNameOptional
string

The name of the processing job. If you don't provide a job name, then a unique name is automatically created for the job.

processingOutputConfigOptional
IResolvable | ProcessingOutputConfigProperty

Contains information about the output location for the compiled model and the target device that the model runs on. `TargetDevice` and `TargetPlatform` are mutually exclusive, so you need to choose one between the two to specify your target device or platform. If you cannot find your device you want to use from the `TargetDevice` list, use `TargetPlatform` to describe the platform of your edge device and `CompilerOptions` if there are specific settings that are required or recommended to use for particular TargetPlatform.

stoppingConditionOptional
IResolvable | StoppingConditionProperty

Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. After the condition is met, the processing job is stopped.

tagsOptional
CfnTag[]

An array of key-value pairs. For more information, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) in the *AWS Billing and Cost Management User Guide* .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::SageMaker::ProcessingJobView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-sagemaker
CFN TypeAWS::SageMaker::ProcessingJob
Properties11

Related Constructs

Explore This Service

External Links