Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: CC-BY-SA-4.0

Describes a model that you created using the CreateModel API.

{
   "[ModelName](#SageMaker-DescribeModel-request-ModelName)": "string"
}

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

{
   "[Containers](#SageMaker-DescribeModel-response-Containers)": [ 
      { 
         "[ContainerHostname](API_ContainerDefinition.md#SageMaker-Type-ContainerDefinition-ContainerHostname)": "string",
         "[Environment](API_ContainerDefinition.md#SageMaker-Type-ContainerDefinition-Environment)": { 
            "string" : "string" 
         },
         "[Image](API_ContainerDefinition.md#SageMaker-Type-ContainerDefinition-Image)": "string",
         "[ModelDataUrl](API_ContainerDefinition.md#SageMaker-Type-ContainerDefinition-ModelDataUrl)": "string",
         "[ModelPackageName](API_ContainerDefinition.md#SageMaker-Type-ContainerDefinition-ModelPackageName)": "string"
      }
   ],
   "[CreationTime](#SageMaker-DescribeModel-response-CreationTime)": number,
   "[EnableNetworkIsolation](#SageMaker-DescribeModel-response-EnableNetworkIsolation)": boolean,
   "[ExecutionRoleArn](#SageMaker-DescribeModel-response-ExecutionRoleArn)": "string",
   "[ModelArn](#SageMaker-DescribeModel-response-ModelArn)": "string",
   "[ModelName](#SageMaker-DescribeModel-response-ModelName)": "string",
   "[PrimaryContainer](#SageMaker-DescribeModel-response-PrimaryContainer)": { 
      "[ContainerHostname](API_ContainerDefinition.md#SageMaker-Type-ContainerDefinition-ContainerHostname)": "string",
      "[Environment](API_ContainerDefinition.md#SageMaker-Type-ContainerDefinition-Environment)": { 
         "string" : "string" 
      },
      "[Image](API_ContainerDefinition.md#SageMaker-Type-ContainerDefinition-Image)": "string",
      "[ModelDataUrl](API_ContainerDefinition.md#SageMaker-Type-ContainerDefinition-ModelDataUrl)": "string",
      "[ModelPackageName](API_ContainerDefinition.md#SageMaker-Type-ContainerDefinition-ModelPackageName)": "string"
   },
   "[VpcConfig](#SageMaker-DescribeModel-response-VpcConfig)": { 
      "[SecurityGroupIds](API_VpcConfig.md#SageMaker-Type-VpcConfig-SecurityGroupIds)": [ "string" ],
      "[Subnets](API_VpcConfig.md#SageMaker-Type-VpcConfig-Subnets)": [ "string" ]
   }
}

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 5 items.

** CreationTime ** A timestamp that shows when the model was created.
Type: Timestamp

** EnableNetworkIsolation ** If True, no inbound or outbound network calls can be made to or from the model container.
The Semantic Segmentation built-in algorithm does not support network isolation. 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.
Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:model/.*

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

For information about the errors that are common to all actions, see Common Errors.

For more information about using this API in one of the language-specific AWS SDKs, see the following: + AWS Command Line Interface + AWS SDK for .NET + AWS SDK for C++ + AWS SDK for Go + AWS SDK for Go - Pilot + AWS SDK for Java + AWS SDK for JavaScript + AWS SDK for PHP V3 + AWS SDK for Python + AWS SDK for Ruby V2