ListModelPackageGroups
Gets a list of the model groups in your AWS account.
Request Syntax
{ "CreationTimeAfter": number, "CreationTimeBefore": number, "CrossAccountFilterOption": "string", "MaxResults": number, "NameContains": "string", "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.
- CreationTimeAfter
-
A filter that returns only model groups created after the specified time.
Type: Timestamp
Required: No
- CreationTimeBefore
-
A filter that returns only model groups created before the specified time.
Type: Timestamp
Required: No
- CrossAccountFilterOption
-
A filter that returns either model groups shared with you or model groups in your own account. When the value is
CrossAccount, the results show the resources made discoverable to you from other accounts. When the value isSameAccountornull, the results show resources from your account. The default isSameAccount.Type: String
Valid Values:
SameAccount | CrossAccountRequired: No
- MaxResults
-
The maximum number of results to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NameContains
-
A string in the model group name. This filter returns only model groups whose name contains the specified string.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern:
[a-zA-Z0-9\-]+Required: No
- NextToken
-
If the result of the previous
ListModelPackageGroupsrequest was truncated, the response includes aNextToken. To retrieve the next set of model groups, use the token in the next request.Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
.*Required: No
- SortBy
-
The field to sort results by. The default is
CreationTime.Type: String
Valid Values:
Name | CreationTimeRequired: No
- SortOrder
-
The sort order for results. The default is
Ascending.Type: String
Valid Values:
Ascending | DescendingRequired: No
Response Syntax
{ "ModelPackageGroupSummaryList": [ { "CreationTime": number, "ModelPackageGroupArn": "string", "ModelPackageGroupDescription": "string", "ModelPackageGroupName": "string", "ModelPackageGroupStatus": "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.
- ModelPackageGroupSummaryList
-
A list of summaries of the model groups in your AWS account.
Type: Array of ModelPackageGroupSummary objects
- NextToken
-
If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, 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 Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: