View a markdown version of this page

DescribeTrainingSession - Amazon SageMaker

DescribeTrainingSession

Retrieves detailed information about a training session, including its current status, model configuration, Low-Rank Adaptation (LoRA) parameters, and timestamps.

The following operations are related to DescribeTrainingSession:

  • CreateTrainingSession

  • ListTrainingSessions

  • StopTrainingSession

  • DeleteTrainingSession

Request Syntax

{ "TrainingSessionName": "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.

TrainingSessionName

The name of the training session to describe.

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

{ "TrainingSessionDetail": { "BillableTokenUsage": { "PrefillTokenCount": number, "SampleTokenCount": number, "TrainingTokenCount": number }, "CreationTime": number, "EndTime": number, "ErrorDetails": "string", "LastModifiedTime": number, "LastReceivedSequenceNumber": number, "LoraConfig": { "Alpha": number, "Rank": number }, "ModelConfig": { "AcceptEula": boolean, "BaseModelArn": "string" }, "ModelPackageGroupArn": "string", "OutputConfig": { "S3Location": { "KmsKeyArn": "string", "Path": "string" } }, "RoleArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TrainingSessionArn": "string", "TrainingSessionName": "string", "TrainingSessionStatus": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "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.

TrainingSessionDetail

The detailed information about the training session.

Type: TrainingSessionDetail object

Errors

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

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: