Skip to main content

Interface: $Properties

Properties of a DescribeActivityExecutionRequest.

Extended by​

Properties​

activityId?​

optional activityId?: string | null

DescribeActivityExecutionRequest activityId

includeHeartbeatDetails?​

optional includeHeartbeatDetails?: boolean | null

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

includeInput?​

optional includeInput?: boolean | null

Include the input field in the response.

includeLastFailure?​

optional includeLastFailure?: boolean | null

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

includeOutcome?​

optional includeOutcome?: boolean | null

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

longPollToken?​

optional longPollToken?: Uint8Array<ArrayBufferLike> | null

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?: string | null

DescribeActivityExecutionRequest namespace

runId?​

optional runId?: string | null

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