Amazon Comprehend · JSON Structure

Openapi.Yml Update Endpoint Request Structure

UpdateEndpointRequest schema

Type: object Properties: 5 Required: 1
Machine LearningNatural Language ProcessingNLPText Analysis

UpdateEndpointRequest is a JSON Structure definition published by Amazon Comprehend, describing 5 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

EndpointArn DesiredModelArn DesiredInferenceUnits DesiredDataAccessRoleArn FlywheelArn

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

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-structure/openapi.yml-update-endpoint-request-structure.json",
  "name": "UpdateEndpointRequest",
  "description": "UpdateEndpointRequest schema",
  "type": "object",
  "properties": {
    "EndpointArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComprehendEndpointArn"
        },
        {
          "description": "The Amazon Resource Number (ARN) of the endpoint being updated."
        }
      ]
    },
    "DesiredModelArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComprehendModelArn"
        },
        {
          "description": "The ARN of the new model to use when updating an existing endpoint."
        }
      ]
    },
    "DesiredInferenceUnits": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InferenceUnitsInteger"
        },
        {
          "description": " The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second."
        }
      ]
    },
    "DesiredDataAccessRoleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IamRoleArn"
        },
        {
          "description": "Data access role ARN to use in case the new model is encrypted with a customer CMK."
        }
      ]
    },
    "FlywheelArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComprehendFlywheelArn"
        },
        {
          "description": "The Amazon Resource Number (ARN) of the flywheel"
        }
      ]
    }
  },
  "required": [
    "EndpointArn"
  ]
}