ListLineageGroups
A list of lineage groups shared with your AWS account. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.
Request Syntax
{
"MaxResults": number,
"NextToken": "string",
"SortBy": "string",
"SortOrder": "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.
- MaxResults
-
The maximum number of endpoints to return in the response. This value defaults to 10.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
.*Required: No
- SortBy
-
The parameter by which to sort the results. The default is
CreationTime.Type: String
Valid Values:
Name | CreationTimeRequired: No
- SortOrder
-
The sort order for the results. The default is
Ascending.Type: String
Valid Values:
Ascending | DescendingRequired: No
Response Syntax
{
"LineageGroupSummaries": [
{
"DisplayName": "string",
"LineageGroupArn": "string",
"LineageGroupName": "string"
}
],
"NextToken": "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.
- LineageGroupSummaries
-
A list of lineage groups and their properties.
Type: Array of LineageGroupSummary objects
- NextToken
-
If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Error Types.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
