TrialComponentSummary - Amazon SageMaker

TrialComponentSummary

A summary of the properties of a trial component. To get all the properties, call the DescribeTrialComponent API and provide the TrialComponentName.

Contents

CreatedBy

Who created the trial component.

Type: UserContext object

Required: No

CreationTime

When the component was created.

Type: Timestamp

Required: No

DisplayName

The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

Type: String

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

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

Required: No

EndTime

When the component ended.

Type: Timestamp

Required: No

LastModifiedBy

Who last modified the component.

Type: UserContext object

Required: No

LastModifiedTime

When the component was last modified.

Type: Timestamp

Required: No

StartTime

When the component started.

Type: Timestamp

Required: No

Status

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

Type: TrialComponentStatus object

Required: No

TrialComponentArn

The Amazon Resource Name (ARN) of the trial component.

Type: String

Length Constraints: Maximum length of 256.

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

Required: No

TrialComponentName

The name of the trial component.

Type: String

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

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

Required: No

TrialComponentSource

The Amazon Resource Name (ARN) and job type of the source of a trial component.

Type: TrialComponentSource object

Required: No

See Also

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