DescribeModelPackageGroup
Gets a description for the specified model group.
Request Syntax
{
"ModelPackageGroupName": "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.
- ModelPackageGroupName
-
The name of the model group to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 170.
Pattern:
(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:[a-z\-]*\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?<!-)Required: Yes
Response Syntax
{
"CreatedBy": {
"DomainId": "string",
"IamIdentity": {
"Arn": "string",
"PrincipalId": "string",
"SourceIdentity": "string"
},
"UserProfileArn": "string",
"UserProfileName": "string"
},
"CreationTime": number,
"ModelPackageGroupArn": "string",
"ModelPackageGroupDescription": "string",
"ModelPackageGroupName": "string",
"ModelPackageGroupStatus": "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 a SageMaker resource.
Type: UserContext object
- CreationTime
-
The time that the model group was created.
Type: Timestamp
- ModelPackageGroupArn
-
The Amazon Resource Name (ARN) of the model group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package-group/[\S]{1,2048} - ModelPackageGroupDescription
-
A description of the model group.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]* - ModelPackageGroupName
-
The name of the model group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} - ModelPackageGroupStatus
-
The status of the model group.
Type: String
Valid Values:
Pending | InProgress | Completed | Failed | Deleting | DeleteFailed
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 Amazon SDKs, see the following: