Interface: $Properties

v1.DescribeActivityExecutionRequest.$Properties

Properties of a DescribeActivityExecutionRequest.

Hierarchy

• $Properties

  ↳ IDescribeActivityExecutionRequest

Properties

activityId

• Optional activityId: null | string

DescribeActivityExecutionRequest activityId

---

includeHeartbeatDetails

• Optional includeHeartbeatDetails: null | boolean

Include the heartbeat_details field inside info in the response if available.

---

includeInput

• Optional includeInput: null | boolean

Include the input field in the response.

---

includeLastFailure

• Optional includeLastFailure: null | boolean

Include the last_failure field inside info in the response if available.

---

includeOutcome

• Optional includeOutcome: null | boolean

Include the outcome (result/failure) in the response if the activity has completed.

---

longPollToken

• Optional longPollToken: null | Uint8Array

Token from a previous DescribeActivityExecutionResponse. If present, long-poll until activity state changes from the state encoded in this token. If absent, return current state immediately. If present, run_id must also be present. Note that activity state may change multiple times between requests, therefore it is not guaranteed that a client making a sequence of long-poll requests will see a complete sequence of state changes.

---

namespace

• Optional namespace: null | string

DescribeActivityExecutionRequest namespace

---

runId

• Optional runId: null | string

Activity run ID. If empty the request targets the latest run.