DescribeLineageGroup - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribeLineageGroup

Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.

Request Syntax

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

LineageGroupName

The name of the lineage group.

Type: String

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

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

Required: Yes

Response Syntax

{ "CreatedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "Description": "string", "DisplayName": "string", "LastModifiedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "LineageGroupArn": "string", "LineageGroupName": "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

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

Type: UserContext object

CreationTime

The creation time of lineage group.

Type: Timestamp

Description

The description of the lineage group.

Type: String

Length Constraints: Maximum length of 3072.

Pattern: .*

DisplayName

The display name of the lineage group.

Type: String

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

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

LastModifiedBy

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

Type: UserContext object

LastModifiedTime

The last modified time of the lineage group.

Type: Timestamp

LineageGroupArn

The Amazon Resource Name (ARN) of the lineage group.

Type: String

Length Constraints: Maximum length of 256.

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

LineageGroupName

The name of the lineage group.

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