Amazon Marketplace · JSON Structure

Amazon Marketplace Describe Change Set Response Structure

DescribeChangeSetResponse schema from Amazon Marketplace API

Type: object Properties: 9
CommerceISVMarketplaceSoftware Catalog

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

Properties

ChangeSetId ChangeSetArn ChangeSetName StartTime EndTime Status FailureCode FailureDescription ChangeSet

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-describe-change-set-response-structure.json",
  "name": "DescribeChangeSetResponse",
  "description": "DescribeChangeSetResponse schema from Amazon Marketplace API",
  "type": "object",
  "properties": {
    "ChangeSetId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceId"
        },
        {
          "description": "Required. The unique identifier for the change set referenced in this request."
        }
      ]
    },
    "ChangeSetArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ARN"
        },
        {
          "description": "The ARN associated with the unique identifier for the change set referenced in this request."
        }
      ]
    },
    "ChangeSetName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChangeSetName"
        },
        {
          "description": "The optional name provided in the <code>StartChangeSet</code> request. If you do not provide a name, one is set by default."
        }
      ]
    },
    "StartTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DateTimeISO8601"
        },
        {
          "description": "The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started. "
        }
      ]
    },
    "EndTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DateTimeISO8601"
        },
        {
          "description": "The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request transitioned to a terminal state. The change cannot transition to a different state. Null if the request is not in a terminal state. "
        }
      ]
    },
    "Status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChangeStatus"
        },
        {
          "description": "The status of the change request."
        }
      ]
    },
    "FailureCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FailureCode"
        },
        {
          "description": "Returned if the change set is in <code>FAILED</code> status. Can be either <code>CLIENT_ERROR</code>, which means that there are issues with the request (see the <code>ErrorDetailList</code>), or <code>SERVER_FAULT</code>, which means that there is a problem in the system, and you should retry your request."
        }
      ]
    },
    "FailureDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ExceptionMessageContent"
        },
        {
          "description": "Returned if there is a failure on the change set, but that failure is not related to any of the changes in the request."
        }
      ]
    },
    "ChangeSet": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChangeSetDescription"
        },
        {
          "description": "An array of <code>ChangeSummary</code> objects."
        }
      ]
    }
  }
}