BatchDescribeModelPackage
This action batch describes a list of versioned model packages
Request Syntax
{
"ModelPackageArnList": [ "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.
- ModelPackageArnList
-
The list of Amazon Resource Name (ARN) of the model package groups.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package/[\S]{1,2048}$Required: Yes
Response Syntax
{
"BatchDescribeModelPackageErrorMap": {
"string" : {
"ErrorCode": "string",
"ErrorResponse": "string"
}
},
"ModelPackageSummaries": {
"string" : {
"CreationTime": number,
"InferenceSpecification": {
"Containers": [
{
"AdditionalS3DataSource": {
"CompressionType": "string",
"S3DataType": "string",
"S3Uri": "string"
},
"ContainerHostname": "string",
"Environment": {
"string" : "string"
},
"Framework": "string",
"FrameworkVersion": "string",
"Image": "string",
"ImageDigest": "string",
"ModelDataSource": {
"S3DataSource": {
"CompressionType": "string",
"ModelAccessConfig": {
"AcceptEula": boolean
},
"S3DataType": "string",
"S3Uri": "string"
}
},
"ModelDataUrl": "string",
"ModelInput": {
"DataInputConfig": "string"
},
"NearestModelName": "string",
"ProductId": "string"
}
],
"SupportedContentTypes": [ "string" ],
"SupportedRealtimeInferenceInstanceTypes": [ "string" ],
"SupportedResponseMIMETypes": [ "string" ],
"SupportedTransformInstanceTypes": [ "string" ]
},
"ModelApprovalStatus": "string",
"ModelPackageArn": "string",
"ModelPackageDescription": "string",
"ModelPackageGroupName": "string",
"ModelPackageStatus": "string",
"ModelPackageVersion": number
}
}
}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.
- BatchDescribeModelPackageErrorMap
-
A map of the resource and BatchDescribeModelPackageError objects reporting the error associated with describing the model package.
Type: String to BatchDescribeModelPackageError object map
Key Length Constraints: Minimum length of 1. Maximum length of 2048.
Key Pattern:
^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package/[\S]{1,2048}$ - ModelPackageSummaries
-
The summaries for the model package versions
Type: String to BatchDescribeModelPackageSummary object map
Key Length Constraints: Minimum length of 1. Maximum length of 2048.
Key Pattern:
^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package/[\S]{1,2048}$
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 Amazon SDKs, see the following: