UpdateTrainingJob - Amazon SageMaker
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

UpdateTrainingJob

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
      }
   ],
   "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.

ProfilerConfig

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

Type: ProfilerConfigForUpdate object

Required: No

ProfilerRuleConfigurations

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

ResourceConfig

The training job ResourceConfig to update warm pool retention length.

Type: ResourceConfigForUpdate object

Required: No

TrainingJobName

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.

TrainingJobArn

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/.*

Errors

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

ResourceNotFound

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 AWS SDKs, see the following: