Migration Hub Orchestrator events in EventBridge - AWS Migration Hub Orchestrator
Migration Hub Orchestrator event JSON structure

Migration Hub Orchestrator events in EventBridge

AWS Migration Hub Orchestrator generates status change events through Amazon EventBridge. Migration Hub Orchestrator sends these events to EventBridge as best effort delivery attempts. Events are only delivered to the Region where Migration Hub Orchestrator operations are invoked from. For more information, see What Is Amazon EventBridge? in the EventBridge User Guide.

With EventBridge, you can establish rules that trigger programmatic actions in response to these events. For example, you can create a rule that sends a notification to your email when a workflow requires manual inputs. For more information, see Configure User Notifications for Migration Hub Orchestrator status change events.

Topics

Migration Hub Orchestrator event JSON structure

Events in EventBridge are represented as JSON objects. The fields that are unique to the event are contained in the detail section of the JSON object. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

  • accountId – Your AWS account ID.

  • resourceId – The unique ID of the resource.

    • When the resourceType value is Workflow, the resourceId is in the format of a workflow ID (mw-abcd1234).

    • When the resouceType value is WorkflowStepGroup, the resourceId is in the format of a workflow ID and step group ID (mw-abcd1234#example-step-group).

    • When the resourceType value is WorkflowStep, resourceId is in the format of a workflow ID, step group ID, and step ID (mw-abcd1234#example-step-group#example-step).

    • When the resourceType value is Template, resourceId is in the format of a template ID (template-abcdefghijklmno1234567890).

  • resourceType – The type of resource.

    • Workflow

    • WorkflowStepGroup

    • WorkflowStep

    • Template

  • status – The status of the resource. The available statuses are determined by the resourceType.

    • For the Workflow resource type, see the status values of the GetWorkflow API operation.

    • For the WorkflowStepGroup resource type, see the status values of the GetWorkflowStepGroup API operation.

    • For the WorkflowStep resource type, see the status values of the GetWorkflowStep API operation.

    • For the Template resource type, see the status values of the GetTemplate API operation.

  • timestamp – The timestamp of when Migration Hub Orchestrator emitted an event to EventBridge.

The following example shows a status change event for Migration Hub Orchestrator with the initial workflow status of NOT_STARTED:

{
  "version": "0",
  "id": "12345678-1234-1234-1234-123456789012",
  "detail-type": "Migration Hub Orchestrator Resource Status Changed",
  "source": "aws.migrationhub-orchestrator",
  "account": "123456789012",
  "time": "2020-03-15T15:24:31Z",
  "region": "us-east-1",
  "resources": [],
  "detail": {
    "accountId": "123456789012",
    "resourceId": "mw-abcd123",
    "resourceType": "Workflow",
    "status": "NOT_STARTED",
    "timestamp": "2020-03-15T15:24:31Z"
    "version": "1.0"
  }
}