Amazon SageMaker · JSON Structure

Amazon Sagemaker Endpoint Structure

Endpoint schema from Amazon SageMaker API

Type: object Properties: 8

AIInferenceMachine LearningMLOpsTraining

Endpoint is a JSON Structure definition published by Amazon SageMaker, describing 8 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

EndpointName EndpointArn EndpointConfigName EndpointStatus ProductionVariants CreationTime LastModifiedTime FailureReason

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-sagemaker/refs/heads/main/json-structure/amazon-sagemaker-endpoint-structure.json",
  "name": "Endpoint",
  "description": "Endpoint schema from Amazon SageMaker API",
  "type": "object",
  "properties": {
    "EndpointName": {
      "type": "string",
      "description": "The name of the endpoint."
    },
    "EndpointArn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the endpoint."
    },
    "EndpointConfigName": {
      "type": "string",
      "description": "The name of the endpoint configuration."
    },
    "EndpointStatus": {
      "type": "string",
      "description": "The status of the endpoint.",
      "enum": [
        "OutOfService",
        "Creating",
        "Updating",
        "SystemUpdating",
        "RollingBack",
        "InService",
        "Deleting",
        "Failed"
      ]
    },
    "ProductionVariants": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "VariantName": {
            "type": "string"
          },
          "DeployedImages": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "SpecifiedImage": {
                  "type": "string"
                },
                "ResolvedImage": {
                  "type": "string"
                }
              }
            }
          },
          "CurrentWeight": {
            "type": "number"
          },
          "DesiredWeight": {
            "type": "number"
          },
          "CurrentInstanceCount": {
            "type": "integer"
          },
          "DesiredInstanceCount": {
            "type": "integer"
          }
        }
      },
      "description": "An array of production variants."
    },
    "CreationTime": {
      "type": "datetime",
      "description": "A timestamp indicating when the endpoint was created."
    },
    "LastModifiedTime": {
      "type": "datetime",
      "description": "A timestamp indicating when the endpoint was last modified."
    },
    "FailureReason": {
      "type": "string",
      "description": "If the status is Failed, the reason it failed."
    }
  }
}