Interface: $Properties

v1.PauseActivityExecutionRequest.$Properties

Properties of a PauseActivityExecutionRequest.

Hierarchy

• $Properties

  ↳ IPauseActivityExecutionRequest

Properties

activityId

• Optional activityId: null | string

The ID of the activity to target.

---

identity

• Optional identity: null | string

The identity of the client who initiated this request.

---

namespace

• Optional namespace: null | string

Namespace of the workflow which scheduled this activity.

---

reason

• Optional reason: null | string

Reason to pause the activity.

---

requestId

• Optional requestId: null | string

Used to de-dupe pause requests.

---

resourceId

• Optional resourceId: null | string

Resource ID for routing. Contains "workflow:{workflow_id}" for workflow activities or "activity:{activity_id}" for standalone activities.

---

runId

• Optional runId: null | string

Run ID of the workflow or standalone activity. If empty, targets the latest run.

---

workflowId

• Optional workflowId: null | string

If provided, pause a workflow activity (or activities) for the given workflow ID. If empty, targets a standalone activity.