Amazon SageMaker
Developer Guide

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])*

Required: Yes

Response Syntax

{ "Containers": [ { "ContainerHostname": "string", "Environment": { "string" : "string" }, "Image": "string", "ModelDataUrl": "string", "ModelPackageName": "string" } ], "CreationTime": number, "EnableNetworkIsolation": boolean, "ExecutionRoleArn": "string", "ModelArn": "string", "ModelName": "string", "PrimaryContainer": { "ContainerHostname": "string", "Environment": { "string" : "string" }, "Image": "string", "ModelDataUrl": "string", "ModelPackageName": "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

Type: Array of ContainerDefinition objects

Array Members: Maximum number of 5 items.

CreationTime

A timestamp that shows when the model was created.

Type: Timestamp

EnableNetworkIsolation

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+=,.@\-_/]+$

ModelArn

The Amazon Resource Name (ARN) of the model.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

ModelName

Name of the Amazon SageMaker model.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[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: