Amazon Migration Hub · JSON Structure

Migration Hub Api Notify Migration Task State Request Structure

NotifyMigrationTaskStateRequest schema from Amazon Migration Hub API

Type: object Properties: 6 Required: 5
BroadcastingMedia ProcessingMedia

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

Properties

ProgressUpdateStream MigrationTaskName Task UpdateDateTime NextUpdateSeconds DryRun

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-migration-hub/refs/heads/main/json-structure/migration-hub-api-notify-migration-task-state-request-structure.json",
  "name": "NotifyMigrationTaskStateRequest",
  "type": "object",
  "description": "NotifyMigrationTaskStateRequest schema from Amazon Migration Hub API",
  "properties": {
    "ProgressUpdateStream": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProgressUpdateStream"
        },
        {
          "description": "The name of the ProgressUpdateStream. "
        }
      ]
    },
    "MigrationTaskName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MigrationTaskName"
        },
        {
          "description": "Unique identifier that references the migration task. <i>Do not store personal data in this field.</i> "
        }
      ]
    },
    "Task": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Task"
        },
        {
          "description": "Information about the task's progress and status."
        }
      ]
    },
    "UpdateDateTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UpdateDateTime"
        },
        {
          "description": "The timestamp when the task was gathered."
        }
      ]
    },
    "NextUpdateSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NextUpdateSeconds"
        },
        {
          "description": "Number of seconds after the UpdateDateTime within which the Migration Hub can expect an update. If Migration Hub does not receive an update within the specified interval, then the migration task will be considered stale."
        }
      ]
    },
    "DryRun": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DryRun"
        },
        {
          "description": "Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call."
        }
      ]
    }
  },
  "required": [
    "ProgressUpdateStream",
    "MigrationTaskName",
    "Task",
    "UpdateDateTime",
    "NextUpdateSeconds"
  ]
}