Amazon Marketplace · JSON Structure

Amazon Marketplace Change Structure

An object that contains the ChangeType, Details, and Entity.

Type: object Properties: 5 Required: 3
CommerceISVMarketplaceSoftware Catalog

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

Properties

ChangeType Entity EntityTags Details ChangeName

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-marketplace/refs/heads/main/json-structure/amazon-marketplace-change-structure.json",
  "name": "Change",
  "description": "An object that contains the <code>ChangeType</code>, <code>Details</code>, and <code>Entity</code>.",
  "type": "object",
  "properties": {
    "ChangeType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChangeType"
        },
        {
          "description": "Change types are single string values that describe your intention for the change. Each change type is unique for each <code>EntityType</code> provided in the change's scope. For more information on change types available for single-AMI products, see <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/ami-products.html#working-with-single-AMI-products\">Working with single-AMI products</a>. Also, for more information on change types available for container-based products, see <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/container-products.html#working-with-container-products\">Working with container products</a>."
        }
      ]
    },
    "Entity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Entity"
        },
        {
          "description": "The entity to be changed."
        }
      ]
    },
    "EntityTags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagList"
        },
        {
          "description": "The tags associated with the change."
        }
      ]
    },
    "Details": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Json"
        },
        {
          "description": "This object contains details specific to the change type of the requested change. For more information on change types available for single-AMI products, see <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/ami-products.html#working-with-single-AMI-products\">Working with single-AMI products</a>. Also, for more information on change types available for container-based products, see <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/container-products.html#working-with-container-products\">Working with container products</a>."
        }
      ]
    },
    "ChangeName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChangeName"
        },
        {
          "description": "Optional name for the change."
        }
      ]
    }
  },
  "required": [
    "ChangeType",
    "Entity",
    "Details"
  ]
}