DescribeModel
Describes a model that you created using the CreateModel
API.
Request Syntax
{
"ModelName": "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.
- ModelName
-
The name of the model.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?Required: Yes
Response Syntax
{
"Containers": [
{
"AdditionalModelDataSources": [
{
"ChannelName": "string",
"S3DataSource": {
"CompressionType": "string",
"ETag": "string",
"HubAccessConfig": {
"HubContentArn": "string"
},
"ManifestEtag": "string",
"ManifestS3Uri": "string",
"ModelAccessConfig": {
"AcceptEula": boolean
},
"S3DataType": "string",
"S3Uri": "string"
}
}
],
"ContainerHostname": "string",
"Environment": {
"string" : "string"
},
"Image": "string",
"ImageConfig": {
"RepositoryAccessMode": "string",
"RepositoryAuthConfig": {
"RepositoryCredentialsProviderArn": "string"
}
},
"InferenceSpecificationName": "string",
"Mode": "string",
"ModelDataSource": {
"S3DataSource": {
"CompressionType": "string",
"ETag": "string",
"HubAccessConfig": {
"HubContentArn": "string"
},
"ManifestEtag": "string",
"ManifestS3Uri": "string",
"ModelAccessConfig": {
"AcceptEula": boolean
},
"S3DataType": "string",
"S3Uri": "string"
}
},
"ModelDataUrl": "string",
"ModelPackageName": "string",
"MultiModelConfig": {
"ModelCacheSetting": "string"
}
}
],
"CreationTime": number,
"DeploymentRecommendation": {
"RealTimeInferenceRecommendations": [
{
"Environment": {
"string" : "string"
},
"InstanceType": "string",
"RecommendationId": "string"
}
],
"RecommendationStatus": "string"
},
"EnableNetworkIsolation": boolean,
"ExecutionRoleArn": "string",
"InferenceExecutionConfig": {
"Mode": "string"
},
"ModelArn": "string",
"ModelName": "string",
"PrimaryContainer": {
"AdditionalModelDataSources": [
{
"ChannelName": "string",
"S3DataSource": {
"CompressionType": "string",
"ETag": "string",
"HubAccessConfig": {
"HubContentArn": "string"
},
"ManifestEtag": "string",
"ManifestS3Uri": "string",
"ModelAccessConfig": {
"AcceptEula": boolean
},
"S3DataType": "string",
"S3Uri": "string"
}
}
],
"ContainerHostname": "string",
"Environment": {
"string" : "string"
},
"Image": "string",
"ImageConfig": {
"RepositoryAccessMode": "string",
"RepositoryAuthConfig": {
"RepositoryCredentialsProviderArn": "string"
}
},
"InferenceSpecificationName": "string",
"Mode": "string",
"ModelDataSource": {
"S3DataSource": {
"CompressionType": "string",
"ETag": "string",
"HubAccessConfig": {
"HubContentArn": "string"
},
"ManifestEtag": "string",
"ManifestS3Uri": "string",
"ModelAccessConfig": {
"AcceptEula": boolean
},
"S3DataType": "string",
"S3Uri": "string"
}
},
"ModelDataUrl": "string",
"ModelPackageName": "string",
"MultiModelConfig": {
"ModelCacheSetting": "string"
}
},
"VpcConfig": {
"SecurityGroupIds": [ "string" ],
"Subnets": [ "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.
- Containers
-
The containers in the inference pipeline.
Type: Array of ContainerDefinition objects
Array Members: Maximum number of 15 items.
- CreationTime
-
A timestamp that shows when the model was created.
Type: Timestamp
- DeploymentRecommendation
-
A set of recommended deployment configurations for the model.
Type: DeploymentRecommendation object
- EnableNetworkIsolation
-
If
True, no inbound or outbound network calls can be made to or from the model container.Type: Boolean
- ExecutionRoleArn
-
The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ - InferenceExecutionConfig
-
Specifies details of how containers in a multi-container endpoint are called.
Type: InferenceExecutionConfig object
- ModelArn
-
The Amazon Resource Name (ARN) of the model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:model/.* - ModelName
-
Name of the SageMaker model.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])? - PrimaryContainer
-
The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.
Type: ContainerDefinition object
- VpcConfig
-
A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud
Type: VpcConfig object
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:
