Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Note
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .
See also: AWS API Documentation
get-workflow-execution-history is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: events
get-workflow-execution-history
--domain <value>
--execution <value>
[--reverse-order | --no-reverse-order]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
The name of the domain containing the workflow execution.
Specifies the workflow execution for which to return the history.
Shorthand Syntax:
workflowId=string,runId=string
JSON Syntax:
{
"workflowId": "string",
"runId": "string"
}
--reverse-order | --no-reverse-order (boolean)
When set to true , returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.
--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
The size of each page.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination. This NextToken response element should not be used directly outside of the AWS CLI.
--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
events -> (list)
The list of history events.
(structure)
Event within a workflow execution. A history event can be one of these types:
- WorkflowExecutionStarted : The workflow execution was started.
- WorkflowExecutionCompleted : The workflow execution was closed due to successful completion.
- WorkflowExecutionFailed : The workflow execution closed due to a failure.
- WorkflowExecutionTimedOut : The workflow execution was closed because a time out was exceeded.
- WorkflowExecutionCanceled : The workflow execution was successfully canceled and closed.
- WorkflowExecutionTerminated : The workflow execution was terminated.
- WorkflowExecutionContinuedAsNew : The workflow execution was closed and a new execution of the same type was created with the same workflowId.
- WorkflowExecutionCancelRequested : A request to cancel this workflow execution was made.
- DecisionTaskScheduled : A decision task was scheduled for the workflow execution.
- DecisionTaskStarted : The decision task was dispatched to a decider.
- DecisionTaskCompleted : The decider successfully completed a decision task by calling respond-decision-task-completed .
- DecisionTaskTimedOut : The decision task timed out.
- ActivityTaskScheduled : An activity task was scheduled for execution.
- ScheduleActivityTaskFailed : Failed to process ScheduleActivityTask decision. This happens when the decision is not configured properly, for example the activity type specified is not registered.
- ActivityTaskStarted : The scheduled activity task was dispatched to a worker.
- ActivityTaskCompleted : An activity worker successfully completed an activity task by calling respond-activity-task-completed .
- ActivityTaskFailed : An activity worker failed an activity task by calling respond-activity-task-failed .
- ActivityTaskTimedOut : The activity task timed out.
- ActivityTaskCanceled : The activity task was successfully canceled.
- ActivityTaskCancelRequested : A RequestCancelActivityTask decision was received by the system.
- RequestCancelActivityTaskFailed : Failed to process RequestCancelActivityTask decision. This happens when the decision is not configured properly.
- WorkflowExecutionSignaled : An external signal was received for the workflow execution.
- MarkerRecorded : A marker was recorded in the workflow history as the result of a RecordMarker decision.
- TimerStarted : A timer was started for the workflow execution due to a StartTimer decision.
- StartTimerFailed : Failed to process StartTimer decision. This happens when the decision is not configured properly, for example a timer already exists with the specified timer ID.
- TimerFired : A timer, previously started for this workflow execution, fired.
- TimerCanceled : A timer, previously started for this workflow execution, was successfully canceled.
- CancelTimerFailed : Failed to process CancelTimer decision. This happens when the decision is not configured properly, for example no timer exists with the specified timer ID.
- StartChildWorkflowExecutionInitiated : A request was made to start a child workflow execution.
- StartChildWorkflowExecutionFailed : Failed to process StartChildWorkflowExecution decision. This happens when the decision is not configured properly, for example the workflow type specified is not registered.
- ChildWorkflowExecutionStarted : A child workflow execution was successfully started.
- ChildWorkflowExecutionCompleted : A child workflow execution, started by this workflow execution, completed successfully and was closed.
- ChildWorkflowExecutionFailed : A child workflow execution, started by this workflow execution, failed to complete successfully and was closed.
- ChildWorkflowExecutionTimedOut : A child workflow execution, started by this workflow execution, timed out and was closed.
- ChildWorkflowExecutionCanceled : A child workflow execution, started by this workflow execution, was canceled and closed.
- ChildWorkflowExecutionTerminated : A child workflow execution, started by this workflow execution, was terminated.
- SignalExternalWorkflowExecutionInitiated : A request to signal an external workflow was made.
- ExternalWorkflowExecutionSignaled : A signal, requested by this workflow execution, was successfully delivered to the target external workflow execution.
- SignalExternalWorkflowExecutionFailed : The request to signal an external workflow execution failed.
- RequestCancelExternalWorkflowExecutionInitiated : A request was made to request the cancellation of an external workflow execution.
- ExternalWorkflowExecutionCancelRequested : Request to cancel an external workflow execution was successfully delivered to the target execution.
- RequestCancelExternalWorkflowExecutionFailed : Request to cancel an external workflow execution failed.
- LambdaFunctionScheduled : An AWS Lambda function was scheduled for execution.
- LambdaFunctionStarted : The scheduled function was invoked in the AWS Lambda service.
- LambdaFunctionCompleted : The AWS Lambda function successfully completed.
- LambdaFunctionFailed : The AWS Lambda function execution failed.
- LambdaFunctionTimedOut : The AWS Lambda function execution timed out.
- ScheduleLambdaFunctionFailed : Failed to process ScheduleLambdaFunction decision. This happens when the workflow execution does not have the proper IAM role attached to invoke AWS Lambda functions.
- StartLambdaFunctionFailed : Failed to invoke the scheduled function in the AWS Lambda service. This happens when the AWS Lambda service is not available in the current region, or received too many requests.
eventTimestamp -> (timestamp)
The date and time when the event occurred.eventType -> (string)
The type of the history event.eventId -> (long)
The system generated ID of the event. This ID uniquely identifies the event with in the workflow execution history.workflowExecutionStartedEventAttributes -> (structure)
If the event is of type WorkflowExecutionStarted then this member is set and provides detailed information about the event. It is not set for other event types.
input -> (string)
The input provided to the workflow execution (if any).executionStartToCloseTimeout -> (string)
The maximum duration for this workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
taskStartToCloseTimeout -> (string)
The maximum duration of decision tasks for this workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
childPolicy -> (string)
The policy to use for the child workflow executions if this workflow execution is terminated, by calling the terminate-workflow-execution action explicitly or due to an expired timeout.
The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
- ABANDON: no action will be taken. The child executions will continue to run.
taskList -> (structure)
The name of the task list for scheduling the decision tasks for this workflow execution.
name -> (string)
The name of the task list.workflowType -> (structure)
The workflow type of this execution.
name -> (string)
Required. The name of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
version -> (string)
Required. The version of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
tagList -> (list)
The list of tags associated with this workflow execution. An execution can have up to 5 tags.
(string)
taskPriority -> (string)
continuedExecutionRunId -> (string)
If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.parentWorkflowExecution -> (structure)
The source workflow execution that started this workflow execution. The member is not set if the workflow execution was not started by a workflow.
workflowId -> (string)
The user defined identifier associated with the workflow execution.runId -> (string)
A system-generated unique identifier for the workflow execution.parentInitiatedEventId -> (long)
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this workflow execution. The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.lambdaRole -> (string)
The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.workflowExecutionCompletedEventAttributes -> (structure)
If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
result -> (string)
The result produced by the workflow execution upon successful completion.decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.completeWorkflowExecutionFailedEventAttributes -> (structure)
If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
cause -> (string)
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .
decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.workflowExecutionFailedEventAttributes -> (structure)
If the event is of type WorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
reason -> (string)
The descriptive reason provided for the failure (if any).details -> (string)
The details of the failure (if any).decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.failWorkflowExecutionFailedEventAttributes -> (structure)
If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
cause -> (string)
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .
decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.workflowExecutionTimedOutEventAttributes -> (structure)
If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
timeoutType -> (string)
The type of timeout that caused this event.childPolicy -> (string)
The policy used for the child workflow executions of this workflow execution.
The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
- ABANDON: no action will be taken. The child executions will continue to run.
workflowExecutionCanceledEventAttributes -> (structure)
If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
details -> (string)
Details for the cancellation (if any).decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.cancelWorkflowExecutionFailedEventAttributes -> (structure)
If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
cause -> (string)
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .
decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.workflowExecutionContinuedAsNewEventAttributes -> (structure)
If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides detailed information about the event. It is not set for other event types.
input -> (string)
The input provided to the new workflow execution.decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.newExecutionRunId -> (string)
The runId of the new workflow execution.executionStartToCloseTimeout -> (string)
The total duration allowed for the new workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
taskList -> (structure)
Represents a task list.
name -> (string)
The name of the task list.taskPriority -> (string)
taskStartToCloseTimeout -> (string)
The maximum duration of decision tasks for the new workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
childPolicy -> (string)
The policy to use for the child workflow executions of the new execution if it is terminated by calling the terminate-workflow-execution action explicitly or due to an expired timeout.
The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
- ABANDON: no action will be taken. The child executions will continue to run.
tagList -> (list)
The list of tags associated with the new workflow execution.
(string)
workflowType -> (structure)
Represents a workflow type.
name -> (string)
Required. The name of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
version -> (string)
Required. The version of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
lambdaRole -> (string)
The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.continueAsNewWorkflowExecutionFailedEventAttributes -> (structure)
If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
cause -> (string)
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .
decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.workflowExecutionTerminatedEventAttributes -> (structure)
If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed information about the event. It is not set for other event types.
reason -> (string)
The reason provided for the termination (if any).details -> (string)
The details provided for the termination (if any).childPolicy -> (string)
The policy used for the child workflow executions of this workflow execution.
The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
- ABANDON: no action will be taken. The child executions will continue to run.
cause -> (string)
If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.workflowExecutionCancelRequestedEventAttributes -> (structure)
If the event is of type WorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.
externalWorkflowExecution -> (structure)
The external workflow execution for which the cancellation was requested.
workflowId -> (string)
The user defined identifier associated with the workflow execution.runId -> (string)
A system-generated unique identifier for the workflow execution.externalInitiatedEventId -> (long)
The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.cause -> (string)
If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.decisionTaskScheduledEventAttributes -> (structure)
If the event is of type DecisionTaskScheduled then this member is set and provides detailed information about the event. It is not set for other event types.
taskList -> (structure)
The name of the task list in which the decision task was scheduled.
name -> (string)
The name of the task list.taskPriority -> (string)
Optional. A task priority that, if set, specifies the priority for this decision task. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE<PHONE_NUMBER>). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide .
startToCloseTimeout -> (string)
The maximum duration for this decision task. The task is considered timed out if it does not completed within this duration.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
decisionTaskStartedEventAttributes -> (structure)
If the event is of type DecisionTaskStarted then this member is set and provides detailed information about the event. It is not set for other event types.
identity -> (string)
Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined.scheduledEventId -> (long)
The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.decisionTaskCompletedEventAttributes -> (structure)
If the event is of type DecisionTaskCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
executionContext -> (string)
User defined context for the workflow execution.scheduledEventId -> (long)
The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.startedEventId -> (long)
The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.decisionTaskTimedOutEventAttributes -> (structure)
If the event is of type DecisionTaskTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
timeoutType -> (string)
The type of timeout that expired before the decision task could be completed.scheduledEventId -> (long)
The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.startedEventId -> (long)
The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.activityTaskScheduledEventAttributes -> (structure)
If the event is of type ActivityTaskScheduled then this member is set and provides detailed information about the event. It is not set for other event types.
activityType -> (structure)
The type of the activity task.
name -> (string)
The name of this activity.
Note
The combination of activity type name and version must be unique within a domain.
version -> (string)
The version of this activity.
Note
The combination of activity type name and version must be unique with in a domain.
activityId -> (string)
The unique ID of the activity task.input -> (string)
The input provided to the activity task.control -> (string)
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.scheduleToStartTimeout -> (string)
The maximum amount of time the activity task can wait to be assigned to a worker.scheduleToCloseTimeout -> (string)
The maximum amount of time for this activity task.startToCloseTimeout -> (string)
The maximum amount of time a worker may take to process the activity task.taskList -> (structure)
The task list in which the activity task has been scheduled.
name -> (string)
The name of the task list.taskPriority -> (string)
Optional. The priority to assign to the scheduled activity task. If set, this will override any default priority value that was assigned when the activity type was registered.
Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE<PHONE_NUMBER>). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide .
decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.heartbeatTimeout -> (string)
The maximum time before which the worker processing this task must report progress by calling record-activity-task-heartbeat . If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it will be ignored.activityTaskStartedEventAttributes -> (structure)
If the event is of type ActivityTaskStarted then this member is set and provides detailed information about the event. It is not set for other event types.
identity -> (string)
Identity of the worker that was assigned this task. This aids diagnostics when problems arise. The form of this identity is user defined.scheduledEventId -> (long)
The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.activityTaskCompletedEventAttributes -> (structure)
If the event is of type ActivityTaskCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
result -> (string)
The results of the activity task (if any).scheduledEventId -> (long)
The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.startedEventId -> (long)
The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.activityTaskFailedEventAttributes -> (structure)
If the event is of type ActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
reason -> (string)
The reason provided for the failure (if any).details -> (string)
The details of the failure (if any).scheduledEventId -> (long)
The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.startedEventId -> (long)
The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.activityTaskTimedOutEventAttributes -> (structure)
If the event is of type ActivityTaskTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
timeoutType -> (string)
The type of the timeout that caused this event.scheduledEventId -> (long)
The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.startedEventId -> (long)
The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.details -> (string)
Contains the content of the details parameter for the last call made by the activity to record-activity-task-heartbeat .activityTaskCanceledEventAttributes -> (structure)
If the event is of type ActivityTaskCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
details -> (string)
Details of the cancellation (if any).scheduledEventId -> (long)
The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.startedEventId -> (long)
The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.latestCancelRequestedEventId -> (long)
If set, contains the ID of the last ActivityTaskCancelRequested event recorded for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.activityTaskCancelRequestedEventAttributes -> (structure)
If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.
decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.activityId -> (string)
The unique ID of the task.workflowExecutionSignaledEventAttributes -> (structure)
If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed information about the event. It is not set for other event types.
signalName -> (string)
The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal.input -> (string)
Inputs provided with the signal (if any). The decider can use the signal name and inputs to determine how to process the signal.externalWorkflowExecution -> (structure)
The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.
workflowId -> (string)
The user defined identifier associated with the workflow execution.runId -> (string)
A system-generated unique identifier for the workflow execution.externalInitiatedEventId -> (long)
The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflow decision to signal this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. This field is set only if the signal was initiated by another workflow execution.markerRecordedEventAttributes -> (structure)
If the event is of type MarkerRecorded then this member is set and provides detailed information about the event. It is not set for other event types.
markerName -> (string)
The name of the marker.details -> (string)
Details of the marker (if any).decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarker decision that requested this marker. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.recordMarkerFailedEventAttributes -> (structure)
If the event is of type DecisionTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
markerName -> (string)
The marker's name.cause -> (string)
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .
decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarkerFailed decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.timerStartedEventAttributes -> (structure)
If the event is of type TimerStarted then this member is set and provides detailed information about the event. It is not set for other event types.
timerId -> (string)
The unique ID of the timer that was started.control -> (string)
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.startToFireTimeout -> (string)
The duration of time after which the timer will fire.
The duration is specified in seconds; an integer greater than or equal to 0.
decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.timerFiredEventAttributes -> (structure)
If the event is of type TimerFired then this member is set and provides detailed information about the event. It is not set for other event types.
timerId -> (string)
The unique ID of the timer that fired.startedEventId -> (long)
The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.timerCanceledEventAttributes -> (structure)
If the event is of type TimerCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
timerId -> (string)
The unique ID of the timer that was canceled.startedEventId -> (long)
The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.startChildWorkflowExecutionInitiatedEventAttributes -> (structure)
If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.
workflowId -> (string)
The workflowId of the child workflow execution.workflowType -> (structure)
The type of the child workflow execution.
name -> (string)
Required. The name of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
version -> (string)
Required. The version of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
control -> (string)
Optional. Data attached to the event that can be used by the decider in subsequent decision tasks. This data is not sent to the activity.input -> (string)
The inputs provided to the child workflow execution (if any).executionStartToCloseTimeout -> (string)
The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
taskList -> (structure)
The name of the task list used for the decision tasks of the child workflow execution.
name -> (string)
The name of the task list.taskPriority -> (string)
Optional. The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE<PHONE_NUMBER>). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide .
decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.childPolicy -> (string)
The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the terminate-workflow-execution action or due to an expired timeout.
The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
- ABANDON: no action will be taken. The child executions will continue to run.
taskStartToCloseTimeout -> (string)
The maximum duration allowed for the decision tasks for this workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
tagList -> (list)
The list of tags to associated with the child workflow execution.
(string)
lambdaRole -> (string)
The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.childWorkflowExecutionStartedEventAttributes -> (structure)
If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution -> (structure)
The child workflow execution that was started.
workflowId -> (string)
The user defined identifier associated with the workflow execution.runId -> (string)
A system-generated unique identifier for the workflow execution.workflowType -> (structure)
The type of the child workflow execution.
name -> (string)
Required. The name of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
version -> (string)
Required. The version of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
initiatedEventId -> (long)
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.childWorkflowExecutionCompletedEventAttributes -> (structure)
If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution -> (structure)
The child workflow execution that was completed.
workflowId -> (string)
The user defined identifier associated with the workflow execution.runId -> (string)
A system-generated unique identifier for the workflow execution.workflowType -> (structure)
The type of the child workflow execution.
name -> (string)
Required. The name of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
version -> (string)
Required. The version of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
result -> (string)
The result of the child workflow execution (if any).initiatedEventId -> (long)
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.startedEventId -> (long)
The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.childWorkflowExecutionFailedEventAttributes -> (structure)
If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution -> (structure)
The child workflow execution that failed.
workflowId -> (string)
The user defined identifier associated with the workflow execution.runId -> (string)
A system-generated unique identifier for the workflow execution.workflowType -> (structure)
The type of the child workflow execution.
name -> (string)
Required. The name of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
version -> (string)
Required. The version of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
reason -> (string)
The reason for the failure (if provided).details -> (string)
The details of the failure (if provided).initiatedEventId -> (long)
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.startedEventId -> (long)
The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.childWorkflowExecutionTimedOutEventAttributes -> (structure)
If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution -> (structure)
The child workflow execution that timed out.
workflowId -> (string)
The user defined identifier associated with the workflow execution.runId -> (string)
A system-generated unique identifier for the workflow execution.workflowType -> (structure)
The type of the child workflow execution.
name -> (string)
Required. The name of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
version -> (string)
Required. The version of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
timeoutType -> (string)
The type of the timeout that caused the child workflow execution to time out.initiatedEventId -> (long)
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.startedEventId -> (long)
The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.childWorkflowExecutionCanceledEventAttributes -> (structure)
If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution -> (structure)
The child workflow execution that was canceled.
workflowId -> (string)
The user defined identifier associated with the workflow execution.runId -> (string)
A system-generated unique identifier for the workflow execution.workflowType -> (structure)
The type of the child workflow execution.
name -> (string)
Required. The name of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
version -> (string)
Required. The version of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
details -> (string)
Details of the cancellation (if provided).initiatedEventId -> (long)
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.startedEventId -> (long)
The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.childWorkflowExecutionTerminatedEventAttributes -> (structure)
If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution -> (structure)
The child workflow execution that was terminated.
workflowId -> (string)
The user defined identifier associated with the workflow execution.runId -> (string)
A system-generated unique identifier for the workflow execution.workflowType -> (structure)
The type of the child workflow execution.
name -> (string)
Required. The name of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
version -> (string)
Required. The version of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
initiatedEventId -> (long)
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.startedEventId -> (long)
The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.signalExternalWorkflowExecutionInitiatedEventAttributes -> (structure)
If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.
workflowId -> (string)
The workflowId of the external workflow execution.runId -> (string)
The runId of the external workflow execution to send the signal to.signalName -> (string)
The name of the signal.input -> (string)
Input provided to the signal (if any).decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.control -> (string)
Optional. data attached to the event that can be used by the decider in subsequent decision tasks.externalWorkflowExecutionSignaledEventAttributes -> (structure)
If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution -> (structure)
The external workflow execution that the signal was delivered to.
workflowId -> (string)
The user defined identifier associated with the workflow execution.runId -> (string)
A system-generated unique identifier for the workflow execution.initiatedEventId -> (long)
The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.signalExternalWorkflowExecutionFailedEventAttributes -> (structure)
If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
workflowId -> (string)
The workflowId of the external workflow execution that the signal was being delivered to.runId -> (string)
The runId of the external workflow execution that the signal was being delivered to.cause -> (string)
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .
initiatedEventId -> (long)
The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.control -> (string)
externalWorkflowExecutionCancelRequestedEventAttributes -> (structure)
If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.
workflowExecution -> (structure)
The external workflow execution to which the cancellation request was delivered.
workflowId -> (string)
The user defined identifier associated with the workflow execution.runId -> (string)
A system-generated unique identifier for the workflow execution.initiatedEventId -> (long)
The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.requestCancelExternalWorkflowExecutionInitiatedEventAttributes -> (structure)
If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.
workflowId -> (string)
The workflowId of the external workflow execution to be canceled.runId -> (string)
The runId of the external workflow execution to be canceled.decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.control -> (string)
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.requestCancelExternalWorkflowExecutionFailedEventAttributes -> (structure)
If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
workflowId -> (string)
The workflowId of the external workflow to which the cancel request was to be delivered.runId -> (string)
The runId of the external workflow execution.cause -> (string)
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .
initiatedEventId -> (long)
The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.control -> (string)
scheduleActivityTaskFailedEventAttributes -> (structure)
If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
activityType -> (structure)
The activity type provided in the ScheduleActivityTask decision that failed.
name -> (string)
The name of this activity.
Note
The combination of activity type name and version must be unique within a domain.
version -> (string)
The version of this activity.
Note
The combination of activity type name and version must be unique with in a domain.
activityId -> (string)
The activityId provided in the ScheduleActivityTask decision that failed.cause -> (string)
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .
decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.requestCancelActivityTaskFailedEventAttributes -> (structure)
If the event is of type RequestCancelActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.
activityId -> (string)
The activityId provided in the RequestCancelActivityTask decision that failed.cause -> (string)
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .
decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.startTimerFailedEventAttributes -> (structure)
If the event is of type StartTimerFailed then this member is set and provides detailed information about the event. It is not set for other event types.
timerId -> (string)
The timerId provided in the StartTimer decision that failed.cause -> (string)
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .
decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.cancelTimerFailedEventAttributes -> (structure)
If the event is of type CancelTimerFailed then this member is set and provides detailed information about the event. It is not set for other event types.
timerId -> (string)
The timerId provided in the CancelTimer decision that failed.cause -> (string)
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .
decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.startChildWorkflowExecutionFailedEventAttributes -> (structure)
If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.
workflowType -> (structure)
The workflow type provided in the StartChildWorkflowExecution decision that failed.
name -> (string)
Required. The name of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
version -> (string)
Required. The version of the workflow type.
Note
The combination of workflow type name and version must be unique with in a domain.
cause -> (string)
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .
workflowId -> (string)
The workflowId of the child workflow execution.initiatedEventId -> (long)
The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.control -> (string)
lambdaFunctionScheduledEventAttributes -> (structure)
Provides details for the LambdaFunctionScheduled event.
id -> (string)
The unique Amazon SWF ID for the AWS Lambda task.name -> (string)
The name of the scheduled AWS Lambda function.input -> (string)
Input provided to the AWS Lambda function.startToCloseTimeout -> (string)
The maximum time, in seconds, that the AWS Lambda function can take to execute from start to close before it is marked as failed.decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event for the decision that resulted in the scheduling of this AWS Lambda function. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.lambdaFunctionStartedEventAttributes -> (structure)
Provides details for the LambdaFunctionStarted event.
scheduledEventId -> (long)
The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.lambdaFunctionCompletedEventAttributes -> (structure)
Provides details for the LambdaFunctionCompleted event.
scheduledEventId -> (long)
The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.startedEventId -> (long)
The ID of the LambdaFunctionStarted event recorded in the history.result -> (string)
The result of the function execution (if any).lambdaFunctionFailedEventAttributes -> (structure)
Provides details for the LambdaFunctionFailed event.
scheduledEventId -> (long)
The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.startedEventId -> (long)
The ID of the LambdaFunctionStarted event recorded in the history.reason -> (string)
The reason provided for the failure (if any).details -> (string)
The details of the failure (if any).lambdaFunctionTimedOutEventAttributes -> (structure)
Provides details for the LambdaFunctionTimedOut event.
scheduledEventId -> (long)
The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.startedEventId -> (long)
The ID of the LambdaFunctionStarted event recorded in the history.timeoutType -> (string)
The type of the timeout that caused this event.scheduleLambdaFunctionFailedEventAttributes -> (structure)
Provides details for the ScheduleLambdaFunctionFailed event.
id -> (string)
The unique Amazon SWF ID of the AWS Lambda task.name -> (string)
The name of the scheduled AWS Lambda function.cause -> (string)
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .
decisionTaskCompletedEventId -> (long)
The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this AWS Lambda function. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.startLambdaFunctionFailedEventAttributes -> (structure)
Provides details for the StartLambdaFunctionFailed event.
scheduledEventId -> (long)
The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.cause -> (string)
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Note
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .
message -> (string)
The error message (if any).
nextPageToken -> (string)
If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken . Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.


Sergiu Bodiu
Java Consultant at Bank of America
Seasoned consultant experienced in large-scale e-commerce projects, passionate about
providing innovative technology solutions to solve complex business problems, have extensive knowledge and
experience delivering enterprise wide applications. He is skilled in software design, data modeling,
stakeholder management, IT strategic planning, technical know-how and security. Able to design, implement,
test and maintain software product components with strong focus on design elegance and software reuse.
|
Sergiu Bodiu
Java Consultant at Bank of America
Seasoned consultant experienced in large-scale e-commerce projects, passionate about
providing innovative technology solutions to solve complex business problems, have extensive knowledge and
experience delivering enterprise wide applications. He is skilled in software design, data modeling,
stakeholder management, IT strategic planning, technical know-how and security. Able to design, implement,
test and maintain software product components with strong focus on design elegance and software reuse.
|


{% extends "tric/base.html" %} {% load staticfiles %} {% block title %} {{ title }} {% endblock %} {% block content %}
The TRIC refers to "tRNA in cancers". Transfer RNAs (tRNAs) play essential roles in tumorigenesis. The database tRNA in Cancer (TRIC) show the dynamic landscape of tRNAs expression across 31 cancer types and more than 10000 samples from The Cancer Genome Atlas (TCGA). Here we systematically analyzed tRNA expression profiles at gene, codon and amino acid levels and the functional consequence (e.g. patient tumor stage, subtype, and survival). We also try to connect the differentially expression of tRNA and the translational control in tumor.


Plugin Information |
|---|
View Run Selector on the plugin site for more information. |
This plugin allows selecting a Run based on specific parameters.
Documentation
The plugin documentation may be found on the GitHub README page.
Plugin Information |
|---|
View Run Selector on the plugin site for more information. |
This plugin allows selecting a Run based on specific parameters.
The plugin documentation may be found on the GitHub README page.


--- title: Razor Sales Move Online, Away From Gillette date: '2015-07-05T07:58:36+05:30' tags: - business tumblr_url: https://sureshshanmugam.com/post/123247608159/razor-sales-move-online-away-from-gillette ---
The online market for razorblades barely existed a few years ago, yet Americans have taken to it quickly: Web sales of men’s shaving gear in the U.S. have nearly doubled in the 12 months through May to $263 million, according to estimates from Slice Intelligence, a market research firm.
That is about 8% of the roughly $3 billion market and a big surprise to people who follow the market.


The objective of this game is to catch all the fish and feed it to the baby. You can only catch one fish at a time
Commands
| W | ||
| A | D |
Press Trained Model to see the penguin trained on reinforcement learning
Acknowledgements: this game was based off ImmersiveLimit's tutorial


HOUSE OF COLORS
HOME
CATEGORIES
CART
ABOUT US
CONTACT US
REGISTER
LOGIN
ACRYLIC PAINTINGS
HIMALAYAS-1
LAKEVIEW-1
SCENERY-1


[gecode-users] Optimization in GECODE
Christian Schulte
schulte at imit.kth.se
Mon Oct 2 11:54:34 CEST 2006
Hi,
I am sorry but I have to admit that I do not understand your question. Could
you please try to rephrase?
Thanks
Christian
--
Christian Schulte, http://www.imit.kth.se/~schulte/
-----Original Message-----
From: users-bounces at gecode.org [mailto:users-bounces at gecode.org] On Behalf
Of Dhananjay Thiruvady
Sent: Thursday, September 28, 2006 4:06 AM
To: users at gecode.org
Subject: [gecode-users] Optimization in GECODE
Hi all,
I'm implementing a scheduling problem with start (s), duration (d), end(e),
setup times, for n jobs. I would like to find the minimum scheduling time
from s[0] to s[n-1] and e[0] to e[n-1]. I have set it up such that e[n-1]
contains the largest time point and I have attempted BAB with constrain to
minimize e[n-1]. I realize that this only attempts different values for
e[n-1] and does not try different branchings for the s and e variables. How
can I do this, i.e., try different branchings to find a minimum?
Regards,
Dhananjay
_______________________________________________
Gecode users mailing list
users at gecode.org https://www.gecode.org/mailman/listinfo/gecode-users
More information about the gecode-users
mailing list


[0x|0n|0o] digit_string
Description
The number operand is used in address expressions and to specify counts in commands.
Ox Specifies that digit_string is hexadecimal (base 16), regardless of the context.
On Specifies that digit_string is decimal, regardless of the context.
Oo Specifies that digit_string is octal (base 8), regardless of the context.
digit_string A series of digits in the specified radix, or the default radix for the context in which number appears.
The default number base is hexadecimal for addr and mask, elsewhere it is decimal. If there is a conflict between a hexadecimal number and a register name or symbolic name, the 0x base must be explicitly provided.
| Note | |
|
Unlike standard “C” notation, a leading zero does not specify octal. |
|
0o377 == 0ff == 0xff == 0n255 == 255


|
ActiveTcl User Guide
|
||
Tcl_OpenFileChannel, Tcl_OpenCommandChannel, Tcl_MakeFileChannel, Tcl_GetChannel, Tcl_GetChannelNames, Tcl_GetChannelNamesEx, Tcl_RegisterChannel, Tcl_UnregisterChannel, Tcl_DetachChannel, Tcl_IsStandardChannel, Tcl_Close, Tcl_ReadChars, Tcl_Read, Tcl_GetsObj, Tcl_Gets, Tcl_WriteObj, Tcl_WriteChars, Tcl_Write, Tcl_Flush, Tcl_Seek, Tcl_Tell, Tcl_GetChannelOption, Tcl_SetChannelOption, Tcl_Eof, Tcl_InputBlocked, Tcl_InputBuffered, Tcl_OutputBuffered, Tcl_Ungets, Tcl_ReadRaw, Tcl_WriteRaw - buffered I/O facilities using channels
#include <tcl.h>
Tcl_Channel
Tcl_OpenFileChannel(interp, fileName, mode,
permissions)
Tcl_Channel
Tcl_OpenCommandChannel(interp, argc, argv, flags)
Tcl_Channel
Tcl_MakeFileChannel(handle, readOrWrite)
Tcl_Channel
Tcl_GetChannel(interp, channelName, modePtr)
int
Tcl_GetChannelNames(interp)
int
Tcl_GetChannelNamesEx(interp, pattern)
void
Tcl_RegisterChannel(interp, channel)
int
Tcl_UnregisterChannel(interp, channel)
int
Tcl_DetachChannel(interp, channel)
int
Tcl_IsStandardChannel(channel)
int
Tcl_Close(interp, channel)
int
Tcl_ReadChars(channel, readObjPtr, charsToRead,
appendFlag)
int
Tcl_Read(channel, readBuf, bytesToRead)
int
Tcl_GetsObj(channel, lineObjPtr)
int
Tcl_Gets(channel, lineRead)
int
Tcl_Ungets(channel, input, inputLen, addAtEnd)
int
Tcl_WriteObj(channel, writeObjPtr)
int
Tcl_WriteChars(channel, charBuf, bytesToWrite)
int
Tcl_Write(channel, byteBuf, bytesToWrite)
int
Tcl_ReadRaw(channel, readBuf, bytesToRead)
int
Tcl_WriteRaw(channel, byteBuf, bytesToWrite)
int
Tcl_Eof(channel)
int
Tcl_Flush(channel)
int
Tcl_InputBlocked(channel)
int
Tcl_InputBuffered(channel)
int
Tcl_OutputBuffered(channel)
int
Tcl_Seek(channel, offset, seekMode)
int
Tcl_Tell(channel)
int
Tcl_GetChannelOption(interp, channel, optionName,
optionValue)
int
Tcl_SetChannelOption(interp, channel, optionName,
newValue)
The Tcl channel mechanism provides a device-independent and platform-independent mechanism for performing buffered input and output operations on a variety of file, socket, and device types. The channel mechanism is extensible to new channel types, by providing a low level channel driver for the new type; the channel driver interface is described in the manual entry for Tcl_CreateChannel. The channel mechanism provides a buffering scheme modeled after Unix's standard I/O, and it also allows for nonblocking I/O on channels.
The procedures described in this manual entry comprise the C APIs of the generic layer of the channel architecture. For a description of the channel driver architecture and how to implement channel drivers for new types of channels, see the manual entry for Tcl_CreateChannel.
Tcl_OpenFileChannel opens a file specified by fileName and returns a channel handle that can be used to perform input and output on the file. This API is modeled after the fopen procedure of the Unix standard I/O library. The syntax and meaning of all arguments is similar to those given in the Tcl open command when opening a file. If an error occurs while opening the channel, Tcl_OpenFileChannel returns NULL and records a POSIX error code that can be retrieved with Tcl_GetErrno. In addition, if interp is non-NULL, Tcl_OpenFileChannel leaves an error message in interp's result after any error. As of Tcl 8.4, the object-based API Tcl_FSOpenFileChannel should be used in preference to Tcl_OpenFileChannel wherever possible.
The newly created channel is not registered in the supplied interpreter; to register it, use Tcl_RegisterChannel, described below. If one of the standard channels, stdin, stdout or stderr was previously closed, the act of creating the new channel also assigns it as a replacement for the standard channel.
Tcl_OpenCommandChannel provides a C-level interface to the functions of the exec and open commands. It creates a sequence of subprocesses specified by the argv and argc arguments and returns a channel that can be used to communicate with these subprocesses. The flags argument indicates what sort of communication will exist with the command pipeline.
If the TCL_STDIN flag is set then the standard input for the first subprocess will be tied to the channel: writing to the channel will provide input to the subprocess. If TCL_STDIN is not set, then standard input for the first subprocess will be the same as this application's standard input. If TCL_STDOUT is set then standard output from the last subprocess can be read from the channel; otherwise it goes to this application's standard output. If TCL_STDERR is set, standard error output for all subprocesses is returned to the channel and results in an error when the channel is closed; otherwise it goes to this application's standard error. If TCL_ENFORCE_MODE is not set, then argc and argv can redirect the stdio handles to override TCL_STDIN, TCL_STDOUT, and TCL_STDERR; if it is set, then it is an error for argc and argv to override stdio channels for which TCL_STDIN, TCL_STDOUT, and TCL_STDERR have been set.
If an error occurs while opening the channel, Tcl_OpenCommandChannel returns NULL and records a POSIX error code that can be retrieved with Tcl_GetErrno. In addition, Tcl_OpenCommandChannel leaves an error message in the interpreter's result if interp is not NULL.
The newly created channel is not registered in the supplied interpreter; to register it, use Tcl_RegisterChannel, described below. If one of the standard channels, stdin, stdout or stderr was previously closed, the act of creating the new channel also assigns it as a replacement for the standard channel.
Tcl_MakeFileChannel makes a Tcl_Channel from an existing, platform-specific, file handle. The newly created channel is not registered in the supplied interpreter; to register it, use Tcl_RegisterChannel, described below. If one of the standard channels, stdin, stdout or stderr was previously closed, the act of creating the new channel also assigns it as a replacement for the standard channel.
Tcl_GetChannel returns a channel given the channelName used to create it with Tcl_CreateChannel and a pointer to a Tcl interpreter in interp. If a channel by that name is not registered in that interpreter, the procedure returns NULL. If the modePtr argument is not NULL, it points at an integer variable that will receive an OR-ed combination of TCL_READABLE and TCL_WRITABLE describing whether the channel is open for reading and writing.
Tcl_GetChannelNames and Tcl_GetChannelNamesEx write the names of the registered channels to the interpreter's result as a list object. Tcl_GetChannelNamesEx will filter these names according to the pattern. If pattern is NULL, then it will not do any filtering. The return value is TCL_OK if no errors occurred writing to the result, otherwise it is TCL_ERROR, and the error message is left in the interpreter's result.
Tcl_RegisterChannel adds a channel to the set of channels accessible in interp. After this call, Tcl programs executing in that interpreter can refer to the channel in input or output operations using the name given in the call to Tcl_CreateChannel. After this call, the channel becomes the property of the interpreter, and the caller should not call Tcl_Close for the channel; the channel will be closed automatically when it is unregistered from the interpreter.
Code executing outside of any Tcl interpreter can call Tcl_RegisterChannel with interp as NULL, to indicate that it wishes to hold a reference to this channel. Subsequently, the channel can be registered in a Tcl interpreter and it will only be closed when the matching number of calls to Tcl_UnregisterChannel have been made. This allows code executing outside of any interpreter to safely hold a reference to a channel that is also registered in a Tcl interpreter.
This procedure interacts with the code managing the standard channels. If no standard channels were initialized before the first call to Tcl_RegisterChannel they will get initialized by that call. See Tcl_StandardChannels for a general treatise about standard channels and the behaviour of the Tcl library with regard to them.
Tcl_UnregisterChannel removes a channel from the set of channels accessible in interp. After this call, Tcl programs will no longer be able to use the channel's name to refer to the channel in that interpreter. If this operation removed the last registration of the channel in any interpreter, the channel is also closed and destroyed.
Code not associated with a Tcl interpreter can call Tcl_UnregisterChannel with interp as NULL, to indicate to Tcl that it no longer holds a reference to that channel. If this is the last reference to the channel, it will now be closed. Tcl_UnregisterChannel is very similar to Tcl_DetachChannel except that it will also close the channel if no further references to it exist.
Tcl_DetachChannel removes a channel from the set of channels accessible in interp. After this call, Tcl programs will no longer be able to use the channel's name to refer to the channel in that interpreter. Beyond that, this command has no further effect. It cannot be used on the standard channels (stdout, stderr, stdin), and will return TCL_ERROR if passed one of those channels.
Code not associated with a Tcl interpreter can call Tcl_DetachChannel with interp as NULL, to indicate to Tcl that it no longer holds a reference to that channel. If this is the last reference to the channel, unlike Tcl_UnregisterChannel, it will not be closed.
Tcl_IsStandardChannel tests whether a channel is one of the three standard channels, stdin, stdout or stderr. If so, it returns 1, otherwise 0.
No attempt is made to check whether the given channel or the standard channels are initialized or otherwise valid.
Tcl_Close destroys the channel channel, which must denote a currently open channel. The channel should not be registered in any interpreter when Tcl_Close is called. Buffered output is flushed to the channel's output device prior to destroying the channel, and any buffered input is discarded. If this is a blocking channel, the call does not return until all buffered data is successfully sent to the channel's output device. If this is a nonblocking channel and there is buffered output that cannot be written without blocking, the call returns immediately; output is flushed in the background and the channel will be closed once all of the buffered data has been output. In this case errors during flushing are not reported.
If the channel was closed successfully, Tcl_Close returns TCL_OK. If an error occurs, Tcl_Close returns TCL_ERROR and records a POSIX error code that can be retrieved with Tcl_GetErrno. If the channel is being closed synchronously and an error occurs during closing of the channel and interp is not NULL, an error message is left in the interpreter's result.
Note: it is not safe to call Tcl_Close on a channel that has been registered using Tcl_RegisterChannel; see the documentation for Tcl_RegisterChannel, above, for details. If the channel has ever been given as the chan argument in a call to Tcl_RegisterChannel, you should instead use Tcl_UnregisterChannel, which will internally call Tcl_Close when all calls to Tcl_RegisterChannel have been matched by corresponding calls to Tcl_UnregisterChannel.
Tcl_ReadChars consumes bytes from channel, converting the bytes to UTF-8 based on the channel's encoding and storing the produced data in readObjPtr's string representation. The return value of Tcl_ReadChars is the number of characters, up to charsToRead, that were stored in readObjPtr. If an error occurs while reading, the return value is -1 and Tcl_ReadChars records a POSIX error code that can be retrieved with Tcl_GetErrno.
The return value may be smaller than the value to read, indicating that less data than requested was available. This is called a short read. In blocking mode, this can only happen on an end-of-file. In nonblocking mode, a short read can also occur if there is not enough input currently available: Tcl_ReadChars returns a short count rather than waiting for more data.
If the channel is in blocking mode, a return value of zero indicates an end-of-file condition. If the channel is in nonblocking mode, a return value of zero indicates either that no input is currently available or an end-of-file condition. Use Tcl_Eof and Tcl_InputBlocked to tell which of these conditions actually occurred.
Tcl_ReadChars translates the various end-of-line representations into the canonical \n internal representation according to the current end-of-line recognition mode. End-of-line recognition and the various platform-specific modes are described in the manual entry for the Tcl fconfigure command.
As a performance optimization, when reading from a channel with the encoding binary, the bytes are not converted to UTF-8 as they are read. Instead, they are stored in readObjPtr's internal representation as a byte-array object. The string representation of this object will only be constructed if it is needed (e.g., because of a call to Tcl_GetStringFromObj). In this way, byte-oriented data can be read from a channel, manipulated by calling Tcl_GetByteArrayFromObj and related functions, and then written to a channel without the expense of ever converting to or from UTF-8.
Tcl_Read is similar to Tcl_ReadChars, except that it doesn't do encoding conversions, regardless of the channel's encoding. It is deprecated and exists for backwards compatibility with non-internationalized Tcl extensions. It consumes bytes from channel and stores them in readBuf, performing end-of-line translations on the way. The return value of Tcl_Read is the number of bytes, up to bytesToRead, written in readBuf. The buffer produced by Tcl_Read is not NULL terminated. Its contents are valid from the zeroth position up to and excluding the position indicated by the return value.
Tcl_ReadRaw is the same as Tcl_Read but does not compensate for stacking. While Tcl_Read (and the other functions in the API) always get their data from the topmost channel in the stack the supplied channel is part of, Tcl_ReadRaw does not. Thus this function is only usable for transformational channel drivers, i.e. drivers used in the middle of a stack of channels, to move data from the channel below into the transformation.
Tcl_GetsObj consumes bytes from channel, converting the bytes to UTF-8 based on the channel's encoding, until a full line of input has been seen. If the channel's encoding is binary, each byte read from the channel is treated as an individual Unicode character. All of the characters of the line except for the terminating end-of-line character(s) are appended to lineObjPtr's string representation. The end-of-line character(s) are read and discarded.
If a line was successfully read, the return value is greater than or equal to zero and indicates the number of bytes stored in lineObjPtr. If an error occurs, Tcl_GetsObj returns -1 and records a POSIX error code that can be retrieved with Tcl_GetErrno. Tcl_GetsObj also returns -1 if the end of the file is reached; the Tcl_Eof procedure can be used to distinguish an error from an end-of-file condition.
If the channel is in nonblocking mode, the return value can also be -1 if no data was available or the data that was available did not contain an end-of-line character. When -1 is returned, the Tcl_InputBlocked procedure may be invoked to determine if the channel is blocked because of input unavailability.
Tcl_Gets is the same as Tcl_GetsObj except the resulting characters are appended to the dynamic string given by lineRead rather than a Tcl object.
Tcl_Ungets is used to add data to the input queue of a channel, at either the head or tail of the queue. The pointer input points to the data that is to be added. The length of the input to add is given by inputLen. A non-zero value of addAtEnd indicates that the data is to be added at the end of queue; otherwise it will be added at the head of the queue. If channel has a "sticky" EOF set, no data will be added to the input queue. Tcl_Ungets returns inputLen or -1 if an error occurs.
Tcl_WriteChars accepts bytesToWrite bytes of character data at charBuf. The UTF-8 characters in the buffer are converted to the channel's encoding and queued for output to channel. If bytesToWrite is negative, Tcl_WriteChars expects charBuf to be NULL terminated and it outputs everything up to the NULL.
Data queued for output may not appear on the output device immediately, due to internal buffering. If the data should appear immediately, call Tcl_Flush after the call to Tcl_WriteChars, or set the -buffering option on the channel to none. If you wish the data to appear as soon as a complete line is accepted for output, set the -buffering option on the channel to line mode.
The return value of Tcl_WriteChars is a count of how many bytes were accepted for output to the channel. This is either greater than zero to indicate success or -1 to indicate that an error occurred. If an error occurs, Tcl_WriteChars records a POSIX error code that may be retrieved with Tcl_GetErrno.
Newline characters in the output data are translated to platform-specific end-of-line sequences according to the -translation option for the channel. This is done even if the channel has no encoding.
Tcl_WriteObj is similar to Tcl_WriteChars except it accepts a Tcl object whose contents will be output to the channel. The UTF-8 characters in writeObjPtr's string representation are converted to the channel's encoding and queued for output to channel. As a performance optimization, when writing to a channel with the encoding binary, UTF-8 characters are not converted as they are written. Instead, the bytes in writeObjPtr's internal representation as a byte-array object are written to the channel. The byte-array representation of the object will be constructed if it is needed. In this way, byte-oriented data can be read from a channel, manipulated by calling Tcl_GetByteArrayFromObj and related functions, and then written to a channel without the expense of ever converting to or from UTF-8.
Tcl_Write is similar to Tcl_WriteChars except that it doesn't do encoding conversions, regardless of the channel's encoding. It is deprecated and exists for backwards compatibility with non-internationalized Tcl extensions. It accepts bytesToWrite bytes of data at byteBuf and queues them for output to channel. If bytesToWrite is negative, Tcl_Write expects byteBuf to be NULL terminated and it outputs everything up to the NULL.
Tcl_WriteRaw is the same as Tcl_Write but does not compensate for stacking. While Tcl_Write (and the other functions in the API) always feed their input to the topmost channel in the stack the supplied channel is part of, Tcl_WriteRaw does not. Thus this function is only usable for transformational channel drivers, i.e. drivers used in the middle of a stack of channels, to move data from the transformation into the channel below it.
Tcl_Flush causes all of the buffered output data for channel to be written to its underlying file or device as soon as possible. If the channel is in blocking mode, the call does not return until all the buffered data has been sent to the channel or some error occurred. The call returns immediately if the channel is nonblocking; it starts a background flush that will write the buffered data to the channel eventually, as fast as the channel is able to absorb it.
The return value is normally TCL_OK. If an error occurs, Tcl_Flush returns TCL_ERROR and records a POSIX error code that can be retrieved with Tcl_GetErrno.
Tcl_Seek moves the access point in channel where subsequent data will be read or written. Buffered output is flushed to the channel and buffered input is discarded, prior to the seek operation.
Tcl_Seek normally returns the new access point. If an error occurs, Tcl_Seek returns -1 and records a POSIX error code that can be retrieved with Tcl_GetErrno. After an error, the access point may or may not have been moved.
Tcl_Tell returns the current access point for a channel. The returned value is -1 if the channel does not support seeking.
Tcl_GetChannelOption retrieves, in optionValue, the value of one of the options currently in effect for a channel, or a list of all options and their values. The channel argument identifies the channel for which to query an option or retrieve all options and their values. If optionName is not NULL, it is the name of the option to query; the option's value is copied to the Tcl dynamic string denoted by optionValue. If optionName is NULL, the function stores an alternating list of option names and their values in optionValue, using a series of calls to Tcl_DStringAppendElement. The various preexisting options and their possible values are described in the manual entry for the Tcl fconfigure command. Other options can be added by each channel type. These channel type specific options are described in the manual entry for the Tcl command that creates a channel of that type; for example, the additional options for TCP based channels are described in the manual entry for the Tcl socket command. The procedure normally returns TCL_OK. If an error occurs, it returns TCL_ERROR and calls Tcl_SetErrno to store an appropriate POSIX error code.
Tcl_SetChannelOption sets a new value newValue for an option optionName on channel. The procedure normally returns TCL_OK. If an error occurs, it returns TCL_ERROR; in addition, if interp is non-NULL, Tcl_SetChannelOption leaves an error message in the interpreter's result.
Tcl_Eof returns a nonzero value if channel encountered an end of file during the last input operation.
Tcl_InputBlocked returns a nonzero value if channel is in nonblocking mode and the last input operation returned less data than requested because there was insufficient data available. The call always returns zero if the channel is in blocking mode.
Tcl_InputBuffered returns the number of bytes of input currently buffered in the internal buffers for a channel. If the channel is not open for reading, this function always returns zero.
Tcl_OutputBuffered returns the number of bytes of output currently buffered in the internal buffers for a channel. If the channel is not open for writing, this function always returns zero.
The handles returned from Tcl_GetChannelHandle depend on the platform and the channel type. On Unix platforms, the handle is always a Unix file descriptor as returned from the open system call. On Windows platforms, the handle is a file HANDLE when the channel was created with Tcl_OpenFileChannel, Tcl_OpenCommandChannel, or Tcl_MakeFileChannel. Other channel types may return a different type of handle on Windows platforms. On the Macintosh platform, the handle is a file reference number as returned from HOpenDF.
DString, fconfigure, filename, fopen, Tcl_CreateChannel
access point, blocking, buffered I/O, channel, channel driver, end of file, flush, input, nonblocking, output, read, seek, write
Copyright © 1996-1997 Sun Microsystems, Inc. Copyright © 1995-1997 Roger E. Critchlow Jr.