UpdateTrainingJob - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.

Request Syntax

{ "ProfilerConfig": { "DisableProfiler": boolean, "ProfilingIntervalInMilliseconds": number, "ProfilingParameters": { "string" : "string" }, "S3OutputPath": "string" }, "ProfilerRuleConfigurations": [ { "InstanceType": "string", "LocalPath": "string", "RuleConfigurationName": "string", "RuleEvaluatorImage": "string", "RuleParameters": { "string" : "string" }, "S3OutputPath": "string", "VolumeSizeInGB": number } ], "RemoteDebugConfig": { "EnableRemoteDebug": boolean }, "ResourceConfig": { "KeepAlivePeriodInSeconds": number }, "TrainingJobName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.

Type: ProfilerConfigForUpdate object

Required: No


Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

Type: Array of ProfilerRuleConfiguration objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: No


Configuration for remote debugging while the training job is running. You can update the remote debugging configuration when the SecondaryStatus of the job is Downloading or Training.To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Systems Manager (SSM) for remote debugging.

Type: RemoteDebugConfigForUpdate object

Required: No


The training job ResourceConfig to update warm pool retention length.

Type: ResourceConfigForUpdate object

Required: No


The name of a training job to update the Debugger profiling configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

Required: Yes

Response Syntax

{ "TrainingJobArn": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The Amazon Resource Name (ARN) of the training job.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:training-job/.*


For information about the errors that are common to all actions, see Common Errors.


You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400


Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: