DescribeTrialComponent
Provides a list of a trials component's properties.
Request Syntax
{ "TrialComponentName": "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.
- TrialComponentName
-
The name of the trial component to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|experiment-trial|experiment-trial-component|artifact|action|context)\/)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,119})Required: Yes
Response Syntax
{ "CreatedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "DisplayName": "string", "EndTime": number, "InputArtifacts": { "string" : { "MediaType": "string", "Value": "string" } }, "LastModifiedBy": { "DomainId": "string", "IamIdentity": { "Arn": "string", "PrincipalId": "string", "SourceIdentity": "string" }, "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "LineageGroupArn": "string", "MetadataProperties": { "CommitId": "string", "GeneratedBy": "string", "ProjectId": "string", "Repository": "string" }, "Metrics": [ { "Avg": number, "Count": number, "Last": number, "Max": number, "MetricName": "string", "Min": number, "SourceArn": "string", "StdDev": number, "TimeStamp": number } ], "OutputArtifacts": { "string" : { "MediaType": "string", "Value": "string" } }, "Parameters": { "string" : { "NumberValue": number, "StringValue": "string" } }, "Source": { "SourceArn": "string", "SourceType": "string" }, "Sources": [ { "SourceArn": "string", "SourceType": "string" } ], "StartTime": number, "Status": { "Message": "string", "PrimaryStatus": "string" }, "TrialComponentArn": "string", "TrialComponentName": "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.
- CreatedBy
-
Who created the trial component.
Type: UserContext object
- CreationTime
-
When the component was created.
Type: Timestamp
- DisplayName
-
The name of the component as displayed. If
DisplayNameisn't specified,TrialComponentNameis displayed.Type: String
Length Constraints: Minimum length of 1. Maximum length of 120.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119} - EndTime
-
When the component ended.
Type: Timestamp
- InputArtifacts
-
The input artifacts of the component.
Type: String to TrialComponentArtifact object map
Map Entries: Minimum number of 0 items. Maximum number of 60 items.
Key Length Constraints: Minimum length of 0. Maximum length of 128.
Key Pattern:
.* - LastModifiedBy
-
Who last modified the component.
Type: UserContext object
- LastModifiedTime
-
When the component was last modified.
Type: Timestamp
- LineageGroupArn
-
The Amazon Resource Name (ARN) of the lineage group.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:lineage-group/.* - MetadataProperties
-
Metadata properties of the tracking entity, trial, or trial component.
Type: MetadataProperties object
- Metrics
-
The metrics for the component.
Type: Array of TrialComponentMetricSummary objects
- OutputArtifacts
-
The output artifacts of the component.
Type: String to TrialComponentArtifact object map
Map Entries: Minimum number of 0 items. Maximum number of 60 items.
Key Length Constraints: Minimum length of 0. Maximum length of 128.
Key Pattern:
.* - Parameters
-
The hyperparameters of the component.
Type: String to TrialComponentParameterValue object map
Map Entries: Minimum number of 0 items. Maximum number of 300 items.
Key Length Constraints: Minimum length of 0. Maximum length of 320.
Key Pattern:
.* - Source
-
The Amazon Resource Name (ARN) of the source and, optionally, the job type.
Type: TrialComponentSource object
- Sources
-
A list of ARNs and, if applicable, job types for multiple sources of an experiment run.
Type: Array of TrialComponentSource objects
- StartTime
-
When the component started.
Type: Timestamp
- Status
-
The status of the component. States include:
-
InProgress
-
Completed
-
Failed
Type: TrialComponentStatus object
-
- TrialComponentArn
-
The Amazon Resource Name (ARN) of the trial component.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment-trial-component/.* - 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}
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: