Amazon Snow Family · JSON Structure

Amazon Snow Family Cluster List Entry Structure

Contains a cluster's state, a cluster's ID, and other important information.

Type: object Properties: 4
Data MigrationEdge ComputingOffline TransferPhysical Appliance

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

Properties

ClusterId ClusterState CreationDate Description

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

JSON Structure

Raw ↑
{
  "type": "object",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-snow-family/refs/heads/main/json-structure/amazon-snow-family-cluster-list-entry-structure.json",
  "name": "ClusterListEntry",
  "description": "Contains a cluster's state, a cluster's ID, and other important information.",
  "properties": {
    "ClusterId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The 39-character ID for the cluster that you want to list, for example <code>CID123e4567-e89b-12d3-a456-426655440000</code>."
        }
      ]
    },
    "ClusterState": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClusterState"
        },
        {
          "description": "The current state of this cluster. For information about the state of a specific node, see <a>JobListEntry$JobState</a>."
        }
      ]
    },
    "CreationDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The creation date for this cluster."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "Defines an optional description of the cluster, for example <code>Environmental Data Cluster-01</code>."
        }
      ]
    }
  }
}