View a markdown version of this page

ExecuteTrainingOperation - Amazon SageMaker

ExecuteTrainingOperation

Submits an asynchronous training operation to the specified training session. The service executes operations in sequence number order. The session must be in Running or Blocked state. Use GetTrainingOperationResult to poll for the result. Supported operation types: forward, forwardBackward, optimizerStep, saveWeights, saveState, and loadState.

Request Syntax

POST /v1/training-sessions/trainingSessionName/operations HTTP/1.1 Content-type: application/json { "clientToken": "string", "operationConfig": { ... }, "sequenceNumber": number }

URI Request Parameters

The request uses the following URI parameters.

trainingSessionName

The name of the training session to submit the operation to.

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

Pattern: [a-zA-Z0-9-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service ignores the request but does not return an error.

Type: String

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

Pattern: [a-zA-Z0-9-]+

Required: No

operationConfig

The configuration that specifies the type and parameters of the training operation. Exactly one member of the union must be set.

Type: OperationConfig object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

sequenceNumber

The monotonically increasing sequence number that determines execution order. The training session processes operations strictly in sequence number order. If a gap exists, the session blocks until the missing operation arrives or times out. Must be at least 1.

Type: Integer

Valid Range: Minimum value of 1.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "operationId": "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.

operationId

The unique identifier for the submitted operation. Use this identifier with GetTrainingOperationResult to retrieve the operation status and result.

Type: String

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

Pattern: [a-zA-Z0-9-]+

Errors

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

ConflictException

The training session is in a state that cannot accept new operations. The session must be in Running or Blocked state to accept requests.

HTTP Status Code: 409

InternalServerException

An internal service error occurred. Retry the request using exponential backoff.

HTTP Status Code: 500

ResourceNotFoundException

The specified training session or operation does not exist, or the operation does not belong to the specified training session.

HTTP Status Code: 404

ThrottlingException

The request was throttled. Retry the request after a brief wait using exponential backoff.

HTTP Status Code: 429

ValidationException

The request is not valid. Check the request syntax and parameters. Examples include invalid sequence numbers, malformed client tokens, missing required fields, or invalid operation configuration.

HTTP Status Code: 400

See Also

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