swf

package
v1.13.35 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 23, 2018 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package swf provides the client and types for making API requests to Amazon Simple Workflow Service.

The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.

Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.

This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide (http://docs.aws.amazon.com/amazonswf/latest/developerguide/).

See swf package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/swf/

Using the Client

To contact Amazon Simple Workflow Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Simple Workflow Service client SWF for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/swf/#New

Index

Constants

View Source
const (
	// ActivityTaskTimeoutTypeStartToClose is a ActivityTaskTimeoutType enum value
	ActivityTaskTimeoutTypeStartToClose = "START_TO_CLOSE"

	// ActivityTaskTimeoutTypeScheduleToStart is a ActivityTaskTimeoutType enum value
	ActivityTaskTimeoutTypeScheduleToStart = "SCHEDULE_TO_START"

	// ActivityTaskTimeoutTypeScheduleToClose is a ActivityTaskTimeoutType enum value
	ActivityTaskTimeoutTypeScheduleToClose = "SCHEDULE_TO_CLOSE"

	// ActivityTaskTimeoutTypeHeartbeat is a ActivityTaskTimeoutType enum value
	ActivityTaskTimeoutTypeHeartbeat = "HEARTBEAT"
)
View Source
const (
	// CancelTimerFailedCauseTimerIdUnknown is a CancelTimerFailedCause enum value
	CancelTimerFailedCauseTimerIdUnknown = "TIMER_ID_UNKNOWN"

	// CancelTimerFailedCauseOperationNotPermitted is a CancelTimerFailedCause enum value
	CancelTimerFailedCauseOperationNotPermitted = "OPERATION_NOT_PERMITTED"
)
View Source
const (
	// CancelWorkflowExecutionFailedCauseUnhandledDecision is a CancelWorkflowExecutionFailedCause enum value
	CancelWorkflowExecutionFailedCauseUnhandledDecision = "UNHANDLED_DECISION"

	// CancelWorkflowExecutionFailedCauseOperationNotPermitted is a CancelWorkflowExecutionFailedCause enum value
	CancelWorkflowExecutionFailedCauseOperationNotPermitted = "OPERATION_NOT_PERMITTED"
)
View Source
const (
	// ChildPolicyTerminate is a ChildPolicy enum value
	ChildPolicyTerminate = "TERMINATE"

	// ChildPolicyRequestCancel is a ChildPolicy enum value
	ChildPolicyRequestCancel = "REQUEST_CANCEL"

	// ChildPolicyAbandon is a ChildPolicy enum value
	ChildPolicyAbandon = "ABANDON"
)
View Source
const (
	// CloseStatusCompleted is a CloseStatus enum value
	CloseStatusCompleted = "COMPLETED"

	// CloseStatusFailed is a CloseStatus enum value
	CloseStatusFailed = "FAILED"

	// CloseStatusCanceled is a CloseStatus enum value
	CloseStatusCanceled = "CANCELED"

	// CloseStatusTerminated is a CloseStatus enum value
	CloseStatusTerminated = "TERMINATED"

	// CloseStatusContinuedAsNew is a CloseStatus enum value
	CloseStatusContinuedAsNew = "CONTINUED_AS_NEW"

	// CloseStatusTimedOut is a CloseStatus enum value
	CloseStatusTimedOut = "TIMED_OUT"
)
View Source
const (
	// CompleteWorkflowExecutionFailedCauseUnhandledDecision is a CompleteWorkflowExecutionFailedCause enum value
	CompleteWorkflowExecutionFailedCauseUnhandledDecision = "UNHANDLED_DECISION"

	// CompleteWorkflowExecutionFailedCauseOperationNotPermitted is a CompleteWorkflowExecutionFailedCause enum value
	CompleteWorkflowExecutionFailedCauseOperationNotPermitted = "OPERATION_NOT_PERMITTED"
)
View Source
const (
	// ContinueAsNewWorkflowExecutionFailedCauseUnhandledDecision is a ContinueAsNewWorkflowExecutionFailedCause enum value
	ContinueAsNewWorkflowExecutionFailedCauseUnhandledDecision = "UNHANDLED_DECISION"

	// ContinueAsNewWorkflowExecutionFailedCauseWorkflowTypeDeprecated is a ContinueAsNewWorkflowExecutionFailedCause enum value
	ContinueAsNewWorkflowExecutionFailedCauseWorkflowTypeDeprecated = "WORKFLOW_TYPE_DEPRECATED"

	// ContinueAsNewWorkflowExecutionFailedCauseWorkflowTypeDoesNotExist is a ContinueAsNewWorkflowExecutionFailedCause enum value
	ContinueAsNewWorkflowExecutionFailedCauseWorkflowTypeDoesNotExist = "WORKFLOW_TYPE_DOES_NOT_EXIST"

	// ContinueAsNewWorkflowExecutionFailedCauseDefaultExecutionStartToCloseTimeoutUndefined is a ContinueAsNewWorkflowExecutionFailedCause enum value
	ContinueAsNewWorkflowExecutionFailedCauseDefaultExecutionStartToCloseTimeoutUndefined = "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED"

	// ContinueAsNewWorkflowExecutionFailedCauseDefaultTaskStartToCloseTimeoutUndefined is a ContinueAsNewWorkflowExecutionFailedCause enum value
	ContinueAsNewWorkflowExecutionFailedCauseDefaultTaskStartToCloseTimeoutUndefined = "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED"

	// ContinueAsNewWorkflowExecutionFailedCauseDefaultTaskListUndefined is a ContinueAsNewWorkflowExecutionFailedCause enum value
	ContinueAsNewWorkflowExecutionFailedCauseDefaultTaskListUndefined = "DEFAULT_TASK_LIST_UNDEFINED"

	// ContinueAsNewWorkflowExecutionFailedCauseDefaultChildPolicyUndefined is a ContinueAsNewWorkflowExecutionFailedCause enum value
	ContinueAsNewWorkflowExecutionFailedCauseDefaultChildPolicyUndefined = "DEFAULT_CHILD_POLICY_UNDEFINED"

	// ContinueAsNewWorkflowExecutionFailedCauseContinueAsNewWorkflowExecutionRateExceeded is a ContinueAsNewWorkflowExecutionFailedCause enum value
	ContinueAsNewWorkflowExecutionFailedCauseContinueAsNewWorkflowExecutionRateExceeded = "CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED"

	// ContinueAsNewWorkflowExecutionFailedCauseOperationNotPermitted is a ContinueAsNewWorkflowExecutionFailedCause enum value
	ContinueAsNewWorkflowExecutionFailedCauseOperationNotPermitted = "OPERATION_NOT_PERMITTED"
)
View Source
const (
	// DecisionTypeScheduleActivityTask is a DecisionType enum value
	DecisionTypeScheduleActivityTask = "ScheduleActivityTask"

	// DecisionTypeRequestCancelActivityTask is a DecisionType enum value
	DecisionTypeRequestCancelActivityTask = "RequestCancelActivityTask"

	// DecisionTypeCompleteWorkflowExecution is a DecisionType enum value
	DecisionTypeCompleteWorkflowExecution = "CompleteWorkflowExecution"

	// DecisionTypeFailWorkflowExecution is a DecisionType enum value
	DecisionTypeFailWorkflowExecution = "FailWorkflowExecution"

	// DecisionTypeCancelWorkflowExecution is a DecisionType enum value
	DecisionTypeCancelWorkflowExecution = "CancelWorkflowExecution"

	// DecisionTypeContinueAsNewWorkflowExecution is a DecisionType enum value
	DecisionTypeContinueAsNewWorkflowExecution = "ContinueAsNewWorkflowExecution"

	// DecisionTypeRecordMarker is a DecisionType enum value
	DecisionTypeRecordMarker = "RecordMarker"

	// DecisionTypeStartTimer is a DecisionType enum value
	DecisionTypeStartTimer = "StartTimer"

	// DecisionTypeCancelTimer is a DecisionType enum value
	DecisionTypeCancelTimer = "CancelTimer"

	// DecisionTypeSignalExternalWorkflowExecution is a DecisionType enum value
	DecisionTypeSignalExternalWorkflowExecution = "SignalExternalWorkflowExecution"

	// DecisionTypeRequestCancelExternalWorkflowExecution is a DecisionType enum value
	DecisionTypeRequestCancelExternalWorkflowExecution = "RequestCancelExternalWorkflowExecution"

	// DecisionTypeStartChildWorkflowExecution is a DecisionType enum value
	DecisionTypeStartChildWorkflowExecution = "StartChildWorkflowExecution"

	// DecisionTypeScheduleLambdaFunction is a DecisionType enum value
	DecisionTypeScheduleLambdaFunction = "ScheduleLambdaFunction"
)
View Source
const (
	// EventTypeWorkflowExecutionStarted is a EventType enum value
	EventTypeWorkflowExecutionStarted = "WorkflowExecutionStarted"

	// EventTypeWorkflowExecutionCancelRequested is a EventType enum value
	EventTypeWorkflowExecutionCancelRequested = "WorkflowExecutionCancelRequested"

	// EventTypeWorkflowExecutionCompleted is a EventType enum value
	EventTypeWorkflowExecutionCompleted = "WorkflowExecutionCompleted"

	// EventTypeCompleteWorkflowExecutionFailed is a EventType enum value
	EventTypeCompleteWorkflowExecutionFailed = "CompleteWorkflowExecutionFailed"

	// EventTypeWorkflowExecutionFailed is a EventType enum value
	EventTypeWorkflowExecutionFailed = "WorkflowExecutionFailed"

	// EventTypeFailWorkflowExecutionFailed is a EventType enum value
	EventTypeFailWorkflowExecutionFailed = "FailWorkflowExecutionFailed"

	// EventTypeWorkflowExecutionTimedOut is a EventType enum value
	EventTypeWorkflowExecutionTimedOut = "WorkflowExecutionTimedOut"

	// EventTypeWorkflowExecutionCanceled is a EventType enum value
	EventTypeWorkflowExecutionCanceled = "WorkflowExecutionCanceled"

	// EventTypeCancelWorkflowExecutionFailed is a EventType enum value
	EventTypeCancelWorkflowExecutionFailed = "CancelWorkflowExecutionFailed"

	// EventTypeWorkflowExecutionContinuedAsNew is a EventType enum value
	EventTypeWorkflowExecutionContinuedAsNew = "WorkflowExecutionContinuedAsNew"

	// EventTypeContinueAsNewWorkflowExecutionFailed is a EventType enum value
	EventTypeContinueAsNewWorkflowExecutionFailed = "ContinueAsNewWorkflowExecutionFailed"

	// EventTypeWorkflowExecutionTerminated is a EventType enum value
	EventTypeWorkflowExecutionTerminated = "WorkflowExecutionTerminated"

	// EventTypeDecisionTaskScheduled is a EventType enum value
	EventTypeDecisionTaskScheduled = "DecisionTaskScheduled"

	// EventTypeDecisionTaskStarted is a EventType enum value
	EventTypeDecisionTaskStarted = "DecisionTaskStarted"

	// EventTypeDecisionTaskCompleted is a EventType enum value
	EventTypeDecisionTaskCompleted = "DecisionTaskCompleted"

	// EventTypeDecisionTaskTimedOut is a EventType enum value
	EventTypeDecisionTaskTimedOut = "DecisionTaskTimedOut"

	// EventTypeActivityTaskScheduled is a EventType enum value
	EventTypeActivityTaskScheduled = "ActivityTaskScheduled"

	// EventTypeScheduleActivityTaskFailed is a EventType enum value
	EventTypeScheduleActivityTaskFailed = "ScheduleActivityTaskFailed"

	// EventTypeActivityTaskStarted is a EventType enum value
	EventTypeActivityTaskStarted = "ActivityTaskStarted"

	// EventTypeActivityTaskCompleted is a EventType enum value
	EventTypeActivityTaskCompleted = "ActivityTaskCompleted"

	// EventTypeActivityTaskFailed is a EventType enum value
	EventTypeActivityTaskFailed = "ActivityTaskFailed"

	// EventTypeActivityTaskTimedOut is a EventType enum value
	EventTypeActivityTaskTimedOut = "ActivityTaskTimedOut"

	// EventTypeActivityTaskCanceled is a EventType enum value
	EventTypeActivityTaskCanceled = "ActivityTaskCanceled"

	// EventTypeActivityTaskCancelRequested is a EventType enum value
	EventTypeActivityTaskCancelRequested = "ActivityTaskCancelRequested"

	// EventTypeRequestCancelActivityTaskFailed is a EventType enum value
	EventTypeRequestCancelActivityTaskFailed = "RequestCancelActivityTaskFailed"

	// EventTypeWorkflowExecutionSignaled is a EventType enum value
	EventTypeWorkflowExecutionSignaled = "WorkflowExecutionSignaled"

	// EventTypeMarkerRecorded is a EventType enum value
	EventTypeMarkerRecorded = "MarkerRecorded"

	// EventTypeRecordMarkerFailed is a EventType enum value
	EventTypeRecordMarkerFailed = "RecordMarkerFailed"

	// EventTypeTimerStarted is a EventType enum value
	EventTypeTimerStarted = "TimerStarted"

	// EventTypeStartTimerFailed is a EventType enum value
	EventTypeStartTimerFailed = "StartTimerFailed"

	// EventTypeTimerFired is a EventType enum value
	EventTypeTimerFired = "TimerFired"

	// EventTypeTimerCanceled is a EventType enum value
	EventTypeTimerCanceled = "TimerCanceled"

	// EventTypeCancelTimerFailed is a EventType enum value
	EventTypeCancelTimerFailed = "CancelTimerFailed"

	// EventTypeStartChildWorkflowExecutionInitiated is a EventType enum value
	EventTypeStartChildWorkflowExecutionInitiated = "StartChildWorkflowExecutionInitiated"

	// EventTypeStartChildWorkflowExecutionFailed is a EventType enum value
	EventTypeStartChildWorkflowExecutionFailed = "StartChildWorkflowExecutionFailed"

	// EventTypeChildWorkflowExecutionStarted is a EventType enum value
	EventTypeChildWorkflowExecutionStarted = "ChildWorkflowExecutionStarted"

	// EventTypeChildWorkflowExecutionCompleted is a EventType enum value
	EventTypeChildWorkflowExecutionCompleted = "ChildWorkflowExecutionCompleted"

	// EventTypeChildWorkflowExecutionFailed is a EventType enum value
	EventTypeChildWorkflowExecutionFailed = "ChildWorkflowExecutionFailed"

	// EventTypeChildWorkflowExecutionTimedOut is a EventType enum value
	EventTypeChildWorkflowExecutionTimedOut = "ChildWorkflowExecutionTimedOut"

	// EventTypeChildWorkflowExecutionCanceled is a EventType enum value
	EventTypeChildWorkflowExecutionCanceled = "ChildWorkflowExecutionCanceled"

	// EventTypeChildWorkflowExecutionTerminated is a EventType enum value
	EventTypeChildWorkflowExecutionTerminated = "ChildWorkflowExecutionTerminated"

	// EventTypeSignalExternalWorkflowExecutionInitiated is a EventType enum value
	EventTypeSignalExternalWorkflowExecutionInitiated = "SignalExternalWorkflowExecutionInitiated"

	// EventTypeSignalExternalWorkflowExecutionFailed is a EventType enum value
	EventTypeSignalExternalWorkflowExecutionFailed = "SignalExternalWorkflowExecutionFailed"

	// EventTypeExternalWorkflowExecutionSignaled is a EventType enum value
	EventTypeExternalWorkflowExecutionSignaled = "ExternalWorkflowExecutionSignaled"

	// EventTypeRequestCancelExternalWorkflowExecutionInitiated is a EventType enum value
	EventTypeRequestCancelExternalWorkflowExecutionInitiated = "RequestCancelExternalWorkflowExecutionInitiated"

	// EventTypeRequestCancelExternalWorkflowExecutionFailed is a EventType enum value
	EventTypeRequestCancelExternalWorkflowExecutionFailed = "RequestCancelExternalWorkflowExecutionFailed"

	// EventTypeExternalWorkflowExecutionCancelRequested is a EventType enum value
	EventTypeExternalWorkflowExecutionCancelRequested = "ExternalWorkflowExecutionCancelRequested"

	// EventTypeLambdaFunctionScheduled is a EventType enum value
	EventTypeLambdaFunctionScheduled = "LambdaFunctionScheduled"

	// EventTypeLambdaFunctionStarted is a EventType enum value
	EventTypeLambdaFunctionStarted = "LambdaFunctionStarted"

	// EventTypeLambdaFunctionCompleted is a EventType enum value
	EventTypeLambdaFunctionCompleted = "LambdaFunctionCompleted"

	// EventTypeLambdaFunctionFailed is a EventType enum value
	EventTypeLambdaFunctionFailed = "LambdaFunctionFailed"

	// EventTypeLambdaFunctionTimedOut is a EventType enum value
	EventTypeLambdaFunctionTimedOut = "LambdaFunctionTimedOut"

	// EventTypeScheduleLambdaFunctionFailed is a EventType enum value
	EventTypeScheduleLambdaFunctionFailed = "ScheduleLambdaFunctionFailed"

	// EventTypeStartLambdaFunctionFailed is a EventType enum value
	EventTypeStartLambdaFunctionFailed = "StartLambdaFunctionFailed"
)
View Source
const (
	// ExecutionStatusOpen is a ExecutionStatus enum value
	ExecutionStatusOpen = "OPEN"

	// ExecutionStatusClosed is a ExecutionStatus enum value
	ExecutionStatusClosed = "CLOSED"
)
View Source
const (
	// FailWorkflowExecutionFailedCauseUnhandledDecision is a FailWorkflowExecutionFailedCause enum value
	FailWorkflowExecutionFailedCauseUnhandledDecision = "UNHANDLED_DECISION"

	// FailWorkflowExecutionFailedCauseOperationNotPermitted is a FailWorkflowExecutionFailedCause enum value
	FailWorkflowExecutionFailedCauseOperationNotPermitted = "OPERATION_NOT_PERMITTED"
)
View Source
const (
	// RegistrationStatusRegistered is a RegistrationStatus enum value
	RegistrationStatusRegistered = "REGISTERED"

	// RegistrationStatusDeprecated is a RegistrationStatus enum value
	RegistrationStatusDeprecated = "DEPRECATED"
)
View Source
const (
	// RequestCancelActivityTaskFailedCauseActivityIdUnknown is a RequestCancelActivityTaskFailedCause enum value
	RequestCancelActivityTaskFailedCauseActivityIdUnknown = "ACTIVITY_ID_UNKNOWN"

	// RequestCancelActivityTaskFailedCauseOperationNotPermitted is a RequestCancelActivityTaskFailedCause enum value
	RequestCancelActivityTaskFailedCauseOperationNotPermitted = "OPERATION_NOT_PERMITTED"
)
View Source
const (
	// RequestCancelExternalWorkflowExecutionFailedCauseUnknownExternalWorkflowExecution is a RequestCancelExternalWorkflowExecutionFailedCause enum value
	RequestCancelExternalWorkflowExecutionFailedCauseUnknownExternalWorkflowExecution = "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION"

	// RequestCancelExternalWorkflowExecutionFailedCauseRequestCancelExternalWorkflowExecutionRateExceeded is a RequestCancelExternalWorkflowExecutionFailedCause enum value
	RequestCancelExternalWorkflowExecutionFailedCauseRequestCancelExternalWorkflowExecutionRateExceeded = "REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED"

	// RequestCancelExternalWorkflowExecutionFailedCauseOperationNotPermitted is a RequestCancelExternalWorkflowExecutionFailedCause enum value
	RequestCancelExternalWorkflowExecutionFailedCauseOperationNotPermitted = "OPERATION_NOT_PERMITTED"
)
View Source
const (
	// ScheduleActivityTaskFailedCauseActivityTypeDeprecated is a ScheduleActivityTaskFailedCause enum value
	ScheduleActivityTaskFailedCauseActivityTypeDeprecated = "ACTIVITY_TYPE_DEPRECATED"

	// ScheduleActivityTaskFailedCauseActivityTypeDoesNotExist is a ScheduleActivityTaskFailedCause enum value
	ScheduleActivityTaskFailedCauseActivityTypeDoesNotExist = "ACTIVITY_TYPE_DOES_NOT_EXIST"

	// ScheduleActivityTaskFailedCauseActivityIdAlreadyInUse is a ScheduleActivityTaskFailedCause enum value
	ScheduleActivityTaskFailedCauseActivityIdAlreadyInUse = "ACTIVITY_ID_ALREADY_IN_USE"

	// ScheduleActivityTaskFailedCauseOpenActivitiesLimitExceeded is a ScheduleActivityTaskFailedCause enum value
	ScheduleActivityTaskFailedCauseOpenActivitiesLimitExceeded = "OPEN_ACTIVITIES_LIMIT_EXCEEDED"

	// ScheduleActivityTaskFailedCauseActivityCreationRateExceeded is a ScheduleActivityTaskFailedCause enum value
	ScheduleActivityTaskFailedCauseActivityCreationRateExceeded = "ACTIVITY_CREATION_RATE_EXCEEDED"

	// ScheduleActivityTaskFailedCauseDefaultScheduleToCloseTimeoutUndefined is a ScheduleActivityTaskFailedCause enum value
	ScheduleActivityTaskFailedCauseDefaultScheduleToCloseTimeoutUndefined = "DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED"

	// ScheduleActivityTaskFailedCauseDefaultTaskListUndefined is a ScheduleActivityTaskFailedCause enum value
	ScheduleActivityTaskFailedCauseDefaultTaskListUndefined = "DEFAULT_TASK_LIST_UNDEFINED"

	// ScheduleActivityTaskFailedCauseDefaultScheduleToStartTimeoutUndefined is a ScheduleActivityTaskFailedCause enum value
	ScheduleActivityTaskFailedCauseDefaultScheduleToStartTimeoutUndefined = "DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED"

	// ScheduleActivityTaskFailedCauseDefaultStartToCloseTimeoutUndefined is a ScheduleActivityTaskFailedCause enum value
	ScheduleActivityTaskFailedCauseDefaultStartToCloseTimeoutUndefined = "DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED"

	// ScheduleActivityTaskFailedCauseDefaultHeartbeatTimeoutUndefined is a ScheduleActivityTaskFailedCause enum value
	ScheduleActivityTaskFailedCauseDefaultHeartbeatTimeoutUndefined = "DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED"

	// ScheduleActivityTaskFailedCauseOperationNotPermitted is a ScheduleActivityTaskFailedCause enum value
	ScheduleActivityTaskFailedCauseOperationNotPermitted = "OPERATION_NOT_PERMITTED"
)
View Source
const (
	// ScheduleLambdaFunctionFailedCauseIdAlreadyInUse is a ScheduleLambdaFunctionFailedCause enum value
	ScheduleLambdaFunctionFailedCauseIdAlreadyInUse = "ID_ALREADY_IN_USE"

	// ScheduleLambdaFunctionFailedCauseOpenLambdaFunctionsLimitExceeded is a ScheduleLambdaFunctionFailedCause enum value
	ScheduleLambdaFunctionFailedCauseOpenLambdaFunctionsLimitExceeded = "OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED"

	// ScheduleLambdaFunctionFailedCauseLambdaFunctionCreationRateExceeded is a ScheduleLambdaFunctionFailedCause enum value
	ScheduleLambdaFunctionFailedCauseLambdaFunctionCreationRateExceeded = "LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED"

	// ScheduleLambdaFunctionFailedCauseLambdaServiceNotAvailableInRegion is a ScheduleLambdaFunctionFailedCause enum value
	ScheduleLambdaFunctionFailedCauseLambdaServiceNotAvailableInRegion = "LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION"
)
View Source
const (
	// SignalExternalWorkflowExecutionFailedCauseUnknownExternalWorkflowExecution is a SignalExternalWorkflowExecutionFailedCause enum value
	SignalExternalWorkflowExecutionFailedCauseUnknownExternalWorkflowExecution = "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION"

	// SignalExternalWorkflowExecutionFailedCauseSignalExternalWorkflowExecutionRateExceeded is a SignalExternalWorkflowExecutionFailedCause enum value
	SignalExternalWorkflowExecutionFailedCauseSignalExternalWorkflowExecutionRateExceeded = "SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED"

	// SignalExternalWorkflowExecutionFailedCauseOperationNotPermitted is a SignalExternalWorkflowExecutionFailedCause enum value
	SignalExternalWorkflowExecutionFailedCauseOperationNotPermitted = "OPERATION_NOT_PERMITTED"
)
View Source
const (
	// StartChildWorkflowExecutionFailedCauseWorkflowTypeDoesNotExist is a StartChildWorkflowExecutionFailedCause enum value
	StartChildWorkflowExecutionFailedCauseWorkflowTypeDoesNotExist = "WORKFLOW_TYPE_DOES_NOT_EXIST"

	// StartChildWorkflowExecutionFailedCauseWorkflowTypeDeprecated is a StartChildWorkflowExecutionFailedCause enum value
	StartChildWorkflowExecutionFailedCauseWorkflowTypeDeprecated = "WORKFLOW_TYPE_DEPRECATED"

	// StartChildWorkflowExecutionFailedCauseOpenChildrenLimitExceeded is a StartChildWorkflowExecutionFailedCause enum value
	StartChildWorkflowExecutionFailedCauseOpenChildrenLimitExceeded = "OPEN_CHILDREN_LIMIT_EXCEEDED"

	// StartChildWorkflowExecutionFailedCauseOpenWorkflowsLimitExceeded is a StartChildWorkflowExecutionFailedCause enum value
	StartChildWorkflowExecutionFailedCauseOpenWorkflowsLimitExceeded = "OPEN_WORKFLOWS_LIMIT_EXCEEDED"

	// StartChildWorkflowExecutionFailedCauseChildCreationRateExceeded is a StartChildWorkflowExecutionFailedCause enum value
	StartChildWorkflowExecutionFailedCauseChildCreationRateExceeded = "CHILD_CREATION_RATE_EXCEEDED"

	// StartChildWorkflowExecutionFailedCauseWorkflowAlreadyRunning is a StartChildWorkflowExecutionFailedCause enum value
	StartChildWorkflowExecutionFailedCauseWorkflowAlreadyRunning = "WORKFLOW_ALREADY_RUNNING"

	// StartChildWorkflowExecutionFailedCauseDefaultExecutionStartToCloseTimeoutUndefined is a StartChildWorkflowExecutionFailedCause enum value
	StartChildWorkflowExecutionFailedCauseDefaultExecutionStartToCloseTimeoutUndefined = "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED"

	// StartChildWorkflowExecutionFailedCauseDefaultTaskListUndefined is a StartChildWorkflowExecutionFailedCause enum value
	StartChildWorkflowExecutionFailedCauseDefaultTaskListUndefined = "DEFAULT_TASK_LIST_UNDEFINED"

	// StartChildWorkflowExecutionFailedCauseDefaultTaskStartToCloseTimeoutUndefined is a StartChildWorkflowExecutionFailedCause enum value
	StartChildWorkflowExecutionFailedCauseDefaultTaskStartToCloseTimeoutUndefined = "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED"

	// StartChildWorkflowExecutionFailedCauseDefaultChildPolicyUndefined is a StartChildWorkflowExecutionFailedCause enum value
	StartChildWorkflowExecutionFailedCauseDefaultChildPolicyUndefined = "DEFAULT_CHILD_POLICY_UNDEFINED"

	// StartChildWorkflowExecutionFailedCauseOperationNotPermitted is a StartChildWorkflowExecutionFailedCause enum value
	StartChildWorkflowExecutionFailedCauseOperationNotPermitted = "OPERATION_NOT_PERMITTED"
)
View Source
const (
	// StartTimerFailedCauseTimerIdAlreadyInUse is a StartTimerFailedCause enum value
	StartTimerFailedCauseTimerIdAlreadyInUse = "TIMER_ID_ALREADY_IN_USE"

	// StartTimerFailedCauseOpenTimersLimitExceeded is a StartTimerFailedCause enum value
	StartTimerFailedCauseOpenTimersLimitExceeded = "OPEN_TIMERS_LIMIT_EXCEEDED"

	// StartTimerFailedCauseTimerCreationRateExceeded is a StartTimerFailedCause enum value
	StartTimerFailedCauseTimerCreationRateExceeded = "TIMER_CREATION_RATE_EXCEEDED"

	// StartTimerFailedCauseOperationNotPermitted is a StartTimerFailedCause enum value
	StartTimerFailedCauseOperationNotPermitted = "OPERATION_NOT_PERMITTED"
)
View Source
const (
	// WorkflowExecutionTerminatedCauseChildPolicyApplied is a WorkflowExecutionTerminatedCause enum value
	WorkflowExecutionTerminatedCauseChildPolicyApplied = "CHILD_POLICY_APPLIED"

	// WorkflowExecutionTerminatedCauseEventLimitExceeded is a WorkflowExecutionTerminatedCause enum value
	WorkflowExecutionTerminatedCauseEventLimitExceeded = "EVENT_LIMIT_EXCEEDED"

	// WorkflowExecutionTerminatedCauseOperatorInitiated is a WorkflowExecutionTerminatedCause enum value
	WorkflowExecutionTerminatedCauseOperatorInitiated = "OPERATOR_INITIATED"
)
View Source
const (

	// ErrCodeDefaultUndefinedFault for service response error code
	// "DefaultUndefinedFault".
	//
	// The StartWorkflowExecution API action was called without the required parameters
	// set.
	//
	// Some workflow execution parameters, such as the decision taskList, must be
	// set to start the execution. However, these parameters might have been set
	// as defaults when the workflow type was registered. In this case, you can
	// omit these parameters from the StartWorkflowExecution call and Amazon SWF
	// uses the values defined in the workflow type.
	//
	// If these parameters aren't set and no default parameters were defined in
	// the workflow type, this error is displayed.
	ErrCodeDefaultUndefinedFault = "DefaultUndefinedFault"

	// ErrCodeDomainAlreadyExistsFault for service response error code
	// "DomainAlreadyExistsFault".
	//
	// Returned if the specified domain already exists. You get this fault even
	// if the existing domain is in deprecated status.
	ErrCodeDomainAlreadyExistsFault = "DomainAlreadyExistsFault"

	// ErrCodeDomainDeprecatedFault for service response error code
	// "DomainDeprecatedFault".
	//
	// Returned when the specified domain has been deprecated.
	ErrCodeDomainDeprecatedFault = "DomainDeprecatedFault"

	// ErrCodeLimitExceededFault for service response error code
	// "LimitExceededFault".
	//
	// Returned by any operation if a system imposed limitation has been reached.
	// To address this fault you should either clean up unused resources or increase
	// the limit by contacting AWS.
	ErrCodeLimitExceededFault = "LimitExceededFault"

	// ErrCodeOperationNotPermittedFault for service response error code
	// "OperationNotPermittedFault".
	//
	// Returned when the caller doesn't have sufficient permissions to invoke the
	// action.
	ErrCodeOperationNotPermittedFault = "OperationNotPermittedFault"

	// ErrCodeTypeAlreadyExistsFault for service response error code
	// "TypeAlreadyExistsFault".
	//
	// Returned if the type already exists in the specified domain. You get this
	// fault even if the existing type is in deprecated status. You can specify
	// another version if the intent is to create a new distinct version of the
	// type.
	ErrCodeTypeAlreadyExistsFault = "TypeAlreadyExistsFault"

	// ErrCodeTypeDeprecatedFault for service response error code
	// "TypeDeprecatedFault".
	//
	// Returned when the specified activity or workflow type was already deprecated.
	ErrCodeTypeDeprecatedFault = "TypeDeprecatedFault"

	// ErrCodeUnknownResourceFault for service response error code
	// "UnknownResourceFault".
	//
	// Returned when the named resource cannot be found with in the scope of this
	// operation (region or domain). This could happen if the named resource was
	// never created or is no longer available for this operation.
	ErrCodeUnknownResourceFault = "UnknownResourceFault"

	// ErrCodeWorkflowExecutionAlreadyStartedFault for service response error code
	// "WorkflowExecutionAlreadyStartedFault".
	//
	// Returned by StartWorkflowExecution when an open execution with the same workflowId
	// is already running in the specified domain.
	ErrCodeWorkflowExecutionAlreadyStartedFault = "WorkflowExecutionAlreadyStartedFault"
)
View Source
const (
	ServiceName = "swf"       // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

View Source
const (
	// DecisionTaskTimeoutTypeStartToClose is a DecisionTaskTimeoutType enum value
	DecisionTaskTimeoutTypeStartToClose = "START_TO_CLOSE"
)
View Source
const (
	// LambdaFunctionTimeoutTypeStartToClose is a LambdaFunctionTimeoutType enum value
	LambdaFunctionTimeoutTypeStartToClose = "START_TO_CLOSE"
)
View Source
const (
	// RecordMarkerFailedCauseOperationNotPermitted is a RecordMarkerFailedCause enum value
	RecordMarkerFailedCauseOperationNotPermitted = "OPERATION_NOT_PERMITTED"
)
View Source
const (
	// StartLambdaFunctionFailedCauseAssumeRoleFailed is a StartLambdaFunctionFailedCause enum value
	StartLambdaFunctionFailedCauseAssumeRoleFailed = "ASSUME_ROLE_FAILED"
)
View Source
const (
	// WorkflowExecutionCancelRequestedCauseChildPolicyApplied is a WorkflowExecutionCancelRequestedCause enum value
	WorkflowExecutionCancelRequestedCauseChildPolicyApplied = "CHILD_POLICY_APPLIED"
)
View Source
const (
	// WorkflowExecutionTimeoutTypeStartToClose is a WorkflowExecutionTimeoutType enum value
	WorkflowExecutionTimeoutTypeStartToClose = "START_TO_CLOSE"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivityTaskCancelRequestedEventAttributes

type ActivityTaskCancelRequestedEventAttributes struct {

	// The unique ID of the task.
	//
	// ActivityId is a required field
	ActivityId *string `locationName:"activityId" min:"1" type:"string" required:"true"`

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the ActivityTaskCancelRequested event.

func (ActivityTaskCancelRequestedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ActivityTaskCancelRequestedEventAttributes) SetActivityId added in v1.5.0

SetActivityId sets the ActivityId field's value.

func (*ActivityTaskCancelRequestedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (ActivityTaskCancelRequestedEventAttributes) String added in v0.6.5

String returns the string representation

type ActivityTaskCanceledEventAttributes

type ActivityTaskCanceledEventAttributes struct {

	// Details of the cancellation.
	Details *string `locationName:"details" type:"string"`

	// 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.
	LatestCancelRequestedEventId *int64 `locationName:"latestCancelRequestedEventId" type:"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.
	//
	// ScheduledEventId is a required field
	ScheduledEventId *int64 `locationName:"scheduledEventId" type:"long" required:"true"`

	// 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.
	//
	// StartedEventId is a required field
	StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the ActivityTaskCanceled event.

func (ActivityTaskCanceledEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ActivityTaskCanceledEventAttributes) SetDetails added in v1.5.0

SetDetails sets the Details field's value.

func (*ActivityTaskCanceledEventAttributes) SetLatestCancelRequestedEventId added in v1.5.0

func (s *ActivityTaskCanceledEventAttributes) SetLatestCancelRequestedEventId(v int64) *ActivityTaskCanceledEventAttributes

SetLatestCancelRequestedEventId sets the LatestCancelRequestedEventId field's value.

func (*ActivityTaskCanceledEventAttributes) SetScheduledEventId added in v1.5.0

SetScheduledEventId sets the ScheduledEventId field's value.

func (*ActivityTaskCanceledEventAttributes) SetStartedEventId added in v1.5.0

SetStartedEventId sets the StartedEventId field's value.

func (ActivityTaskCanceledEventAttributes) String added in v0.6.5

String returns the string representation

type ActivityTaskCompletedEventAttributes

type ActivityTaskCompletedEventAttributes struct {

	// The results of the activity task.
	Result *string `locationName:"result" type:"string"`

	// 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.
	//
	// ScheduledEventId is a required field
	ScheduledEventId *int64 `locationName:"scheduledEventId" type:"long" required:"true"`

	// 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.
	//
	// StartedEventId is a required field
	StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the ActivityTaskCompleted event.

func (ActivityTaskCompletedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ActivityTaskCompletedEventAttributes) SetResult added in v1.5.0

SetResult sets the Result field's value.

func (*ActivityTaskCompletedEventAttributes) SetScheduledEventId added in v1.5.0

SetScheduledEventId sets the ScheduledEventId field's value.

func (*ActivityTaskCompletedEventAttributes) SetStartedEventId added in v1.5.0

SetStartedEventId sets the StartedEventId field's value.

func (ActivityTaskCompletedEventAttributes) String added in v0.6.5

String returns the string representation

type ActivityTaskFailedEventAttributes

type ActivityTaskFailedEventAttributes struct {

	// The details of the failure.
	Details *string `locationName:"details" type:"string"`

	// The reason provided for the failure.
	Reason *string `locationName:"reason" type:"string"`

	// 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.
	//
	// ScheduledEventId is a required field
	ScheduledEventId *int64 `locationName:"scheduledEventId" type:"long" required:"true"`

	// 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.
	//
	// StartedEventId is a required field
	StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the ActivityTaskFailed event.

func (ActivityTaskFailedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ActivityTaskFailedEventAttributes) SetDetails added in v1.5.0

SetDetails sets the Details field's value.

func (*ActivityTaskFailedEventAttributes) SetReason added in v1.5.0

SetReason sets the Reason field's value.

func (*ActivityTaskFailedEventAttributes) SetScheduledEventId added in v1.5.0

SetScheduledEventId sets the ScheduledEventId field's value.

func (*ActivityTaskFailedEventAttributes) SetStartedEventId added in v1.5.0

SetStartedEventId sets the StartedEventId field's value.

func (ActivityTaskFailedEventAttributes) String added in v0.6.5

String returns the string representation

type ActivityTaskScheduledEventAttributes

type ActivityTaskScheduledEventAttributes struct {

	// The unique ID of the activity task.
	//
	// ActivityId is a required field
	ActivityId *string `locationName:"activityId" min:"1" type:"string" required:"true"`

	// The type of the activity task.
	//
	// ActivityType is a required field
	ActivityType *ActivityType `locationName:"activityType" type:"structure" required:"true"`

	// Data attached to the event that can be used by the decider in subsequent
	// workflow tasks. This data isn't sent to the activity.
	Control *string `locationName:"control" type:"string"`

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// The maximum time before which the worker processing this task must report
	// progress by calling RecordActivityTaskHeartbeat. 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 is ignored.
	HeartbeatTimeout *string `locationName:"heartbeatTimeout" type:"string"`

	// The input provided to the activity task.
	Input *string `locationName:"input" type:"string"`

	// The maximum amount of time for this activity task.
	ScheduleToCloseTimeout *string `locationName:"scheduleToCloseTimeout" type:"string"`

	// The maximum amount of time the activity task can wait to be assigned to a
	// worker.
	ScheduleToStartTimeout *string `locationName:"scheduleToStartTimeout" type:"string"`

	// The maximum amount of time a worker may take to process the activity task.
	StartToCloseTimeout *string `locationName:"startToCloseTimeout" type:"string"`

	// The task list in which the activity task has been scheduled.
	//
	// TaskList is a required field
	TaskList *TaskList `locationName:"taskList" type:"structure" required:"true"`

	// The priority to assign to the scheduled activity task. If set, this overrides
	// 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 (2147483647). Higher numbers indicate higher priority.
	//
	// For more information about setting task priority, see Setting Task Priority
	// (http://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html)
	// in the Amazon SWF Developer Guide.
	TaskPriority *string `locationName:"taskPriority" type:"string"`
	// contains filtered or unexported fields
}

Provides the details of the ActivityTaskScheduled event.

func (ActivityTaskScheduledEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ActivityTaskScheduledEventAttributes) SetActivityId added in v1.5.0

SetActivityId sets the ActivityId field's value.

func (*ActivityTaskScheduledEventAttributes) SetActivityType added in v1.5.0

SetActivityType sets the ActivityType field's value.

func (*ActivityTaskScheduledEventAttributes) SetControl added in v1.5.0

SetControl sets the Control field's value.

func (*ActivityTaskScheduledEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*ActivityTaskScheduledEventAttributes) SetHeartbeatTimeout added in v1.5.0

SetHeartbeatTimeout sets the HeartbeatTimeout field's value.

func (*ActivityTaskScheduledEventAttributes) SetInput added in v1.5.0

SetInput sets the Input field's value.

func (*ActivityTaskScheduledEventAttributes) SetScheduleToCloseTimeout added in v1.5.0

SetScheduleToCloseTimeout sets the ScheduleToCloseTimeout field's value.

func (*ActivityTaskScheduledEventAttributes) SetScheduleToStartTimeout added in v1.5.0

SetScheduleToStartTimeout sets the ScheduleToStartTimeout field's value.

func (*ActivityTaskScheduledEventAttributes) SetStartToCloseTimeout added in v1.5.0

SetStartToCloseTimeout sets the StartToCloseTimeout field's value.

func (*ActivityTaskScheduledEventAttributes) SetTaskList added in v1.5.0

SetTaskList sets the TaskList field's value.

func (*ActivityTaskScheduledEventAttributes) SetTaskPriority added in v1.5.0

SetTaskPriority sets the TaskPriority field's value.

func (ActivityTaskScheduledEventAttributes) String added in v0.6.5

String returns the string representation

type ActivityTaskStartedEventAttributes

type ActivityTaskStartedEventAttributes struct {

	// Identity of the worker that was assigned this task. This aids diagnostics
	// when problems arise. The form of this identity is user defined.
	Identity *string `locationName:"identity" type:"string"`

	// 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.
	//
	// ScheduledEventId is a required field
	ScheduledEventId *int64 `locationName:"scheduledEventId" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the ActivityTaskStarted event.

func (ActivityTaskStartedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ActivityTaskStartedEventAttributes) SetIdentity added in v1.5.0

SetIdentity sets the Identity field's value.

func (*ActivityTaskStartedEventAttributes) SetScheduledEventId added in v1.5.0

SetScheduledEventId sets the ScheduledEventId field's value.

func (ActivityTaskStartedEventAttributes) String added in v0.6.5

String returns the string representation

type ActivityTaskTimedOutEventAttributes

type ActivityTaskTimedOutEventAttributes struct {

	// Contains the content of the details parameter for the last call made by the
	// activity to RecordActivityTaskHeartbeat.
	Details *string `locationName:"details" type:"string"`

	// 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.
	//
	// ScheduledEventId is a required field
	ScheduledEventId *int64 `locationName:"scheduledEventId" type:"long" required:"true"`

	// 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.
	//
	// StartedEventId is a required field
	StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`

	// The type of the timeout that caused this event.
	//
	// TimeoutType is a required field
	TimeoutType *string `locationName:"timeoutType" type:"string" required:"true" enum:"ActivityTaskTimeoutType"`
	// contains filtered or unexported fields
}

Provides the details of the ActivityTaskTimedOut event.

func (ActivityTaskTimedOutEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ActivityTaskTimedOutEventAttributes) SetDetails added in v1.5.0

SetDetails sets the Details field's value.

func (*ActivityTaskTimedOutEventAttributes) SetScheduledEventId added in v1.5.0

SetScheduledEventId sets the ScheduledEventId field's value.

func (*ActivityTaskTimedOutEventAttributes) SetStartedEventId added in v1.5.0

SetStartedEventId sets the StartedEventId field's value.

func (*ActivityTaskTimedOutEventAttributes) SetTimeoutType added in v1.5.0

SetTimeoutType sets the TimeoutType field's value.

func (ActivityTaskTimedOutEventAttributes) String added in v0.6.5

String returns the string representation

type ActivityType

type ActivityType struct {

	// The name of this activity.
	//
	// The combination of activity type name and version must be unique within a
	// domain.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The version of this activity.
	//
	// The combination of activity type name and version must be unique with in
	// a domain.
	//
	// Version is a required field
	Version *string `locationName:"version" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents an activity type.

func (ActivityType) GoString added in v0.6.5

func (s ActivityType) GoString() string

GoString returns the string representation

func (*ActivityType) SetName added in v1.5.0

func (s *ActivityType) SetName(v string) *ActivityType

SetName sets the Name field's value.

func (*ActivityType) SetVersion added in v1.5.0

func (s *ActivityType) SetVersion(v string) *ActivityType

SetVersion sets the Version field's value.

func (ActivityType) String added in v0.6.5

func (s ActivityType) String() string

String returns the string representation

func (*ActivityType) Validate added in v1.1.21

func (s *ActivityType) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ActivityTypeConfiguration

type ActivityTypeConfiguration struct {

	// The default maximum time, in seconds, before which a worker processing a
	// task must report progress by calling RecordActivityTaskHeartbeat.
	//
	// You can specify this value only when registering an activity type. The registered
	// default value can be overridden when you schedule a task through the ScheduleActivityTaskDecision.
	// If the activity worker subsequently attempts to record a heartbeat or returns
	// a result, the activity worker receives an UnknownResource fault. In this
	// case, Amazon SWF no longer considers the activity task to be valid; the activity
	// worker should clean up the activity task.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	DefaultTaskHeartbeatTimeout *string `locationName:"defaultTaskHeartbeatTimeout" type:"string"`

	// The default task list specified for this activity type at registration. This
	// default is used if a task list isn't provided when a task is scheduled through
	// the ScheduleActivityTaskDecision. You can override the default registered
	// task list when scheduling a task through the ScheduleActivityTaskDecision.
	DefaultTaskList *TaskList `locationName:"defaultTaskList" type:"structure"`

	// The default task priority for tasks of this activity type, specified at registration.
	// If not set, then 0 is used as the default priority. This default can be overridden
	// when scheduling an activity task.
	//
	// Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648)
	// to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
	//
	// For more information about setting task priority, see Setting Task Priority
	// (http://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html)
	// in the Amazon SWF Developer Guide.
	DefaultTaskPriority *string `locationName:"defaultTaskPriority" type:"string"`

	// The default maximum duration, specified when registering the activity type,
	// for tasks of this activity type. You can override this default when scheduling
	// a task through the ScheduleActivityTaskDecision.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	DefaultTaskScheduleToCloseTimeout *string `locationName:"defaultTaskScheduleToCloseTimeout" type:"string"`

	// The default maximum duration, specified when registering the activity type,
	// that a task of an activity type can wait before being assigned to a worker.
	// You can override this default when scheduling a task through the ScheduleActivityTaskDecision.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	DefaultTaskScheduleToStartTimeout *string `locationName:"defaultTaskScheduleToStartTimeout" type:"string"`

	// The default maximum duration for tasks of an activity type specified when
	// registering the activity type. You can override this default when scheduling
	// a task through the ScheduleActivityTaskDecision.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	DefaultTaskStartToCloseTimeout *string `locationName:"defaultTaskStartToCloseTimeout" type:"string"`
	// contains filtered or unexported fields
}

Configuration settings registered with the activity type.

func (ActivityTypeConfiguration) GoString added in v0.6.5

func (s ActivityTypeConfiguration) GoString() string

GoString returns the string representation

func (*ActivityTypeConfiguration) SetDefaultTaskHeartbeatTimeout added in v1.5.0

func (s *ActivityTypeConfiguration) SetDefaultTaskHeartbeatTimeout(v string) *ActivityTypeConfiguration

SetDefaultTaskHeartbeatTimeout sets the DefaultTaskHeartbeatTimeout field's value.

func (*ActivityTypeConfiguration) SetDefaultTaskList added in v1.5.0

SetDefaultTaskList sets the DefaultTaskList field's value.

func (*ActivityTypeConfiguration) SetDefaultTaskPriority added in v1.5.0

func (s *ActivityTypeConfiguration) SetDefaultTaskPriority(v string) *ActivityTypeConfiguration

SetDefaultTaskPriority sets the DefaultTaskPriority field's value.

func (*ActivityTypeConfiguration) SetDefaultTaskScheduleToCloseTimeout added in v1.5.0

func (s *ActivityTypeConfiguration) SetDefaultTaskScheduleToCloseTimeout(v string) *ActivityTypeConfiguration

SetDefaultTaskScheduleToCloseTimeout sets the DefaultTaskScheduleToCloseTimeout field's value.

func (*ActivityTypeConfiguration) SetDefaultTaskScheduleToStartTimeout added in v1.5.0

func (s *ActivityTypeConfiguration) SetDefaultTaskScheduleToStartTimeout(v string) *ActivityTypeConfiguration

SetDefaultTaskScheduleToStartTimeout sets the DefaultTaskScheduleToStartTimeout field's value.

func (*ActivityTypeConfiguration) SetDefaultTaskStartToCloseTimeout added in v1.5.0

func (s *ActivityTypeConfiguration) SetDefaultTaskStartToCloseTimeout(v string) *ActivityTypeConfiguration

SetDefaultTaskStartToCloseTimeout sets the DefaultTaskStartToCloseTimeout field's value.

func (ActivityTypeConfiguration) String added in v0.6.5

func (s ActivityTypeConfiguration) String() string

String returns the string representation

type ActivityTypeInfo

type ActivityTypeInfo struct {

	// The ActivityType type structure representing the activity type.
	//
	// ActivityType is a required field
	ActivityType *ActivityType `locationName:"activityType" type:"structure" required:"true"`

	// The date and time this activity type was created through RegisterActivityType.
	//
	// CreationDate is a required field
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix" required:"true"`

	// If DEPRECATED, the date and time DeprecateActivityType was called.
	DeprecationDate *time.Time `locationName:"deprecationDate" type:"timestamp" timestampFormat:"unix"`

	// The description of the activity type provided in RegisterActivityType.
	Description *string `locationName:"description" type:"string"`

	// The current status of the activity type.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"RegistrationStatus"`
	// contains filtered or unexported fields
}

Detailed information about an activity type.

func (ActivityTypeInfo) GoString added in v0.6.5

func (s ActivityTypeInfo) GoString() string

GoString returns the string representation

func (*ActivityTypeInfo) SetActivityType added in v1.5.0

func (s *ActivityTypeInfo) SetActivityType(v *ActivityType) *ActivityTypeInfo

SetActivityType sets the ActivityType field's value.

func (*ActivityTypeInfo) SetCreationDate added in v1.5.0

func (s *ActivityTypeInfo) SetCreationDate(v time.Time) *ActivityTypeInfo

SetCreationDate sets the CreationDate field's value.

func (*ActivityTypeInfo) SetDeprecationDate added in v1.5.0

func (s *ActivityTypeInfo) SetDeprecationDate(v time.Time) *ActivityTypeInfo

SetDeprecationDate sets the DeprecationDate field's value.

func (*ActivityTypeInfo) SetDescription added in v1.5.0

func (s *ActivityTypeInfo) SetDescription(v string) *ActivityTypeInfo

SetDescription sets the Description field's value.

func (*ActivityTypeInfo) SetStatus added in v1.5.0

func (s *ActivityTypeInfo) SetStatus(v string) *ActivityTypeInfo

SetStatus sets the Status field's value.

func (ActivityTypeInfo) String added in v0.6.5

func (s ActivityTypeInfo) String() string

String returns the string representation

type CancelTimerDecisionAttributes

type CancelTimerDecisionAttributes struct {

	// The unique ID of the timer to cancel.
	//
	// TimerId is a required field
	TimerId *string `locationName:"timerId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the CancelTimer decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

func (CancelTimerDecisionAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*CancelTimerDecisionAttributes) SetTimerId added in v1.5.0

SetTimerId sets the TimerId field's value.

func (CancelTimerDecisionAttributes) String added in v0.6.5

String returns the string representation

func (*CancelTimerDecisionAttributes) Validate added in v1.1.21

func (s *CancelTimerDecisionAttributes) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelTimerFailedEventAttributes

type CancelTimerFailedEventAttributes struct {

	// The cause of the failure. This information is generated by the system and
	// can be useful for diagnostic purposes.
	//
	// 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 (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html)
	// in the Amazon SWF Developer Guide.
	//
	// Cause is a required field
	Cause *string `locationName:"cause" type:"string" required:"true" enum:"CancelTimerFailedCause"`

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// The timerId provided in the CancelTimer decision that failed.
	//
	// TimerId is a required field
	TimerId *string `locationName:"timerId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the CancelTimerFailed event.

func (CancelTimerFailedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*CancelTimerFailedEventAttributes) SetCause added in v1.5.0

SetCause sets the Cause field's value.

func (*CancelTimerFailedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

func (s *CancelTimerFailedEventAttributes) SetDecisionTaskCompletedEventId(v int64) *CancelTimerFailedEventAttributes

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*CancelTimerFailedEventAttributes) SetTimerId added in v1.5.0

SetTimerId sets the TimerId field's value.

func (CancelTimerFailedEventAttributes) String added in v0.6.5

String returns the string representation

type CancelWorkflowExecutionDecisionAttributes

type CancelWorkflowExecutionDecisionAttributes struct {

	// Details of the cancellation.
	Details *string `locationName:"details" type:"string"`
	// contains filtered or unexported fields
}

Provides the details of the CancelWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

func (CancelWorkflowExecutionDecisionAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*CancelWorkflowExecutionDecisionAttributes) SetDetails added in v1.5.0

SetDetails sets the Details field's value.

func (CancelWorkflowExecutionDecisionAttributes) String added in v0.6.5

String returns the string representation

type CancelWorkflowExecutionFailedEventAttributes

type CancelWorkflowExecutionFailedEventAttributes struct {

	// The cause of the failure. This information is generated by the system and
	// can be useful for diagnostic purposes.
	//
	// 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 (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html)
	// in the Amazon SWF Developer Guide.
	//
	// Cause is a required field
	Cause *string `locationName:"cause" type:"string" required:"true" enum:"CancelWorkflowExecutionFailedCause"`

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the CancelWorkflowExecutionFailed event.

func (CancelWorkflowExecutionFailedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*CancelWorkflowExecutionFailedEventAttributes) SetCause added in v1.5.0

SetCause sets the Cause field's value.

func (*CancelWorkflowExecutionFailedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (CancelWorkflowExecutionFailedEventAttributes) String added in v0.6.5

String returns the string representation

type ChildWorkflowExecutionCanceledEventAttributes

type ChildWorkflowExecutionCanceledEventAttributes struct {

	// Details of the cancellation (if provided).
	Details *string `locationName:"details" type:"string"`

	// The ID of the StartChildWorkflowExecutionInitiated event corresponding to
	// the StartChildWorkflowExecutionDecision 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.
	//
	// InitiatedEventId is a required field
	InitiatedEventId *int64 `locationName:"initiatedEventId" type:"long" required:"true"`

	// 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.
	//
	// StartedEventId is a required field
	StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`

	// The child workflow execution that was canceled.
	//
	// WorkflowExecution is a required field
	WorkflowExecution *WorkflowExecution `locationName:"workflowExecution" type:"structure" required:"true"`

	// The type of the child workflow execution.
	//
	// WorkflowType is a required field
	WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provide details of the ChildWorkflowExecutionCanceled event.

func (ChildWorkflowExecutionCanceledEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ChildWorkflowExecutionCanceledEventAttributes) SetDetails added in v1.5.0

SetDetails sets the Details field's value.

func (*ChildWorkflowExecutionCanceledEventAttributes) SetInitiatedEventId added in v1.5.0

SetInitiatedEventId sets the InitiatedEventId field's value.

func (*ChildWorkflowExecutionCanceledEventAttributes) SetStartedEventId added in v1.5.0

SetStartedEventId sets the StartedEventId field's value.

func (*ChildWorkflowExecutionCanceledEventAttributes) SetWorkflowExecution added in v1.5.0

SetWorkflowExecution sets the WorkflowExecution field's value.

func (*ChildWorkflowExecutionCanceledEventAttributes) SetWorkflowType added in v1.5.0

SetWorkflowType sets the WorkflowType field's value.

func (ChildWorkflowExecutionCanceledEventAttributes) String added in v0.6.5

String returns the string representation

type ChildWorkflowExecutionCompletedEventAttributes

type ChildWorkflowExecutionCompletedEventAttributes struct {

	// The ID of the StartChildWorkflowExecutionInitiated event corresponding to
	// the StartChildWorkflowExecutionDecision 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.
	//
	// InitiatedEventId is a required field
	InitiatedEventId *int64 `locationName:"initiatedEventId" type:"long" required:"true"`

	// The result of the child workflow execution.
	Result *string `locationName:"result" type:"string"`

	// 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.
	//
	// StartedEventId is a required field
	StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`

	// The child workflow execution that was completed.
	//
	// WorkflowExecution is a required field
	WorkflowExecution *WorkflowExecution `locationName:"workflowExecution" type:"structure" required:"true"`

	// The type of the child workflow execution.
	//
	// WorkflowType is a required field
	WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the ChildWorkflowExecutionCompleted event.

func (ChildWorkflowExecutionCompletedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ChildWorkflowExecutionCompletedEventAttributes) SetInitiatedEventId added in v1.5.0

SetInitiatedEventId sets the InitiatedEventId field's value.

func (*ChildWorkflowExecutionCompletedEventAttributes) SetResult added in v1.5.0

SetResult sets the Result field's value.

func (*ChildWorkflowExecutionCompletedEventAttributes) SetStartedEventId added in v1.5.0

SetStartedEventId sets the StartedEventId field's value.

func (*ChildWorkflowExecutionCompletedEventAttributes) SetWorkflowExecution added in v1.5.0

SetWorkflowExecution sets the WorkflowExecution field's value.

func (*ChildWorkflowExecutionCompletedEventAttributes) SetWorkflowType added in v1.5.0

SetWorkflowType sets the WorkflowType field's value.

func (ChildWorkflowExecutionCompletedEventAttributes) String added in v0.6.5

String returns the string representation

type ChildWorkflowExecutionFailedEventAttributes

type ChildWorkflowExecutionFailedEventAttributes struct {

	// The details of the failure (if provided).
	Details *string `locationName:"details" type:"string"`

	// The ID of the StartChildWorkflowExecutionInitiated event corresponding to
	// the StartChildWorkflowExecutionDecision 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.
	//
	// InitiatedEventId is a required field
	InitiatedEventId *int64 `locationName:"initiatedEventId" type:"long" required:"true"`

	// The reason for the failure (if provided).
	Reason *string `locationName:"reason" type:"string"`

	// 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.
	//
	// StartedEventId is a required field
	StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`

	// The child workflow execution that failed.
	//
	// WorkflowExecution is a required field
	WorkflowExecution *WorkflowExecution `locationName:"workflowExecution" type:"structure" required:"true"`

	// The type of the child workflow execution.
	//
	// WorkflowType is a required field
	WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the ChildWorkflowExecutionFailed event.

func (ChildWorkflowExecutionFailedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ChildWorkflowExecutionFailedEventAttributes) SetDetails added in v1.5.0

SetDetails sets the Details field's value.

func (*ChildWorkflowExecutionFailedEventAttributes) SetInitiatedEventId added in v1.5.0

SetInitiatedEventId sets the InitiatedEventId field's value.

func (*ChildWorkflowExecutionFailedEventAttributes) SetReason added in v1.5.0

SetReason sets the Reason field's value.

func (*ChildWorkflowExecutionFailedEventAttributes) SetStartedEventId added in v1.5.0

SetStartedEventId sets the StartedEventId field's value.

func (*ChildWorkflowExecutionFailedEventAttributes) SetWorkflowExecution added in v1.5.0

SetWorkflowExecution sets the WorkflowExecution field's value.

func (*ChildWorkflowExecutionFailedEventAttributes) SetWorkflowType added in v1.5.0

SetWorkflowType sets the WorkflowType field's value.

func (ChildWorkflowExecutionFailedEventAttributes) String added in v0.6.5

String returns the string representation

type ChildWorkflowExecutionStartedEventAttributes

type ChildWorkflowExecutionStartedEventAttributes struct {

	// The ID of the StartChildWorkflowExecutionInitiated event corresponding to
	// the StartChildWorkflowExecutionDecision 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.
	//
	// InitiatedEventId is a required field
	InitiatedEventId *int64 `locationName:"initiatedEventId" type:"long" required:"true"`

	// The child workflow execution that was started.
	//
	// WorkflowExecution is a required field
	WorkflowExecution *WorkflowExecution `locationName:"workflowExecution" type:"structure" required:"true"`

	// The type of the child workflow execution.
	//
	// WorkflowType is a required field
	WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the ChildWorkflowExecutionStarted event.

func (ChildWorkflowExecutionStartedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ChildWorkflowExecutionStartedEventAttributes) SetInitiatedEventId added in v1.5.0

SetInitiatedEventId sets the InitiatedEventId field's value.

func (*ChildWorkflowExecutionStartedEventAttributes) SetWorkflowExecution added in v1.5.0

SetWorkflowExecution sets the WorkflowExecution field's value.

func (*ChildWorkflowExecutionStartedEventAttributes) SetWorkflowType added in v1.5.0

SetWorkflowType sets the WorkflowType field's value.

func (ChildWorkflowExecutionStartedEventAttributes) String added in v0.6.5

String returns the string representation

type ChildWorkflowExecutionTerminatedEventAttributes

type ChildWorkflowExecutionTerminatedEventAttributes struct {

	// The ID of the StartChildWorkflowExecutionInitiated event corresponding to
	// the StartChildWorkflowExecutionDecision 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.
	//
	// InitiatedEventId is a required field
	InitiatedEventId *int64 `locationName:"initiatedEventId" type:"long" required:"true"`

	// 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.
	//
	// StartedEventId is a required field
	StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`

	// The child workflow execution that was terminated.
	//
	// WorkflowExecution is a required field
	WorkflowExecution *WorkflowExecution `locationName:"workflowExecution" type:"structure" required:"true"`

	// The type of the child workflow execution.
	//
	// WorkflowType is a required field
	WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the ChildWorkflowExecutionTerminated event.

func (ChildWorkflowExecutionTerminatedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ChildWorkflowExecutionTerminatedEventAttributes) SetInitiatedEventId added in v1.5.0

SetInitiatedEventId sets the InitiatedEventId field's value.

func (*ChildWorkflowExecutionTerminatedEventAttributes) SetStartedEventId added in v1.5.0

SetStartedEventId sets the StartedEventId field's value.

func (*ChildWorkflowExecutionTerminatedEventAttributes) SetWorkflowExecution added in v1.5.0

SetWorkflowExecution sets the WorkflowExecution field's value.

func (*ChildWorkflowExecutionTerminatedEventAttributes) SetWorkflowType added in v1.5.0

SetWorkflowType sets the WorkflowType field's value.

func (ChildWorkflowExecutionTerminatedEventAttributes) String added in v0.6.5

String returns the string representation

type ChildWorkflowExecutionTimedOutEventAttributes

type ChildWorkflowExecutionTimedOutEventAttributes struct {

	// The ID of the StartChildWorkflowExecutionInitiated event corresponding to
	// the StartChildWorkflowExecutionDecision 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.
	//
	// InitiatedEventId is a required field
	InitiatedEventId *int64 `locationName:"initiatedEventId" type:"long" required:"true"`

	// 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.
	//
	// StartedEventId is a required field
	StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`

	// The type of the timeout that caused the child workflow execution to time
	// out.
	//
	// TimeoutType is a required field
	TimeoutType *string `locationName:"timeoutType" type:"string" required:"true" enum:"WorkflowExecutionTimeoutType"`

	// The child workflow execution that timed out.
	//
	// WorkflowExecution is a required field
	WorkflowExecution *WorkflowExecution `locationName:"workflowExecution" type:"structure" required:"true"`

	// The type of the child workflow execution.
	//
	// WorkflowType is a required field
	WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the ChildWorkflowExecutionTimedOut event.

func (ChildWorkflowExecutionTimedOutEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ChildWorkflowExecutionTimedOutEventAttributes) SetInitiatedEventId added in v1.5.0

SetInitiatedEventId sets the InitiatedEventId field's value.

func (*ChildWorkflowExecutionTimedOutEventAttributes) SetStartedEventId added in v1.5.0

SetStartedEventId sets the StartedEventId field's value.

func (*ChildWorkflowExecutionTimedOutEventAttributes) SetTimeoutType added in v1.5.0

SetTimeoutType sets the TimeoutType field's value.

func (*ChildWorkflowExecutionTimedOutEventAttributes) SetWorkflowExecution added in v1.5.0

SetWorkflowExecution sets the WorkflowExecution field's value.

func (*ChildWorkflowExecutionTimedOutEventAttributes) SetWorkflowType added in v1.5.0

SetWorkflowType sets the WorkflowType field's value.

func (ChildWorkflowExecutionTimedOutEventAttributes) String added in v0.6.5

String returns the string representation

type CloseStatusFilter

type CloseStatusFilter struct {

	// The close status that must match the close status of an execution for it
	// to meet the criteria of this filter.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"CloseStatus"`
	// contains filtered or unexported fields
}

Used to filter the closed workflow executions in visibility APIs by their close status.

func (CloseStatusFilter) GoString added in v0.6.5

func (s CloseStatusFilter) GoString() string

GoString returns the string representation

func (*CloseStatusFilter) SetStatus added in v1.5.0

func (s *CloseStatusFilter) SetStatus(v string) *CloseStatusFilter

SetStatus sets the Status field's value.

func (CloseStatusFilter) String added in v0.6.5

func (s CloseStatusFilter) String() string

String returns the string representation

func (*CloseStatusFilter) Validate added in v1.1.21

func (s *CloseStatusFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CompleteWorkflowExecutionDecisionAttributes

type CompleteWorkflowExecutionDecisionAttributes struct {

	// The result of the workflow execution. The form of the result is implementation
	// defined.
	Result *string `locationName:"result" type:"string"`
	// contains filtered or unexported fields
}

Provides the details of the CompleteWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

func (CompleteWorkflowExecutionDecisionAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*CompleteWorkflowExecutionDecisionAttributes) SetResult added in v1.5.0

SetResult sets the Result field's value.

func (CompleteWorkflowExecutionDecisionAttributes) String added in v0.6.5

String returns the string representation

type CompleteWorkflowExecutionFailedEventAttributes

type CompleteWorkflowExecutionFailedEventAttributes struct {

	// The cause of the failure. This information is generated by the system and
	// can be useful for diagnostic purposes.
	//
	// 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 (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html)
	// in the Amazon SWF Developer Guide.
	//
	// Cause is a required field
	Cause *string `locationName:"cause" type:"string" required:"true" enum:"CompleteWorkflowExecutionFailedCause"`

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the CompleteWorkflowExecutionFailed event.

func (CompleteWorkflowExecutionFailedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*CompleteWorkflowExecutionFailedEventAttributes) SetCause added in v1.5.0

SetCause sets the Cause field's value.

func (*CompleteWorkflowExecutionFailedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (CompleteWorkflowExecutionFailedEventAttributes) String added in v0.6.5

String returns the string representation

type ContinueAsNewWorkflowExecutionDecisionAttributes

type ContinueAsNewWorkflowExecutionDecisionAttributes struct {

	// If set, specifies the policy to use for the child workflow executions of
	// the new execution if it is terminated by calling the TerminateWorkflowExecution
	// action explicitly or due to an expired timeout. This policy overrides the
	// default child policy specified when registering the workflow type using RegisterWorkflowType.
	//
	// The supported child policies are:
	//
	//    * TERMINATE – The child executions are terminated.
	//
	//    * REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.
	//
	// A child policy for this workflow execution must be specified either as a
	// default for the workflow type or through this parameter. If neither this
	// parameter is set nor a default child policy was specified at registration
	// time then a fault is returned.
	ChildPolicy *string `locationName:"childPolicy" type:"string" enum:"ChildPolicy"`

	// If set, specifies the total duration for this workflow execution. This overrides
	// the defaultExecutionStartToCloseTimeout specified when registering the workflow
	// type.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	//
	// An execution start-to-close timeout for this workflow execution must be specified
	// either as a default for the workflow type or through this field. If neither
	// this field is set nor a default execution start-to-close timeout was specified
	// at registration time then a fault is returned.
	ExecutionStartToCloseTimeout *string `locationName:"executionStartToCloseTimeout" type:"string"`

	// The input provided to the new workflow execution.
	Input *string `locationName:"input" type:"string"`

	// The IAM role to attach to the new (continued) execution.
	LambdaRole *string `locationName:"lambdaRole" min:"1" type:"string"`

	// The list of tags to associate with the new workflow execution. A maximum
	// of 5 tags can be specified. You can list workflow executions with a specific
	// tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions
	// and specifying a TagFilter.
	TagList []*string `locationName:"tagList" type:"list"`

	// The task list to use for the decisions of the new (continued) workflow execution.
	TaskList *TaskList `locationName:"taskList" type:"structure"`

	// The task priority that, if set, specifies the priority for the decision tasks
	// for this workflow execution. This overrides the defaultTaskPriority specified
	// when registering the workflow type. Valid values are integers that range
	// from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647).
	// Higher numbers indicate higher priority.
	//
	// For more information about setting task priority, see Setting Task Priority
	// (http://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html)
	// in the Amazon SWF Developer Guide.
	TaskPriority *string `locationName:"taskPriority" type:"string"`

	// Specifies the maximum duration of decision tasks for the new workflow execution.
	// This parameter overrides the defaultTaskStartToCloseTimout specified when
	// registering the workflow type using RegisterWorkflowType.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	//
	// A task start-to-close timeout for the new workflow execution must be specified
	// either as a default for the workflow type or through this parameter. If neither
	// this parameter is set nor a default task start-to-close timeout was specified
	// at registration time then a fault is returned.
	TaskStartToCloseTimeout *string `locationName:"taskStartToCloseTimeout" type:"string"`

	// The version of the workflow to start.
	WorkflowTypeVersion *string `locationName:"workflowTypeVersion" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides the details of the ContinueAsNewWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

tag – A tag used to identify the workflow execution

taskList – String constraint. The key is swf:taskList.name.

workflowType.version – String constraint. The key is swf:workflowType.version.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

func (ContinueAsNewWorkflowExecutionDecisionAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ContinueAsNewWorkflowExecutionDecisionAttributes) SetChildPolicy added in v1.5.0

SetChildPolicy sets the ChildPolicy field's value.

func (*ContinueAsNewWorkflowExecutionDecisionAttributes) SetExecutionStartToCloseTimeout added in v1.5.0

SetExecutionStartToCloseTimeout sets the ExecutionStartToCloseTimeout field's value.

func (*ContinueAsNewWorkflowExecutionDecisionAttributes) SetInput added in v1.5.0

SetInput sets the Input field's value.

func (*ContinueAsNewWorkflowExecutionDecisionAttributes) SetLambdaRole added in v1.5.0

SetLambdaRole sets the LambdaRole field's value.

func (*ContinueAsNewWorkflowExecutionDecisionAttributes) SetTagList added in v1.5.0

SetTagList sets the TagList field's value.

func (*ContinueAsNewWorkflowExecutionDecisionAttributes) SetTaskList added in v1.5.0

SetTaskList sets the TaskList field's value.

func (*ContinueAsNewWorkflowExecutionDecisionAttributes) SetTaskPriority added in v1.5.0

SetTaskPriority sets the TaskPriority field's value.

func (*ContinueAsNewWorkflowExecutionDecisionAttributes) SetTaskStartToCloseTimeout added in v1.5.0

SetTaskStartToCloseTimeout sets the TaskStartToCloseTimeout field's value.

func (*ContinueAsNewWorkflowExecutionDecisionAttributes) SetWorkflowTypeVersion added in v1.5.0

SetWorkflowTypeVersion sets the WorkflowTypeVersion field's value.

func (ContinueAsNewWorkflowExecutionDecisionAttributes) String added in v0.6.5

String returns the string representation

func (*ContinueAsNewWorkflowExecutionDecisionAttributes) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type ContinueAsNewWorkflowExecutionFailedEventAttributes

type ContinueAsNewWorkflowExecutionFailedEventAttributes struct {

	// The cause of the failure. This information is generated by the system and
	// can be useful for diagnostic purposes.
	//
	// 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 (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html)
	// in the Amazon SWF Developer Guide.
	//
	// Cause is a required field
	Cause *string `locationName:"cause" type:"string" required:"true" enum:"ContinueAsNewWorkflowExecutionFailedCause"`

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the ContinueAsNewWorkflowExecutionFailed event.

func (ContinueAsNewWorkflowExecutionFailedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ContinueAsNewWorkflowExecutionFailedEventAttributes) SetCause added in v1.5.0

SetCause sets the Cause field's value.

func (*ContinueAsNewWorkflowExecutionFailedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (ContinueAsNewWorkflowExecutionFailedEventAttributes) String added in v0.6.5

String returns the string representation

type CountClosedWorkflowExecutionsInput

type CountClosedWorkflowExecutionsInput struct {

	// If specified, only workflow executions that match this close status are counted.
	// This filter has an affect only if executionStatus is specified as CLOSED.
	//
	// closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually
	// exclusive. You can specify at most one of these in a request.
	CloseStatusFilter *CloseStatusFilter `locationName:"closeStatusFilter" type:"structure"`

	// If specified, only workflow executions that meet the close time criteria
	// of the filter are counted.
	//
	// startTimeFilter and closeTimeFilter are mutually exclusive. You must specify
	// one of these in a request but not both.
	CloseTimeFilter *ExecutionTimeFilter `locationName:"closeTimeFilter" type:"structure"`

	// The name of the domain containing the workflow executions to count.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// If specified, only workflow executions matching the WorkflowId in the filter
	// are counted.
	//
	// closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually
	// exclusive. You can specify at most one of these in a request.
	ExecutionFilter *WorkflowExecutionFilter `locationName:"executionFilter" type:"structure"`

	// If specified, only workflow executions that meet the start time criteria
	// of the filter are counted.
	//
	// startTimeFilter and closeTimeFilter are mutually exclusive. You must specify
	// one of these in a request but not both.
	StartTimeFilter *ExecutionTimeFilter `locationName:"startTimeFilter" type:"structure"`

	// If specified, only executions that have a tag that matches the filter are
	// counted.
	//
	// closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually
	// exclusive. You can specify at most one of these in a request.
	TagFilter *TagFilter `locationName:"tagFilter" type:"structure"`

	// If specified, indicates the type of the workflow executions to be counted.
	//
	// closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually
	// exclusive. You can specify at most one of these in a request.
	TypeFilter *WorkflowTypeFilter `locationName:"typeFilter" type:"structure"`
	// contains filtered or unexported fields
}

func (CountClosedWorkflowExecutionsInput) GoString added in v0.6.5

GoString returns the string representation

func (*CountClosedWorkflowExecutionsInput) SetCloseStatusFilter added in v1.5.0

SetCloseStatusFilter sets the CloseStatusFilter field's value.

func (*CountClosedWorkflowExecutionsInput) SetCloseTimeFilter added in v1.5.0

SetCloseTimeFilter sets the CloseTimeFilter field's value.

func (*CountClosedWorkflowExecutionsInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*CountClosedWorkflowExecutionsInput) SetExecutionFilter added in v1.5.0

SetExecutionFilter sets the ExecutionFilter field's value.

func (*CountClosedWorkflowExecutionsInput) SetStartTimeFilter added in v1.5.0

SetStartTimeFilter sets the StartTimeFilter field's value.

func (*CountClosedWorkflowExecutionsInput) SetTagFilter added in v1.5.0

SetTagFilter sets the TagFilter field's value.

func (*CountClosedWorkflowExecutionsInput) SetTypeFilter added in v1.5.0

SetTypeFilter sets the TypeFilter field's value.

func (CountClosedWorkflowExecutionsInput) String added in v0.6.5

String returns the string representation

func (*CountClosedWorkflowExecutionsInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type CountOpenWorkflowExecutionsInput

type CountOpenWorkflowExecutionsInput struct {

	// The name of the domain containing the workflow executions to count.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// If specified, only workflow executions matching the WorkflowId in the filter
	// are counted.
	//
	// executionFilter, typeFilter and tagFilter are mutually exclusive. You can
	// specify at most one of these in a request.
	ExecutionFilter *WorkflowExecutionFilter `locationName:"executionFilter" type:"structure"`

	// Specifies the start time criteria that workflow executions must meet in order
	// to be counted.
	//
	// StartTimeFilter is a required field
	StartTimeFilter *ExecutionTimeFilter `locationName:"startTimeFilter" type:"structure" required:"true"`

	// If specified, only executions that have a tag that matches the filter are
	// counted.
	//
	// executionFilter, typeFilter and tagFilter are mutually exclusive. You can
	// specify at most one of these in a request.
	TagFilter *TagFilter `locationName:"tagFilter" type:"structure"`

	// Specifies the type of the workflow executions to be counted.
	//
	// executionFilter, typeFilter and tagFilter are mutually exclusive. You can
	// specify at most one of these in a request.
	TypeFilter *WorkflowTypeFilter `locationName:"typeFilter" type:"structure"`
	// contains filtered or unexported fields
}

func (CountOpenWorkflowExecutionsInput) GoString added in v0.6.5

GoString returns the string representation

func (*CountOpenWorkflowExecutionsInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*CountOpenWorkflowExecutionsInput) SetExecutionFilter added in v1.5.0

SetExecutionFilter sets the ExecutionFilter field's value.

func (*CountOpenWorkflowExecutionsInput) SetStartTimeFilter added in v1.5.0

SetStartTimeFilter sets the StartTimeFilter field's value.

func (*CountOpenWorkflowExecutionsInput) SetTagFilter added in v1.5.0

SetTagFilter sets the TagFilter field's value.

func (*CountOpenWorkflowExecutionsInput) SetTypeFilter added in v1.5.0

SetTypeFilter sets the TypeFilter field's value.

func (CountOpenWorkflowExecutionsInput) String added in v0.6.5

String returns the string representation

func (*CountOpenWorkflowExecutionsInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type CountPendingActivityTasksInput

type CountPendingActivityTasksInput struct {

	// The name of the domain that contains the task list.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// The name of the task list.
	//
	// TaskList is a required field
	TaskList *TaskList `locationName:"taskList" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CountPendingActivityTasksInput) GoString added in v0.6.5

GoString returns the string representation

func (*CountPendingActivityTasksInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*CountPendingActivityTasksInput) SetTaskList added in v1.5.0

SetTaskList sets the TaskList field's value.

func (CountPendingActivityTasksInput) String added in v0.6.5

String returns the string representation

func (*CountPendingActivityTasksInput) Validate added in v1.1.21

func (s *CountPendingActivityTasksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CountPendingDecisionTasksInput

type CountPendingDecisionTasksInput struct {

	// The name of the domain that contains the task list.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// The name of the task list.
	//
	// TaskList is a required field
	TaskList *TaskList `locationName:"taskList" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CountPendingDecisionTasksInput) GoString added in v0.6.5

GoString returns the string representation

func (*CountPendingDecisionTasksInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*CountPendingDecisionTasksInput) SetTaskList added in v1.5.0

SetTaskList sets the TaskList field's value.

func (CountPendingDecisionTasksInput) String added in v0.6.5

String returns the string representation

func (*CountPendingDecisionTasksInput) Validate added in v1.1.21

func (s *CountPendingDecisionTasksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Decision

type Decision struct {

	// Provides the details of the CancelTimer decision. It isn't set for other
	// decision types.
	CancelTimerDecisionAttributes *CancelTimerDecisionAttributes `locationName:"cancelTimerDecisionAttributes" type:"structure"`

	// Provides the details of the CancelWorkflowExecution decision. It isn't set
	// for other decision types.
	CancelWorkflowExecutionDecisionAttributes *CancelWorkflowExecutionDecisionAttributes `locationName:"cancelWorkflowExecutionDecisionAttributes" type:"structure"`

	// Provides the details of the CompleteWorkflowExecution decision. It isn't
	// set for other decision types.
	CompleteWorkflowExecutionDecisionAttributes *CompleteWorkflowExecutionDecisionAttributes `locationName:"completeWorkflowExecutionDecisionAttributes" type:"structure"`

	// Provides the details of the ContinueAsNewWorkflowExecution decision. It isn't
	// set for other decision types.
	ContinueAsNewWorkflowExecutionDecisionAttributes *ContinueAsNewWorkflowExecutionDecisionAttributes `locationName:"continueAsNewWorkflowExecutionDecisionAttributes" type:"structure"`

	// Specifies the type of the decision.
	//
	// DecisionType is a required field
	DecisionType *string `locationName:"decisionType" type:"string" required:"true" enum:"DecisionType"`

	// Provides the details of the FailWorkflowExecution decision. It isn't set
	// for other decision types.
	FailWorkflowExecutionDecisionAttributes *FailWorkflowExecutionDecisionAttributes `locationName:"failWorkflowExecutionDecisionAttributes" type:"structure"`

	// Provides the details of the RecordMarker decision. It isn't set for other
	// decision types.
	RecordMarkerDecisionAttributes *RecordMarkerDecisionAttributes `locationName:"recordMarkerDecisionAttributes" type:"structure"`

	// Provides the details of the RequestCancelActivityTask decision. It isn't
	// set for other decision types.
	RequestCancelActivityTaskDecisionAttributes *RequestCancelActivityTaskDecisionAttributes `locationName:"requestCancelActivityTaskDecisionAttributes" type:"structure"`

	// Provides the details of the RequestCancelExternalWorkflowExecution decision.
	// It isn't set for other decision types.
	RequestCancelExternalWorkflowExecutionDecisionAttributes *RequestCancelExternalWorkflowExecutionDecisionAttributes `locationName:"requestCancelExternalWorkflowExecutionDecisionAttributes" type:"structure"`

	// Provides the details of the ScheduleActivityTask decision. It isn't set for
	// other decision types.
	ScheduleActivityTaskDecisionAttributes *ScheduleActivityTaskDecisionAttributes `locationName:"scheduleActivityTaskDecisionAttributes" type:"structure"`

	// Provides the details of the ScheduleLambdaFunction decision. It isn't set
	// for other decision types.
	ScheduleLambdaFunctionDecisionAttributes *ScheduleLambdaFunctionDecisionAttributes `locationName:"scheduleLambdaFunctionDecisionAttributes" type:"structure"`

	// Provides the details of the SignalExternalWorkflowExecution decision. It
	// isn't set for other decision types.
	SignalExternalWorkflowExecutionDecisionAttributes *SignalExternalWorkflowExecutionDecisionAttributes `locationName:"signalExternalWorkflowExecutionDecisionAttributes" type:"structure"`

	// Provides the details of the StartChildWorkflowExecution decision. It isn't
	// set for other decision types.
	StartChildWorkflowExecutionDecisionAttributes *StartChildWorkflowExecutionDecisionAttributes `locationName:"startChildWorkflowExecutionDecisionAttributes" type:"structure"`

	// Provides the details of the StartTimer decision. It isn't set for other decision
	// types.
	StartTimerDecisionAttributes *StartTimerDecisionAttributes `locationName:"startTimerDecisionAttributes" type:"structure"`
	// contains filtered or unexported fields
}

Specifies a decision made by the decider. A decision can be one of these types:

  • CancelTimer – Cancels a previously started timer and records a TimerCanceled event in the history.

  • CancelWorkflowExecution – Closes the workflow execution and records a WorkflowExecutionCanceled event in the history.

  • CompleteWorkflowExecution – Closes the workflow execution and records a WorkflowExecutionCompleted event in the history .

  • ContinueAsNewWorkflowExecution – Closes the workflow execution and starts a new workflow execution of the same type using the same workflow ID and a unique run Id. A WorkflowExecutionContinuedAsNew event is recorded in the history.

  • FailWorkflowExecution – Closes the workflow execution and records a WorkflowExecutionFailed event in the history.

  • RecordMarker – Records a MarkerRecorded event in the history. Markers can be used for adding custom information in the history for instance to let deciders know that they don't need to look at the history beyond the marker event.

  • RequestCancelActivityTask – Attempts to cancel a previously scheduled activity task. If the activity task was scheduled but has not been assigned to a worker, then it is canceled. If the activity task was already assigned to a worker, then the worker is informed that cancellation has been requested in the response to RecordActivityTaskHeartbeat.

  • RequestCancelExternalWorkflowExecution – Requests that a request be made to cancel the specified external workflow execution and records a RequestCancelExternalWorkflowExecutionInitiated event in the history.

  • ScheduleActivityTask – Schedules an activity task.

  • SignalExternalWorkflowExecution – Requests a signal to be delivered to the specified external workflow execution and records a SignalExternalWorkflowExecutionInitiated event in the history.

  • StartChildWorkflowExecution – Requests that a child workflow execution be started and records a StartChildWorkflowExecutionInitiated event in the history. The child workflow execution is a separate workflow execution with its own history.

  • StartTimer – Starts a timer for this workflow execution and records a TimerStarted event in the history. This timer fires after the specified delay and record a TimerFired event.

Access Control

If you grant permission to use RespondDecisionTaskCompleted, you can use IAM policies to express permissions for the list of decisions returned by this action as if they were members of the API. Treating decisions as a pseudo API maintains a uniform conceptual model and helps keep policies readable. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Decision Failure

Decisions can fail for several reasons

  • The ordering of decisions should follow a logical flow. Some decisions might not make sense in the current context of the workflow execution and therefore fails.

  • A limit on your account was reached.

  • The decision lacks sufficient permissions.

One of the following events might be added to the history to indicate an error. The event attribute's cause parameter indicates the cause. 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 (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

  • ScheduleActivityTaskFailed – A ScheduleActivityTask decision failed. This could happen if the activity type specified in the decision isn't registered, is in a deprecated state, or the decision isn't properly configured.

  • RequestCancelActivityTaskFailed – A RequestCancelActivityTask decision failed. This could happen if there is no open activity task with the specified activityId.

  • StartTimerFailed – A StartTimer decision failed. This could happen if there is another open timer with the same timerId.

  • CancelTimerFailed – A CancelTimer decision failed. This could happen if there is no open timer with the specified timerId.

  • StartChildWorkflowExecutionFailed – A StartChildWorkflowExecution decision failed. This could happen if the workflow type specified isn't registered, is deprecated, or the decision isn't properly configured.

  • SignalExternalWorkflowExecutionFailed – A SignalExternalWorkflowExecution decision failed. This could happen if the workflowID specified in the decision was incorrect.

  • RequestCancelExternalWorkflowExecutionFailed – A RequestCancelExternalWorkflowExecution decision failed. This could happen if the workflowID specified in the decision was incorrect.

  • CancelWorkflowExecutionFailed – A CancelWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.

  • CompleteWorkflowExecutionFailed – A CompleteWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.

  • ContinueAsNewWorkflowExecutionFailed – A ContinueAsNewWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution or the ContinueAsNewWorkflowExecution decision was not configured correctly.

  • FailWorkflowExecutionFailed – A FailWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.

The preceding error events might occur due to an error in the decider logic, which might put the workflow execution in an unstable state The cause field in the event structure for the error event indicates the cause of the error.

A workflow execution may be closed by the decider by returning one of the following decisions when completing a decision task: CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution and ContinueAsNewWorkflowExecution. An UnhandledDecision fault is returned if a workflow closing decision is specified and a signal or activity event had been added to the history while the decision task was being performed by the decider. Unlike the above situations which are logic issues, this fault is always possible because of race conditions in a distributed system. The right action here is to call RespondDecisionTaskCompleted without any decisions. This would result in another decision task with these new events included in the history. The decider should handle the new events and may decide to close the workflow execution.

How to Code a Decision

You code a decision by first setting the decision type field to one of the above decision values, and then set the corresponding attributes field shown below:

  • ScheduleActivityTaskDecisionAttributes

  • RequestCancelActivityTaskDecisionAttributes

  • CompleteWorkflowExecutionDecisionAttributes

  • FailWorkflowExecutionDecisionAttributes

  • CancelWorkflowExecutionDecisionAttributes

  • ContinueAsNewWorkflowExecutionDecisionAttributes

  • RecordMarkerDecisionAttributes

  • StartTimerDecisionAttributes

  • CancelTimerDecisionAttributes

  • SignalExternalWorkflowExecutionDecisionAttributes

  • RequestCancelExternalWorkflowExecutionDecisionAttributes

  • StartChildWorkflowExecutionDecisionAttributes

func (Decision) GoString added in v0.6.5

func (s Decision) GoString() string

GoString returns the string representation

func (*Decision) SetCancelTimerDecisionAttributes added in v1.5.0

func (s *Decision) SetCancelTimerDecisionAttributes(v *CancelTimerDecisionAttributes) *Decision

SetCancelTimerDecisionAttributes sets the CancelTimerDecisionAttributes field's value.

func (*Decision) SetCancelWorkflowExecutionDecisionAttributes added in v1.5.0

func (s *Decision) SetCancelWorkflowExecutionDecisionAttributes(v *CancelWorkflowExecutionDecisionAttributes) *Decision

SetCancelWorkflowExecutionDecisionAttributes sets the CancelWorkflowExecutionDecisionAttributes field's value.

func (*Decision) SetCompleteWorkflowExecutionDecisionAttributes added in v1.5.0

func (s *Decision) SetCompleteWorkflowExecutionDecisionAttributes(v *CompleteWorkflowExecutionDecisionAttributes) *Decision

SetCompleteWorkflowExecutionDecisionAttributes sets the CompleteWorkflowExecutionDecisionAttributes field's value.

func (*Decision) SetContinueAsNewWorkflowExecutionDecisionAttributes added in v1.5.0

func (s *Decision) SetContinueAsNewWorkflowExecutionDecisionAttributes(v *ContinueAsNewWorkflowExecutionDecisionAttributes) *Decision

SetContinueAsNewWorkflowExecutionDecisionAttributes sets the ContinueAsNewWorkflowExecutionDecisionAttributes field's value.

func (*Decision) SetDecisionType added in v1.5.0

func (s *Decision) SetDecisionType(v string) *Decision

SetDecisionType sets the DecisionType field's value.

func (*Decision) SetFailWorkflowExecutionDecisionAttributes added in v1.5.0

func (s *Decision) SetFailWorkflowExecutionDecisionAttributes(v *FailWorkflowExecutionDecisionAttributes) *Decision

SetFailWorkflowExecutionDecisionAttributes sets the FailWorkflowExecutionDecisionAttributes field's value.

func (*Decision) SetRecordMarkerDecisionAttributes added in v1.5.0

func (s *Decision) SetRecordMarkerDecisionAttributes(v *RecordMarkerDecisionAttributes) *Decision

SetRecordMarkerDecisionAttributes sets the RecordMarkerDecisionAttributes field's value.

func (*Decision) SetRequestCancelActivityTaskDecisionAttributes added in v1.5.0

func (s *Decision) SetRequestCancelActivityTaskDecisionAttributes(v *RequestCancelActivityTaskDecisionAttributes) *Decision

SetRequestCancelActivityTaskDecisionAttributes sets the RequestCancelActivityTaskDecisionAttributes field's value.

func (*Decision) SetRequestCancelExternalWorkflowExecutionDecisionAttributes added in v1.5.0

func (s *Decision) SetRequestCancelExternalWorkflowExecutionDecisionAttributes(v *RequestCancelExternalWorkflowExecutionDecisionAttributes) *Decision

SetRequestCancelExternalWorkflowExecutionDecisionAttributes sets the RequestCancelExternalWorkflowExecutionDecisionAttributes field's value.

func (*Decision) SetScheduleActivityTaskDecisionAttributes added in v1.5.0

func (s *Decision) SetScheduleActivityTaskDecisionAttributes(v *ScheduleActivityTaskDecisionAttributes) *Decision

SetScheduleActivityTaskDecisionAttributes sets the ScheduleActivityTaskDecisionAttributes field's value.

func (*Decision) SetScheduleLambdaFunctionDecisionAttributes added in v1.5.0

func (s *Decision) SetScheduleLambdaFunctionDecisionAttributes(v *ScheduleLambdaFunctionDecisionAttributes) *Decision

SetScheduleLambdaFunctionDecisionAttributes sets the ScheduleLambdaFunctionDecisionAttributes field's value.

func (*Decision) SetSignalExternalWorkflowExecutionDecisionAttributes added in v1.5.0

func (s *Decision) SetSignalExternalWorkflowExecutionDecisionAttributes(v *SignalExternalWorkflowExecutionDecisionAttributes) *Decision

SetSignalExternalWorkflowExecutionDecisionAttributes sets the SignalExternalWorkflowExecutionDecisionAttributes field's value.

func (*Decision) SetStartChildWorkflowExecutionDecisionAttributes added in v1.5.0

func (s *Decision) SetStartChildWorkflowExecutionDecisionAttributes(v *StartChildWorkflowExecutionDecisionAttributes) *Decision

SetStartChildWorkflowExecutionDecisionAttributes sets the StartChildWorkflowExecutionDecisionAttributes field's value.

func (*Decision) SetStartTimerDecisionAttributes added in v1.5.0

func (s *Decision) SetStartTimerDecisionAttributes(v *StartTimerDecisionAttributes) *Decision

SetStartTimerDecisionAttributes sets the StartTimerDecisionAttributes field's value.

func (Decision) String added in v0.6.5

func (s Decision) String() string

String returns the string representation

func (*Decision) Validate added in v1.1.21

func (s *Decision) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DecisionTaskCompletedEventAttributes

type DecisionTaskCompletedEventAttributes struct {

	// User defined context for the workflow execution.
	ExecutionContext *string `locationName:"executionContext" type:"string"`

	// 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.
	//
	// ScheduledEventId is a required field
	ScheduledEventId *int64 `locationName:"scheduledEventId" type:"long" required:"true"`

	// 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.
	//
	// StartedEventId is a required field
	StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the DecisionTaskCompleted event.

func (DecisionTaskCompletedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*DecisionTaskCompletedEventAttributes) SetExecutionContext added in v1.5.0

SetExecutionContext sets the ExecutionContext field's value.

func (*DecisionTaskCompletedEventAttributes) SetScheduledEventId added in v1.5.0

SetScheduledEventId sets the ScheduledEventId field's value.

func (*DecisionTaskCompletedEventAttributes) SetStartedEventId added in v1.5.0

SetStartedEventId sets the StartedEventId field's value.

func (DecisionTaskCompletedEventAttributes) String added in v0.6.5

String returns the string representation

type DecisionTaskScheduledEventAttributes

type DecisionTaskScheduledEventAttributes struct {

	// The maximum duration for this decision task. The task is considered timed
	// out if it doesn't completed within this duration.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	StartToCloseTimeout *string `locationName:"startToCloseTimeout" type:"string"`

	// The name of the task list in which the decision task was scheduled.
	//
	// TaskList is a required field
	TaskList *TaskList `locationName:"taskList" type:"structure" required:"true"`

	// 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 (2147483647). Higher numbers indicate higher priority.
	//
	// For more information about setting task priority, see Setting Task Priority
	// (http://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html)
	// in the Amazon SWF Developer Guide.
	TaskPriority *string `locationName:"taskPriority" type:"string"`
	// contains filtered or unexported fields
}

Provides details about the DecisionTaskScheduled event.

func (DecisionTaskScheduledEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*DecisionTaskScheduledEventAttributes) SetStartToCloseTimeout added in v1.5.0

SetStartToCloseTimeout sets the StartToCloseTimeout field's value.

func (*DecisionTaskScheduledEventAttributes) SetTaskList added in v1.5.0

SetTaskList sets the TaskList field's value.

func (*DecisionTaskScheduledEventAttributes) SetTaskPriority added in v1.5.0

SetTaskPriority sets the TaskPriority field's value.

func (DecisionTaskScheduledEventAttributes) String added in v0.6.5

String returns the string representation

type DecisionTaskStartedEventAttributes

type DecisionTaskStartedEventAttributes struct {

	// Identity of the decider making the request. This enables diagnostic tracing
	// when problems arise. The form of this identity is user defined.
	Identity *string `locationName:"identity" type:"string"`

	// 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.
	//
	// ScheduledEventId is a required field
	ScheduledEventId *int64 `locationName:"scheduledEventId" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the DecisionTaskStarted event.

func (DecisionTaskStartedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*DecisionTaskStartedEventAttributes) SetIdentity added in v1.5.0

SetIdentity sets the Identity field's value.

func (*DecisionTaskStartedEventAttributes) SetScheduledEventId added in v1.5.0

SetScheduledEventId sets the ScheduledEventId field's value.

func (DecisionTaskStartedEventAttributes) String added in v0.6.5

String returns the string representation

type DecisionTaskTimedOutEventAttributes

type DecisionTaskTimedOutEventAttributes struct {

	// 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.
	//
	// ScheduledEventId is a required field
	ScheduledEventId *int64 `locationName:"scheduledEventId" type:"long" required:"true"`

	// 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.
	//
	// StartedEventId is a required field
	StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`

	// The type of timeout that expired before the decision task could be completed.
	//
	// TimeoutType is a required field
	TimeoutType *string `locationName:"timeoutType" type:"string" required:"true" enum:"DecisionTaskTimeoutType"`
	// contains filtered or unexported fields
}

Provides the details of the DecisionTaskTimedOut event.

func (DecisionTaskTimedOutEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*DecisionTaskTimedOutEventAttributes) SetScheduledEventId added in v1.5.0

SetScheduledEventId sets the ScheduledEventId field's value.

func (*DecisionTaskTimedOutEventAttributes) SetStartedEventId added in v1.5.0

SetStartedEventId sets the StartedEventId field's value.

func (*DecisionTaskTimedOutEventAttributes) SetTimeoutType added in v1.5.0

SetTimeoutType sets the TimeoutType field's value.

func (DecisionTaskTimedOutEventAttributes) String added in v0.6.5

String returns the string representation

type DeprecateActivityTypeInput

type DeprecateActivityTypeInput struct {

	// The activity type to deprecate.
	//
	// ActivityType is a required field
	ActivityType *ActivityType `locationName:"activityType" type:"structure" required:"true"`

	// The name of the domain in which the activity type is registered.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeprecateActivityTypeInput) GoString added in v0.6.5

func (s DeprecateActivityTypeInput) GoString() string

GoString returns the string representation

func (*DeprecateActivityTypeInput) SetActivityType added in v1.5.0

SetActivityType sets the ActivityType field's value.

func (*DeprecateActivityTypeInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (DeprecateActivityTypeInput) String added in v0.6.5

String returns the string representation

func (*DeprecateActivityTypeInput) Validate added in v1.1.21

func (s *DeprecateActivityTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeprecateActivityTypeOutput

type DeprecateActivityTypeOutput struct {
	// contains filtered or unexported fields
}

func (DeprecateActivityTypeOutput) GoString added in v0.6.5

func (s DeprecateActivityTypeOutput) GoString() string

GoString returns the string representation

func (DeprecateActivityTypeOutput) String added in v0.6.5

String returns the string representation

type DeprecateDomainInput

type DeprecateDomainInput struct {

	// The name of the domain to deprecate.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeprecateDomainInput) GoString added in v0.6.5

func (s DeprecateDomainInput) GoString() string

GoString returns the string representation

func (*DeprecateDomainInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (DeprecateDomainInput) String added in v0.6.5

func (s DeprecateDomainInput) String() string

String returns the string representation

func (*DeprecateDomainInput) Validate added in v1.1.21

func (s *DeprecateDomainInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeprecateDomainOutput

type DeprecateDomainOutput struct {
	// contains filtered or unexported fields
}

func (DeprecateDomainOutput) GoString added in v0.6.5

func (s DeprecateDomainOutput) GoString() string

GoString returns the string representation

func (DeprecateDomainOutput) String added in v0.6.5

func (s DeprecateDomainOutput) String() string

String returns the string representation

type DeprecateWorkflowTypeInput

type DeprecateWorkflowTypeInput struct {

	// The name of the domain in which the workflow type is registered.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// The workflow type to deprecate.
	//
	// WorkflowType is a required field
	WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeprecateWorkflowTypeInput) GoString added in v0.6.5

func (s DeprecateWorkflowTypeInput) GoString() string

GoString returns the string representation

func (*DeprecateWorkflowTypeInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*DeprecateWorkflowTypeInput) SetWorkflowType added in v1.5.0

SetWorkflowType sets the WorkflowType field's value.

func (DeprecateWorkflowTypeInput) String added in v0.6.5

String returns the string representation

func (*DeprecateWorkflowTypeInput) Validate added in v1.1.21

func (s *DeprecateWorkflowTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeprecateWorkflowTypeOutput

type DeprecateWorkflowTypeOutput struct {
	// contains filtered or unexported fields
}

func (DeprecateWorkflowTypeOutput) GoString added in v0.6.5

func (s DeprecateWorkflowTypeOutput) GoString() string

GoString returns the string representation

func (DeprecateWorkflowTypeOutput) String added in v0.6.5

String returns the string representation

type DescribeActivityTypeInput

type DescribeActivityTypeInput struct {

	// The activity type to get information about. Activity types are identified
	// by the name and version that were supplied when the activity was registered.
	//
	// ActivityType is a required field
	ActivityType *ActivityType `locationName:"activityType" type:"structure" required:"true"`

	// The name of the domain in which the activity type is registered.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeActivityTypeInput) GoString added in v0.6.5

func (s DescribeActivityTypeInput) GoString() string

GoString returns the string representation

func (*DescribeActivityTypeInput) SetActivityType added in v1.5.0

SetActivityType sets the ActivityType field's value.

func (*DescribeActivityTypeInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (DescribeActivityTypeInput) String added in v0.6.5

func (s DescribeActivityTypeInput) String() string

String returns the string representation

func (*DescribeActivityTypeInput) Validate added in v1.1.21

func (s *DescribeActivityTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeActivityTypeOutput

type DescribeActivityTypeOutput struct {

	// The configuration settings registered with the activity type.
	//
	// Configuration is a required field
	Configuration *ActivityTypeConfiguration `locationName:"configuration" type:"structure" required:"true"`

	// General information about the activity type.
	//
	// The status of activity type (returned in the ActivityTypeInfo structure)
	// can be one of the following.
	//
	//    * REGISTERED – The type is registered and available. Workers supporting
	//    this type should be running.
	//
	//    * DEPRECATED – The type was deprecated using DeprecateActivityType, but
	//    is still in use. You should keep workers supporting this type running.
	//    You cannot create new tasks of this type.
	//
	// TypeInfo is a required field
	TypeInfo *ActivityTypeInfo `locationName:"typeInfo" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Detailed information about an activity type.

func (DescribeActivityTypeOutput) GoString added in v0.6.5

func (s DescribeActivityTypeOutput) GoString() string

GoString returns the string representation

func (*DescribeActivityTypeOutput) SetConfiguration added in v1.5.0

SetConfiguration sets the Configuration field's value.

func (*DescribeActivityTypeOutput) SetTypeInfo added in v1.5.0

SetTypeInfo sets the TypeInfo field's value.

func (DescribeActivityTypeOutput) String added in v0.6.5

String returns the string representation

type DescribeDomainInput

type DescribeDomainInput struct {

	// The name of the domain to describe.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDomainInput) GoString added in v0.6.5

func (s DescribeDomainInput) GoString() string

GoString returns the string representation

func (*DescribeDomainInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (DescribeDomainInput) String added in v0.6.5

func (s DescribeDomainInput) String() string

String returns the string representation

func (*DescribeDomainInput) Validate added in v1.1.21

func (s *DescribeDomainInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDomainOutput

type DescribeDomainOutput struct {

	// The domain configuration. Currently, this includes only the domain's retention
	// period.
	//
	// Configuration is a required field
	Configuration *DomainConfiguration `locationName:"configuration" type:"structure" required:"true"`

	// The basic information about a domain, such as its name, status, and description.
	//
	// DomainInfo is a required field
	DomainInfo *DomainInfo `locationName:"domainInfo" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains details of a domain.

func (DescribeDomainOutput) GoString added in v0.6.5

func (s DescribeDomainOutput) GoString() string

GoString returns the string representation

func (*DescribeDomainOutput) SetConfiguration added in v1.5.0

SetConfiguration sets the Configuration field's value.

func (*DescribeDomainOutput) SetDomainInfo added in v1.5.0

SetDomainInfo sets the DomainInfo field's value.

func (DescribeDomainOutput) String added in v0.6.5

func (s DescribeDomainOutput) String() string

String returns the string representation

type DescribeWorkflowExecutionInput

type DescribeWorkflowExecutionInput struct {

	// The name of the domain containing the workflow execution.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// The workflow execution to describe.
	//
	// Execution is a required field
	Execution *WorkflowExecution `locationName:"execution" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeWorkflowExecutionInput) GoString added in v0.6.5

GoString returns the string representation

func (*DescribeWorkflowExecutionInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*DescribeWorkflowExecutionInput) SetExecution added in v1.5.0

SetExecution sets the Execution field's value.

func (DescribeWorkflowExecutionInput) String added in v0.6.5

String returns the string representation

func (*DescribeWorkflowExecutionInput) Validate added in v1.1.21

func (s *DescribeWorkflowExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeWorkflowExecutionOutput

type DescribeWorkflowExecutionOutput struct {

	// The configuration settings for this workflow execution including timeout
	// values, tasklist etc.
	//
	// ExecutionConfiguration is a required field
	ExecutionConfiguration *WorkflowExecutionConfiguration `locationName:"executionConfiguration" type:"structure" required:"true"`

	// Information about the workflow execution.
	//
	// ExecutionInfo is a required field
	ExecutionInfo *WorkflowExecutionInfo `locationName:"executionInfo" type:"structure" required:"true"`

	// The time when the last activity task was scheduled for this workflow execution.
	// You can use this information to determine if the workflow has not made progress
	// for an unusually long period of time and might require a corrective action.
	LatestActivityTaskTimestamp *time.Time `locationName:"latestActivityTaskTimestamp" type:"timestamp" timestampFormat:"unix"`

	// The latest executionContext provided by the decider for this workflow execution.
	// A decider can provide an executionContext (a free-form string) when closing
	// a decision task using RespondDecisionTaskCompleted.
	LatestExecutionContext *string `locationName:"latestExecutionContext" type:"string"`

	// The number of tasks for this workflow execution. This includes open and closed
	// tasks of all types.
	//
	// OpenCounts is a required field
	OpenCounts *WorkflowExecutionOpenCounts `locationName:"openCounts" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains details about a workflow execution.

func (DescribeWorkflowExecutionOutput) GoString added in v0.6.5

GoString returns the string representation

func (*DescribeWorkflowExecutionOutput) SetExecutionConfiguration added in v1.5.0

SetExecutionConfiguration sets the ExecutionConfiguration field's value.

func (*DescribeWorkflowExecutionOutput) SetExecutionInfo added in v1.5.0

SetExecutionInfo sets the ExecutionInfo field's value.

func (*DescribeWorkflowExecutionOutput) SetLatestActivityTaskTimestamp added in v1.5.0

func (s *DescribeWorkflowExecutionOutput) SetLatestActivityTaskTimestamp(v time.Time) *DescribeWorkflowExecutionOutput

SetLatestActivityTaskTimestamp sets the LatestActivityTaskTimestamp field's value.

func (*DescribeWorkflowExecutionOutput) SetLatestExecutionContext added in v1.5.0

SetLatestExecutionContext sets the LatestExecutionContext field's value.

func (*DescribeWorkflowExecutionOutput) SetOpenCounts added in v1.5.0

SetOpenCounts sets the OpenCounts field's value.

func (DescribeWorkflowExecutionOutput) String added in v0.6.5

String returns the string representation

type DescribeWorkflowTypeInput

type DescribeWorkflowTypeInput struct {

	// The name of the domain in which this workflow type is registered.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// The workflow type to describe.
	//
	// WorkflowType is a required field
	WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeWorkflowTypeInput) GoString added in v0.6.5

func (s DescribeWorkflowTypeInput) GoString() string

GoString returns the string representation

func (*DescribeWorkflowTypeInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*DescribeWorkflowTypeInput) SetWorkflowType added in v1.5.0

SetWorkflowType sets the WorkflowType field's value.

func (DescribeWorkflowTypeInput) String added in v0.6.5

func (s DescribeWorkflowTypeInput) String() string

String returns the string representation

func (*DescribeWorkflowTypeInput) Validate added in v1.1.21

func (s *DescribeWorkflowTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeWorkflowTypeOutput

type DescribeWorkflowTypeOutput struct {

	// Configuration settings of the workflow type registered through RegisterWorkflowType
	//
	// Configuration is a required field
	Configuration *WorkflowTypeConfiguration `locationName:"configuration" type:"structure" required:"true"`

	// General information about the workflow type.
	//
	// The status of the workflow type (returned in the WorkflowTypeInfo structure)
	// can be one of the following.
	//
	//    * REGISTERED – The type is registered and available. Workers supporting
	//    this type should be running.
	//
	//    * DEPRECATED – The type was deprecated using DeprecateWorkflowType, but
	//    is still in use. You should keep workers supporting this type running.
	//    You cannot create new workflow executions of this type.
	//
	// TypeInfo is a required field
	TypeInfo *WorkflowTypeInfo `locationName:"typeInfo" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains details about a workflow type.

func (DescribeWorkflowTypeOutput) GoString added in v0.6.5

func (s DescribeWorkflowTypeOutput) GoString() string

GoString returns the string representation

func (*DescribeWorkflowTypeOutput) SetConfiguration added in v1.5.0

SetConfiguration sets the Configuration field's value.

func (*DescribeWorkflowTypeOutput) SetTypeInfo added in v1.5.0

SetTypeInfo sets the TypeInfo field's value.

func (DescribeWorkflowTypeOutput) String added in v0.6.5

String returns the string representation

type DomainConfiguration

type DomainConfiguration struct {

	// The retention period for workflow executions in this domain.
	//
	// WorkflowExecutionRetentionPeriodInDays is a required field
	WorkflowExecutionRetentionPeriodInDays *string `locationName:"workflowExecutionRetentionPeriodInDays" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the configuration settings of a domain.

func (DomainConfiguration) GoString added in v0.6.5

func (s DomainConfiguration) GoString() string

GoString returns the string representation

func (*DomainConfiguration) SetWorkflowExecutionRetentionPeriodInDays added in v1.5.0

func (s *DomainConfiguration) SetWorkflowExecutionRetentionPeriodInDays(v string) *DomainConfiguration

SetWorkflowExecutionRetentionPeriodInDays sets the WorkflowExecutionRetentionPeriodInDays field's value.

func (DomainConfiguration) String added in v0.6.5

func (s DomainConfiguration) String() string

String returns the string representation

type DomainInfo

type DomainInfo struct {

	// The description of the domain provided through RegisterDomain.
	Description *string `locationName:"description" type:"string"`

	// The name of the domain. This name is unique within the account.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The status of the domain:
	//
	//    * REGISTERED – The domain is properly registered and available. You can
	//    use this domain for registering types and creating new workflow executions.
	//
	//
	//    * DEPRECATED – The domain was deprecated using DeprecateDomain, but is
	//    still in use. You should not create new workflow executions in this domain.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"RegistrationStatus"`
	// contains filtered or unexported fields
}

Contains general information about a domain.

func (DomainInfo) GoString added in v0.6.5

func (s DomainInfo) GoString() string

GoString returns the string representation

func (*DomainInfo) SetDescription added in v1.5.0

func (s *DomainInfo) SetDescription(v string) *DomainInfo

SetDescription sets the Description field's value.

func (*DomainInfo) SetName added in v1.5.0

func (s *DomainInfo) SetName(v string) *DomainInfo

SetName sets the Name field's value.

func (*DomainInfo) SetStatus added in v1.5.0

func (s *DomainInfo) SetStatus(v string) *DomainInfo

SetStatus sets the Status field's value.

func (DomainInfo) String added in v0.6.5

func (s DomainInfo) String() string

String returns the string representation

type ExecutionTimeFilter

type ExecutionTimeFilter struct {

	// Specifies the latest start or close date and time to return.
	LatestDate *time.Time `locationName:"latestDate" type:"timestamp" timestampFormat:"unix"`

	// Specifies the oldest start or close date and time to return.
	//
	// OldestDate is a required field
	OldestDate *time.Time `locationName:"oldestDate" type:"timestamp" timestampFormat:"unix" required:"true"`
	// contains filtered or unexported fields
}

Used to filter the workflow executions in visibility APIs by various time-based rules. Each parameter, if specified, defines a rule that must be satisfied by each returned query result. The parameter values are in the Unix Time format (https://en.wikipedia.org/wiki/Unix_time). For example: "oldestDate": 1325376070.

func (ExecutionTimeFilter) GoString added in v0.6.5

func (s ExecutionTimeFilter) GoString() string

GoString returns the string representation

func (*ExecutionTimeFilter) SetLatestDate added in v1.5.0

func (s *ExecutionTimeFilter) SetLatestDate(v time.Time) *ExecutionTimeFilter

SetLatestDate sets the LatestDate field's value.

func (*ExecutionTimeFilter) SetOldestDate added in v1.5.0

func (s *ExecutionTimeFilter) SetOldestDate(v time.Time) *ExecutionTimeFilter

SetOldestDate sets the OldestDate field's value.

func (ExecutionTimeFilter) String added in v0.6.5

func (s ExecutionTimeFilter) String() string

String returns the string representation

func (*ExecutionTimeFilter) Validate added in v1.1.21

func (s *ExecutionTimeFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExternalWorkflowExecutionCancelRequestedEventAttributes

type ExternalWorkflowExecutionCancelRequestedEventAttributes struct {

	// 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.
	//
	// InitiatedEventId is a required field
	InitiatedEventId *int64 `locationName:"initiatedEventId" type:"long" required:"true"`

	// The external workflow execution to which the cancellation request was delivered.
	//
	// WorkflowExecution is a required field
	WorkflowExecution *WorkflowExecution `locationName:"workflowExecution" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the ExternalWorkflowExecutionCancelRequested event.

func (ExternalWorkflowExecutionCancelRequestedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ExternalWorkflowExecutionCancelRequestedEventAttributes) SetInitiatedEventId added in v1.5.0

SetInitiatedEventId sets the InitiatedEventId field's value.

func (*ExternalWorkflowExecutionCancelRequestedEventAttributes) SetWorkflowExecution added in v1.5.0

SetWorkflowExecution sets the WorkflowExecution field's value.

func (ExternalWorkflowExecutionCancelRequestedEventAttributes) String added in v0.6.5

String returns the string representation

type ExternalWorkflowExecutionSignaledEventAttributes

type ExternalWorkflowExecutionSignaledEventAttributes struct {

	// 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.
	//
	// InitiatedEventId is a required field
	InitiatedEventId *int64 `locationName:"initiatedEventId" type:"long" required:"true"`

	// The external workflow execution that the signal was delivered to.
	//
	// WorkflowExecution is a required field
	WorkflowExecution *WorkflowExecution `locationName:"workflowExecution" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the ExternalWorkflowExecutionSignaled event.

func (ExternalWorkflowExecutionSignaledEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ExternalWorkflowExecutionSignaledEventAttributes) SetInitiatedEventId added in v1.5.0

SetInitiatedEventId sets the InitiatedEventId field's value.

func (*ExternalWorkflowExecutionSignaledEventAttributes) SetWorkflowExecution added in v1.5.0

SetWorkflowExecution sets the WorkflowExecution field's value.

func (ExternalWorkflowExecutionSignaledEventAttributes) String added in v0.6.5

String returns the string representation

type FailWorkflowExecutionDecisionAttributes

type FailWorkflowExecutionDecisionAttributes struct {

	// Details of the failure.
	Details *string `locationName:"details" type:"string"`

	// A descriptive reason for the failure that may help in diagnostics.
	Reason *string `locationName:"reason" type:"string"`
	// contains filtered or unexported fields
}

Provides the details of the FailWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

func (FailWorkflowExecutionDecisionAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*FailWorkflowExecutionDecisionAttributes) SetDetails added in v1.5.0

SetDetails sets the Details field's value.

func (*FailWorkflowExecutionDecisionAttributes) SetReason added in v1.5.0

SetReason sets the Reason field's value.

func (FailWorkflowExecutionDecisionAttributes) String added in v0.6.5

String returns the string representation

type FailWorkflowExecutionFailedEventAttributes

type FailWorkflowExecutionFailedEventAttributes struct {

	// The cause of the failure. This information is generated by the system and
	// can be useful for diagnostic purposes.
	//
	// 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 (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html)
	// in the Amazon SWF Developer Guide.
	//
	// Cause is a required field
	Cause *string `locationName:"cause" type:"string" required:"true" enum:"FailWorkflowExecutionFailedCause"`

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the FailWorkflowExecutionFailed event.

func (FailWorkflowExecutionFailedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*FailWorkflowExecutionFailedEventAttributes) SetCause added in v1.5.0

SetCause sets the Cause field's value.

func (*FailWorkflowExecutionFailedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (FailWorkflowExecutionFailedEventAttributes) String added in v0.6.5

String returns the string representation

type GetWorkflowExecutionHistoryInput

type GetWorkflowExecutionHistoryInput struct {

	// The name of the domain containing the workflow execution.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// Specifies the workflow execution for which to return the history.
	//
	// Execution is a required field
	Execution *WorkflowExecution `locationName:"execution" type:"structure" required:"true"`

	// The maximum number of results that are returned per call. nextPageToken can
	// be used to obtain futher pages of results. The default is 1000, which is
	// the maximum allowed page size. You can, however, specify a page size smaller
	// than the maximum.
	//
	// This is an upper limit only; the actual number of results returned per call
	// may be fewer than the specified maximum.
	MaximumPageSize *int64 `locationName:"maximumPageSize" type:"integer"`

	// 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.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`

	// 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.
	ReverseOrder *bool `locationName:"reverseOrder" type:"boolean"`
	// contains filtered or unexported fields
}

func (GetWorkflowExecutionHistoryInput) GoString added in v0.6.5

GoString returns the string representation

func (*GetWorkflowExecutionHistoryInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*GetWorkflowExecutionHistoryInput) SetExecution added in v1.5.0

SetExecution sets the Execution field's value.

func (*GetWorkflowExecutionHistoryInput) SetMaximumPageSize added in v1.5.0

SetMaximumPageSize sets the MaximumPageSize field's value.

func (*GetWorkflowExecutionHistoryInput) SetNextPageToken added in v1.5.0

SetNextPageToken sets the NextPageToken field's value.

func (*GetWorkflowExecutionHistoryInput) SetReverseOrder added in v1.5.0

SetReverseOrder sets the ReverseOrder field's value.

func (GetWorkflowExecutionHistoryInput) String added in v0.6.5

String returns the string representation

func (*GetWorkflowExecutionHistoryInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type GetWorkflowExecutionHistoryOutput

type GetWorkflowExecutionHistoryOutput struct {

	// The list of history events.
	//
	// Events is a required field
	Events []*HistoryEvent `locationName:"events" type:"list" required:"true"`

	// 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.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of the events related to all tasks and events in the life of the workflow execution.

func (GetWorkflowExecutionHistoryOutput) GoString added in v0.6.5

GoString returns the string representation

func (*GetWorkflowExecutionHistoryOutput) SetEvents added in v1.5.0

SetEvents sets the Events field's value.

func (*GetWorkflowExecutionHistoryOutput) SetNextPageToken added in v1.5.0

SetNextPageToken sets the NextPageToken field's value.

func (GetWorkflowExecutionHistoryOutput) String added in v0.6.5

String returns the string representation

type HistoryEvent

type HistoryEvent struct {

	// If the event is of type ActivityTaskcancelRequested then this member is set
	// and provides detailed information about the event. It isn't set for other
	// event types.
	ActivityTaskCancelRequestedEventAttributes *ActivityTaskCancelRequestedEventAttributes `locationName:"activityTaskCancelRequestedEventAttributes" type:"structure"`

	// If the event is of type ActivityTaskCanceled then this member is set and
	// provides detailed information about the event. It isn't set for other event
	// types.
	ActivityTaskCanceledEventAttributes *ActivityTaskCanceledEventAttributes `locationName:"activityTaskCanceledEventAttributes" type:"structure"`

	// If the event is of type ActivityTaskCompleted then this member is set and
	// provides detailed information about the event. It isn't set for other event
	// types.
	ActivityTaskCompletedEventAttributes *ActivityTaskCompletedEventAttributes `locationName:"activityTaskCompletedEventAttributes" type:"structure"`

	// If the event is of type ActivityTaskFailed then this member is set and provides
	// detailed information about the event. It isn't set for other event types.
	ActivityTaskFailedEventAttributes *ActivityTaskFailedEventAttributes `locationName:"activityTaskFailedEventAttributes" type:"structure"`

	// If the event is of type ActivityTaskScheduled then this member is set and
	// provides detailed information about the event. It isn't set for other event
	// types.
	ActivityTaskScheduledEventAttributes *ActivityTaskScheduledEventAttributes `locationName:"activityTaskScheduledEventAttributes" type:"structure"`

	// If the event is of type ActivityTaskStarted then this member is set and provides
	// detailed information about the event. It isn't set for other event types.
	ActivityTaskStartedEventAttributes *ActivityTaskStartedEventAttributes `locationName:"activityTaskStartedEventAttributes" type:"structure"`

	// If the event is of type ActivityTaskTimedOut then this member is set and
	// provides detailed information about the event. It isn't set for other event
	// types.
	ActivityTaskTimedOutEventAttributes *ActivityTaskTimedOutEventAttributes `locationName:"activityTaskTimedOutEventAttributes" type:"structure"`

	// If the event is of type CancelTimerFailed then this member is set and provides
	// detailed information about the event. It isn't set for other event types.
	CancelTimerFailedEventAttributes *CancelTimerFailedEventAttributes `locationName:"cancelTimerFailedEventAttributes" type:"structure"`

	// If the event is of type CancelWorkflowExecutionFailed then this member is
	// set and provides detailed information about the event. It isn't set for other
	// event types.
	CancelWorkflowExecutionFailedEventAttributes *CancelWorkflowExecutionFailedEventAttributes `locationName:"cancelWorkflowExecutionFailedEventAttributes" type:"structure"`

	// If the event is of type ChildWorkflowExecutionCanceled then this member is
	// set and provides detailed information about the event. It isn't set for other
	// event types.
	ChildWorkflowExecutionCanceledEventAttributes *ChildWorkflowExecutionCanceledEventAttributes `locationName:"childWorkflowExecutionCanceledEventAttributes" type:"structure"`

	// If the event is of type ChildWorkflowExecutionCompleted then this member
	// is set and provides detailed information about the event. It isn't set for
	// other event types.
	ChildWorkflowExecutionCompletedEventAttributes *ChildWorkflowExecutionCompletedEventAttributes `locationName:"childWorkflowExecutionCompletedEventAttributes" type:"structure"`

	// If the event is of type ChildWorkflowExecutionFailed then this member is
	// set and provides detailed information about the event. It isn't set for other
	// event types.
	ChildWorkflowExecutionFailedEventAttributes *ChildWorkflowExecutionFailedEventAttributes `locationName:"childWorkflowExecutionFailedEventAttributes" type:"structure"`

	// If the event is of type ChildWorkflowExecutionStarted then this member is
	// set and provides detailed information about the event. It isn't set for other
	// event types.
	ChildWorkflowExecutionStartedEventAttributes *ChildWorkflowExecutionStartedEventAttributes `locationName:"childWorkflowExecutionStartedEventAttributes" type:"structure"`

	// If the event is of type ChildWorkflowExecutionTerminated then this member
	// is set and provides detailed information about the event. It isn't set for
	// other event types.
	ChildWorkflowExecutionTerminatedEventAttributes *ChildWorkflowExecutionTerminatedEventAttributes `locationName:"childWorkflowExecutionTerminatedEventAttributes" type:"structure"`

	// If the event is of type ChildWorkflowExecutionTimedOut then this member is
	// set and provides detailed information about the event. It isn't set for other
	// event types.
	ChildWorkflowExecutionTimedOutEventAttributes *ChildWorkflowExecutionTimedOutEventAttributes `locationName:"childWorkflowExecutionTimedOutEventAttributes" type:"structure"`

	// If the event is of type CompleteWorkflowExecutionFailed then this member
	// is set and provides detailed information about the event. It isn't set for
	// other event types.
	CompleteWorkflowExecutionFailedEventAttributes *CompleteWorkflowExecutionFailedEventAttributes `locationName:"completeWorkflowExecutionFailedEventAttributes" type:"structure"`

	// If the event is of type ContinueAsNewWorkflowExecutionFailed then this member
	// is set and provides detailed information about the event. It isn't set for
	// other event types.
	ContinueAsNewWorkflowExecutionFailedEventAttributes *ContinueAsNewWorkflowExecutionFailedEventAttributes `locationName:"continueAsNewWorkflowExecutionFailedEventAttributes" type:"structure"`

	// If the event is of type DecisionTaskCompleted then this member is set and
	// provides detailed information about the event. It isn't set for other event
	// types.
	DecisionTaskCompletedEventAttributes *DecisionTaskCompletedEventAttributes `locationName:"decisionTaskCompletedEventAttributes" type:"structure"`

	// If the event is of type DecisionTaskScheduled then this member is set and
	// provides detailed information about the event. It isn't set for other event
	// types.
	DecisionTaskScheduledEventAttributes *DecisionTaskScheduledEventAttributes `locationName:"decisionTaskScheduledEventAttributes" type:"structure"`

	// If the event is of type DecisionTaskStarted then this member is set and provides
	// detailed information about the event. It isn't set for other event types.
	DecisionTaskStartedEventAttributes *DecisionTaskStartedEventAttributes `locationName:"decisionTaskStartedEventAttributes" type:"structure"`

	// If the event is of type DecisionTaskTimedOut then this member is set and
	// provides detailed information about the event. It isn't set for other event
	// types.
	DecisionTaskTimedOutEventAttributes *DecisionTaskTimedOutEventAttributes `locationName:"decisionTaskTimedOutEventAttributes" type:"structure"`

	// The system generated ID of the event. This ID uniquely identifies the event
	// with in the workflow execution history.
	//
	// EventId is a required field
	EventId *int64 `locationName:"eventId" type:"long" required:"true"`

	// The date and time when the event occurred.
	//
	// EventTimestamp is a required field
	EventTimestamp *time.Time `locationName:"eventTimestamp" type:"timestamp" timestampFormat:"unix" required:"true"`

	// The type of the history event.
	//
	// EventType is a required field
	EventType *string `locationName:"eventType" type:"string" required:"true" enum:"EventType"`

	// If the event is of type ExternalWorkflowExecutionCancelRequested then this
	// member is set and provides detailed information about the event. It isn't
	// set for other event types.
	ExternalWorkflowExecutionCancelRequestedEventAttributes *ExternalWorkflowExecutionCancelRequestedEventAttributes `locationName:"externalWorkflowExecutionCancelRequestedEventAttributes" type:"structure"`

	// If the event is of type ExternalWorkflowExecutionSignaled then this member
	// is set and provides detailed information about the event. It isn't set for
	// other event types.
	ExternalWorkflowExecutionSignaledEventAttributes *ExternalWorkflowExecutionSignaledEventAttributes `locationName:"externalWorkflowExecutionSignaledEventAttributes" type:"structure"`

	// If the event is of type FailWorkflowExecutionFailed then this member is set
	// and provides detailed information about the event. It isn't set for other
	// event types.
	FailWorkflowExecutionFailedEventAttributes *FailWorkflowExecutionFailedEventAttributes `locationName:"failWorkflowExecutionFailedEventAttributes" type:"structure"`

	// Provides the details of the LambdaFunctionCompleted event. It isn't set for
	// other event types.
	LambdaFunctionCompletedEventAttributes *LambdaFunctionCompletedEventAttributes `locationName:"lambdaFunctionCompletedEventAttributes" type:"structure"`

	// Provides the details of the LambdaFunctionFailed event. It isn't set for
	// other event types.
	LambdaFunctionFailedEventAttributes *LambdaFunctionFailedEventAttributes `locationName:"lambdaFunctionFailedEventAttributes" type:"structure"`

	// Provides the details of the LambdaFunctionScheduled event. It isn't set for
	// other event types.
	LambdaFunctionScheduledEventAttributes *LambdaFunctionScheduledEventAttributes `locationName:"lambdaFunctionScheduledEventAttributes" type:"structure"`

	// Provides the details of the LambdaFunctionStarted event. It isn't set for
	// other event types.
	LambdaFunctionStartedEventAttributes *LambdaFunctionStartedEventAttributes `locationName:"lambdaFunctionStartedEventAttributes" type:"structure"`

	// Provides the details of the LambdaFunctionTimedOut event. It isn't set for
	// other event types.
	LambdaFunctionTimedOutEventAttributes *LambdaFunctionTimedOutEventAttributes `locationName:"lambdaFunctionTimedOutEventAttributes" type:"structure"`

	// If the event is of type MarkerRecorded then this member is set and provides
	// detailed information about the event. It isn't set for other event types.
	MarkerRecordedEventAttributes *MarkerRecordedEventAttributes `locationName:"markerRecordedEventAttributes" type:"structure"`

	// If the event is of type DecisionTaskFailed then this member is set and provides
	// detailed information about the event. It isn't set for other event types.
	RecordMarkerFailedEventAttributes *RecordMarkerFailedEventAttributes `locationName:"recordMarkerFailedEventAttributes" type:"structure"`

	// If the event is of type RequestCancelActivityTaskFailed then this member
	// is set and provides detailed information about the event. It isn't set for
	// other event types.
	RequestCancelActivityTaskFailedEventAttributes *RequestCancelActivityTaskFailedEventAttributes `locationName:"requestCancelActivityTaskFailedEventAttributes" type:"structure"`

	// If the event is of type RequestCancelExternalWorkflowExecutionFailed then
	// this member is set and provides detailed information about the event. It
	// isn't set for other event types.
	RequestCancelExternalWorkflowExecutionFailedEventAttributes *RequestCancelExternalWorkflowExecutionFailedEventAttributes `locationName:"requestCancelExternalWorkflowExecutionFailedEventAttributes" type:"structure"`

	// If the event is of type RequestCancelExternalWorkflowExecutionInitiated then
	// this member is set and provides detailed information about the event. It
	// isn't set for other event types.
	RequestCancelExternalWorkflowExecutionInitiatedEventAttributes *RequestCancelExternalWorkflowExecutionInitiatedEventAttributes `locationName:"requestCancelExternalWorkflowExecutionInitiatedEventAttributes" type:"structure"`

	// If the event is of type ScheduleActivityTaskFailed then this member is set
	// and provides detailed information about the event. It isn't set for other
	// event types.
	ScheduleActivityTaskFailedEventAttributes *ScheduleActivityTaskFailedEventAttributes `locationName:"scheduleActivityTaskFailedEventAttributes" type:"structure"`

	// Provides the details of the ScheduleLambdaFunctionFailed event. It isn't
	// set for other event types.
	ScheduleLambdaFunctionFailedEventAttributes *ScheduleLambdaFunctionFailedEventAttributes `locationName:"scheduleLambdaFunctionFailedEventAttributes" type:"structure"`

	// If the event is of type SignalExternalWorkflowExecutionFailed then this member
	// is set and provides detailed information about the event. It isn't set for
	// other event types.
	SignalExternalWorkflowExecutionFailedEventAttributes *SignalExternalWorkflowExecutionFailedEventAttributes `locationName:"signalExternalWorkflowExecutionFailedEventAttributes" type:"structure"`

	// If the event is of type SignalExternalWorkflowExecutionInitiated then this
	// member is set and provides detailed information about the event. It isn't
	// set for other event types.
	SignalExternalWorkflowExecutionInitiatedEventAttributes *SignalExternalWorkflowExecutionInitiatedEventAttributes `locationName:"signalExternalWorkflowExecutionInitiatedEventAttributes" type:"structure"`

	// If the event is of type StartChildWorkflowExecutionFailed then this member
	// is set and provides detailed information about the event. It isn't set for
	// other event types.
	StartChildWorkflowExecutionFailedEventAttributes *StartChildWorkflowExecutionFailedEventAttributes `locationName:"startChildWorkflowExecutionFailedEventAttributes" type:"structure"`

	// If the event is of type StartChildWorkflowExecutionInitiated then this member
	// is set and provides detailed information about the event. It isn't set for
	// other event types.
	StartChildWorkflowExecutionInitiatedEventAttributes *StartChildWorkflowExecutionInitiatedEventAttributes `locationName:"startChildWorkflowExecutionInitiatedEventAttributes" type:"structure"`

	// Provides the details of the StartLambdaFunctionFailed event. It isn't set
	// for other event types.
	StartLambdaFunctionFailedEventAttributes *StartLambdaFunctionFailedEventAttributes `locationName:"startLambdaFunctionFailedEventAttributes" type:"structure"`

	// If the event is of type StartTimerFailed then this member is set and provides
	// detailed information about the event. It isn't set for other event types.
	StartTimerFailedEventAttributes *StartTimerFailedEventAttributes `locationName:"startTimerFailedEventAttributes" type:"structure"`

	// If the event is of type TimerCanceled then this member is set and provides
	// detailed information about the event. It isn't set for other event types.
	TimerCanceledEventAttributes *TimerCanceledEventAttributes `locationName:"timerCanceledEventAttributes" type:"structure"`

	// If the event is of type TimerFired then this member is set and provides detailed
	// information about the event. It isn't set for other event types.
	TimerFiredEventAttributes *TimerFiredEventAttributes `locationName:"timerFiredEventAttributes" type:"structure"`

	// If the event is of type TimerStarted then this member is set and provides
	// detailed information about the event. It isn't set for other event types.
	TimerStartedEventAttributes *TimerStartedEventAttributes `locationName:"timerStartedEventAttributes" type:"structure"`

	// If the event is of type WorkflowExecutionCancelRequested then this member
	// is set and provides detailed information about the event. It isn't set for
	// other event types.
	WorkflowExecutionCancelRequestedEventAttributes *WorkflowExecutionCancelRequestedEventAttributes `locationName:"workflowExecutionCancelRequestedEventAttributes" type:"structure"`

	// If the event is of type WorkflowExecutionCanceled then this member is set
	// and provides detailed information about the event. It isn't set for other
	// event types.
	WorkflowExecutionCanceledEventAttributes *WorkflowExecutionCanceledEventAttributes `locationName:"workflowExecutionCanceledEventAttributes" type:"structure"`

	// If the event is of type WorkflowExecutionCompleted then this member is set
	// and provides detailed information about the event. It isn't set for other
	// event types.
	WorkflowExecutionCompletedEventAttributes *WorkflowExecutionCompletedEventAttributes `locationName:"workflowExecutionCompletedEventAttributes" type:"structure"`

	// If the event is of type WorkflowExecutionContinuedAsNew then this member
	// is set and provides detailed information about the event. It isn't set for
	// other event types.
	WorkflowExecutionContinuedAsNewEventAttributes *WorkflowExecutionContinuedAsNewEventAttributes `locationName:"workflowExecutionContinuedAsNewEventAttributes" type:"structure"`

	// If the event is of type WorkflowExecutionFailed then this member is set and
	// provides detailed information about the event. It isn't set for other event
	// types.
	WorkflowExecutionFailedEventAttributes *WorkflowExecutionFailedEventAttributes `locationName:"workflowExecutionFailedEventAttributes" type:"structure"`

	// If the event is of type WorkflowExecutionSignaled then this member is set
	// and provides detailed information about the event. It isn't set for other
	// event types.
	WorkflowExecutionSignaledEventAttributes *WorkflowExecutionSignaledEventAttributes `locationName:"workflowExecutionSignaledEventAttributes" type:"structure"`

	// If the event is of type WorkflowExecutionStarted then this member is set
	// and provides detailed information about the event. It isn't set for other
	// event types.
	WorkflowExecutionStartedEventAttributes *WorkflowExecutionStartedEventAttributes `locationName:"workflowExecutionStartedEventAttributes" type:"structure"`

	// If the event is of type WorkflowExecutionTerminated then this member is set
	// and provides detailed information about the event. It isn't set for other
	// event types.
	WorkflowExecutionTerminatedEventAttributes *WorkflowExecutionTerminatedEventAttributes `locationName:"workflowExecutionTerminatedEventAttributes" type:"structure"`

	// If the event is of type WorkflowExecutionTimedOut then this member is set
	// and provides detailed information about the event. It isn't set for other
	// event types.
	WorkflowExecutionTimedOutEventAttributes *WorkflowExecutionTimedOutEventAttributes `locationName:"workflowExecutionTimedOutEventAttributes" type:"structure"`
	// contains filtered or unexported fields
}

Event within a workflow execution. A history event can be one of these types:

  • ActivityTaskCancelRequested – A RequestCancelActivityTask decision was received by the system.

  • ActivityTaskCanceled – The activity task was successfully canceled.

  • ActivityTaskCompleted – An activity worker successfully completed an activity task by calling RespondActivityTaskCompleted.

  • ActivityTaskFailed – An activity worker failed an activity task by calling RespondActivityTaskFailed.

  • ActivityTaskScheduled – An activity task was scheduled for execution.

  • ActivityTaskStarted – The scheduled activity task was dispatched to a worker.

  • ActivityTaskTimedOut – The activity task timed out.

  • CancelTimerFailed – Failed to process CancelTimer decision. This happens when the decision isn't configured properly, for example no timer exists with the specified timer Id.

  • CancelWorkflowExecutionFailed – A request to cancel a workflow execution failed.

  • ChildWorkflowExecutionCanceled – A child workflow execution, started by this workflow execution, was canceled and closed.

  • 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.

  • ChildWorkflowExecutionStarted – A child workflow execution was successfully started.

  • ChildWorkflowExecutionTerminated – A child workflow execution, started by this workflow execution, was terminated.

  • ChildWorkflowExecutionTimedOut – A child workflow execution, started by this workflow execution, timed out and was closed.

  • CompleteWorkflowExecutionFailed – The workflow execution failed to complete.

  • ContinueAsNewWorkflowExecutionFailed – The workflow execution failed to complete after being continued as a new workflow execution.

  • DecisionTaskCompleted – The decider successfully completed a decision task by calling RespondDecisionTaskCompleted.

  • DecisionTaskScheduled – A decision task was scheduled for the workflow execution.

  • DecisionTaskStarted – The decision task was dispatched to a decider.

  • DecisionTaskTimedOut – The decision task timed out.

  • ExternalWorkflowExecutionCancelRequested – Request to cancel an external workflow execution was successfully delivered to the target execution.

  • ExternalWorkflowExecutionSignaled – A signal, requested by this workflow execution, was successfully delivered to the target external workflow execution.

  • FailWorkflowExecutionFailed – A request to mark a workflow execution as failed, itself failed.

  • MarkerRecorded – A marker was recorded in the workflow history as the result of a RecordMarker decision.

  • RecordMarkerFailed – A RecordMarker decision was returned as failed.

  • RequestCancelActivityTaskFailed – Failed to process RequestCancelActivityTask decision. This happens when the decision isn't configured properly.

  • RequestCancelExternalWorkflowExecutionFailed – Request to cancel an external workflow execution failed.

  • RequestCancelExternalWorkflowExecutionInitiated – A request was made to request the cancellation of an external workflow execution.

  • ScheduleActivityTaskFailed – Failed to process ScheduleActivityTask decision. This happens when the decision isn't configured properly, for example the activity type specified isn't registered.

  • SignalExternalWorkflowExecutionFailed – The request to signal an external workflow execution failed.

  • SignalExternalWorkflowExecutionInitiated – A request to signal an external workflow was made.

  • StartActivityTaskFailed – A scheduled activity task failed to start.

  • StartChildWorkflowExecutionFailed – Failed to process StartChildWorkflowExecution decision. This happens when the decision isn't configured properly, for example the workflow type specified isn't registered.

  • StartChildWorkflowExecutionInitiated – A request was made to start a child workflow execution.

  • StartTimerFailed – Failed to process StartTimer decision. This happens when the decision isn't configured properly, for example a timer already exists with the specified timer Id.

  • TimerCanceled – A timer, previously started for this workflow execution, was successfully canceled.

  • TimerFired – A timer, previously started for this workflow execution, fired.

  • TimerStarted – A timer was started for the workflow execution due to a StartTimer decision.

  • WorkflowExecutionCancelRequested – A request to cancel this workflow execution was made.

  • WorkflowExecutionCanceled – The workflow execution was successfully canceled and closed.

  • WorkflowExecutionCompleted – The workflow execution was closed due to successful completion.

  • WorkflowExecutionContinuedAsNew – The workflow execution was closed and a new execution of the same type was created with the same workflowId.

  • WorkflowExecutionFailed – The workflow execution closed due to a failure.

  • WorkflowExecutionSignaled – An external signal was received for the workflow execution.

  • WorkflowExecutionStarted – The workflow execution was started.

  • WorkflowExecutionTerminated – The workflow execution was terminated.

  • WorkflowExecutionTimedOut – The workflow execution was closed because a time out was exceeded.

func (HistoryEvent) GoString added in v0.6.5

func (s HistoryEvent) GoString() string

GoString returns the string representation

func (*HistoryEvent) SetActivityTaskCancelRequestedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetActivityTaskCancelRequestedEventAttributes(v *ActivityTaskCancelRequestedEventAttributes) *HistoryEvent

SetActivityTaskCancelRequestedEventAttributes sets the ActivityTaskCancelRequestedEventAttributes field's value.

func (*HistoryEvent) SetActivityTaskCanceledEventAttributes added in v1.5.0

func (s *HistoryEvent) SetActivityTaskCanceledEventAttributes(v *ActivityTaskCanceledEventAttributes) *HistoryEvent

SetActivityTaskCanceledEventAttributes sets the ActivityTaskCanceledEventAttributes field's value.

func (*HistoryEvent) SetActivityTaskCompletedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetActivityTaskCompletedEventAttributes(v *ActivityTaskCompletedEventAttributes) *HistoryEvent

SetActivityTaskCompletedEventAttributes sets the ActivityTaskCompletedEventAttributes field's value.

func (*HistoryEvent) SetActivityTaskFailedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetActivityTaskFailedEventAttributes(v *ActivityTaskFailedEventAttributes) *HistoryEvent

SetActivityTaskFailedEventAttributes sets the ActivityTaskFailedEventAttributes field's value.

func (*HistoryEvent) SetActivityTaskScheduledEventAttributes added in v1.5.0

func (s *HistoryEvent) SetActivityTaskScheduledEventAttributes(v *ActivityTaskScheduledEventAttributes) *HistoryEvent

SetActivityTaskScheduledEventAttributes sets the ActivityTaskScheduledEventAttributes field's value.

func (*HistoryEvent) SetActivityTaskStartedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetActivityTaskStartedEventAttributes(v *ActivityTaskStartedEventAttributes) *HistoryEvent

SetActivityTaskStartedEventAttributes sets the ActivityTaskStartedEventAttributes field's value.

func (*HistoryEvent) SetActivityTaskTimedOutEventAttributes added in v1.5.0

func (s *HistoryEvent) SetActivityTaskTimedOutEventAttributes(v *ActivityTaskTimedOutEventAttributes) *HistoryEvent

SetActivityTaskTimedOutEventAttributes sets the ActivityTaskTimedOutEventAttributes field's value.

func (*HistoryEvent) SetCancelTimerFailedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetCancelTimerFailedEventAttributes(v *CancelTimerFailedEventAttributes) *HistoryEvent

SetCancelTimerFailedEventAttributes sets the CancelTimerFailedEventAttributes field's value.

func (*HistoryEvent) SetCancelWorkflowExecutionFailedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetCancelWorkflowExecutionFailedEventAttributes(v *CancelWorkflowExecutionFailedEventAttributes) *HistoryEvent

SetCancelWorkflowExecutionFailedEventAttributes sets the CancelWorkflowExecutionFailedEventAttributes field's value.

func (*HistoryEvent) SetChildWorkflowExecutionCanceledEventAttributes added in v1.5.0

func (s *HistoryEvent) SetChildWorkflowExecutionCanceledEventAttributes(v *ChildWorkflowExecutionCanceledEventAttributes) *HistoryEvent

SetChildWorkflowExecutionCanceledEventAttributes sets the ChildWorkflowExecutionCanceledEventAttributes field's value.

func (*HistoryEvent) SetChildWorkflowExecutionCompletedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetChildWorkflowExecutionCompletedEventAttributes(v *ChildWorkflowExecutionCompletedEventAttributes) *HistoryEvent

SetChildWorkflowExecutionCompletedEventAttributes sets the ChildWorkflowExecutionCompletedEventAttributes field's value.

func (*HistoryEvent) SetChildWorkflowExecutionFailedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetChildWorkflowExecutionFailedEventAttributes(v *ChildWorkflowExecutionFailedEventAttributes) *HistoryEvent

SetChildWorkflowExecutionFailedEventAttributes sets the ChildWorkflowExecutionFailedEventAttributes field's value.

func (*HistoryEvent) SetChildWorkflowExecutionStartedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetChildWorkflowExecutionStartedEventAttributes(v *ChildWorkflowExecutionStartedEventAttributes) *HistoryEvent

SetChildWorkflowExecutionStartedEventAttributes sets the ChildWorkflowExecutionStartedEventAttributes field's value.

func (*HistoryEvent) SetChildWorkflowExecutionTerminatedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetChildWorkflowExecutionTerminatedEventAttributes(v *ChildWorkflowExecutionTerminatedEventAttributes) *HistoryEvent

SetChildWorkflowExecutionTerminatedEventAttributes sets the ChildWorkflowExecutionTerminatedEventAttributes field's value.

func (*HistoryEvent) SetChildWorkflowExecutionTimedOutEventAttributes added in v1.5.0

func (s *HistoryEvent) SetChildWorkflowExecutionTimedOutEventAttributes(v *ChildWorkflowExecutionTimedOutEventAttributes) *HistoryEvent

SetChildWorkflowExecutionTimedOutEventAttributes sets the ChildWorkflowExecutionTimedOutEventAttributes field's value.

func (*HistoryEvent) SetCompleteWorkflowExecutionFailedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetCompleteWorkflowExecutionFailedEventAttributes(v *CompleteWorkflowExecutionFailedEventAttributes) *HistoryEvent

SetCompleteWorkflowExecutionFailedEventAttributes sets the CompleteWorkflowExecutionFailedEventAttributes field's value.

func (*HistoryEvent) SetContinueAsNewWorkflowExecutionFailedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetContinueAsNewWorkflowExecutionFailedEventAttributes(v *ContinueAsNewWorkflowExecutionFailedEventAttributes) *HistoryEvent

SetContinueAsNewWorkflowExecutionFailedEventAttributes sets the ContinueAsNewWorkflowExecutionFailedEventAttributes field's value.

func (*HistoryEvent) SetDecisionTaskCompletedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetDecisionTaskCompletedEventAttributes(v *DecisionTaskCompletedEventAttributes) *HistoryEvent

SetDecisionTaskCompletedEventAttributes sets the DecisionTaskCompletedEventAttributes field's value.

func (*HistoryEvent) SetDecisionTaskScheduledEventAttributes added in v1.5.0

func (s *HistoryEvent) SetDecisionTaskScheduledEventAttributes(v *DecisionTaskScheduledEventAttributes) *HistoryEvent

SetDecisionTaskScheduledEventAttributes sets the DecisionTaskScheduledEventAttributes field's value.

func (*HistoryEvent) SetDecisionTaskStartedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetDecisionTaskStartedEventAttributes(v *DecisionTaskStartedEventAttributes) *HistoryEvent

SetDecisionTaskStartedEventAttributes sets the DecisionTaskStartedEventAttributes field's value.

func (*HistoryEvent) SetDecisionTaskTimedOutEventAttributes added in v1.5.0

func (s *HistoryEvent) SetDecisionTaskTimedOutEventAttributes(v *DecisionTaskTimedOutEventAttributes) *HistoryEvent

SetDecisionTaskTimedOutEventAttributes sets the DecisionTaskTimedOutEventAttributes field's value.

func (*HistoryEvent) SetEventId added in v1.5.0

func (s *HistoryEvent) SetEventId(v int64) *HistoryEvent

SetEventId sets the EventId field's value.

func (*HistoryEvent) SetEventTimestamp added in v1.5.0

func (s *HistoryEvent) SetEventTimestamp(v time.Time) *HistoryEvent

SetEventTimestamp sets the EventTimestamp field's value.

func (*HistoryEvent) SetEventType added in v1.5.0

func (s *HistoryEvent) SetEventType(v string) *HistoryEvent

SetEventType sets the EventType field's value.

func (*HistoryEvent) SetExternalWorkflowExecutionCancelRequestedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetExternalWorkflowExecutionCancelRequestedEventAttributes(v *ExternalWorkflowExecutionCancelRequestedEventAttributes) *HistoryEvent

SetExternalWorkflowExecutionCancelRequestedEventAttributes sets the ExternalWorkflowExecutionCancelRequestedEventAttributes field's value.

func (*HistoryEvent) SetExternalWorkflowExecutionSignaledEventAttributes added in v1.5.0

func (s *HistoryEvent) SetExternalWorkflowExecutionSignaledEventAttributes(v *ExternalWorkflowExecutionSignaledEventAttributes) *HistoryEvent

SetExternalWorkflowExecutionSignaledEventAttributes sets the ExternalWorkflowExecutionSignaledEventAttributes field's value.

func (*HistoryEvent) SetFailWorkflowExecutionFailedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetFailWorkflowExecutionFailedEventAttributes(v *FailWorkflowExecutionFailedEventAttributes) *HistoryEvent

SetFailWorkflowExecutionFailedEventAttributes sets the FailWorkflowExecutionFailedEventAttributes field's value.

func (*HistoryEvent) SetLambdaFunctionCompletedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetLambdaFunctionCompletedEventAttributes(v *LambdaFunctionCompletedEventAttributes) *HistoryEvent

SetLambdaFunctionCompletedEventAttributes sets the LambdaFunctionCompletedEventAttributes field's value.

func (*HistoryEvent) SetLambdaFunctionFailedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetLambdaFunctionFailedEventAttributes(v *LambdaFunctionFailedEventAttributes) *HistoryEvent

SetLambdaFunctionFailedEventAttributes sets the LambdaFunctionFailedEventAttributes field's value.

func (*HistoryEvent) SetLambdaFunctionScheduledEventAttributes added in v1.5.0

func (s *HistoryEvent) SetLambdaFunctionScheduledEventAttributes(v *LambdaFunctionScheduledEventAttributes) *HistoryEvent

SetLambdaFunctionScheduledEventAttributes sets the LambdaFunctionScheduledEventAttributes field's value.

func (*HistoryEvent) SetLambdaFunctionStartedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetLambdaFunctionStartedEventAttributes(v *LambdaFunctionStartedEventAttributes) *HistoryEvent

SetLambdaFunctionStartedEventAttributes sets the LambdaFunctionStartedEventAttributes field's value.

func (*HistoryEvent) SetLambdaFunctionTimedOutEventAttributes added in v1.5.0

func (s *HistoryEvent) SetLambdaFunctionTimedOutEventAttributes(v *LambdaFunctionTimedOutEventAttributes) *HistoryEvent

SetLambdaFunctionTimedOutEventAttributes sets the LambdaFunctionTimedOutEventAttributes field's value.

func (*HistoryEvent) SetMarkerRecordedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetMarkerRecordedEventAttributes(v *MarkerRecordedEventAttributes) *HistoryEvent

SetMarkerRecordedEventAttributes sets the MarkerRecordedEventAttributes field's value.

func (*HistoryEvent) SetRecordMarkerFailedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetRecordMarkerFailedEventAttributes(v *RecordMarkerFailedEventAttributes) *HistoryEvent

SetRecordMarkerFailedEventAttributes sets the RecordMarkerFailedEventAttributes field's value.

func (*HistoryEvent) SetRequestCancelActivityTaskFailedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetRequestCancelActivityTaskFailedEventAttributes(v *RequestCancelActivityTaskFailedEventAttributes) *HistoryEvent

SetRequestCancelActivityTaskFailedEventAttributes sets the RequestCancelActivityTaskFailedEventAttributes field's value.

func (*HistoryEvent) SetRequestCancelExternalWorkflowExecutionFailedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetRequestCancelExternalWorkflowExecutionFailedEventAttributes(v *RequestCancelExternalWorkflowExecutionFailedEventAttributes) *HistoryEvent

SetRequestCancelExternalWorkflowExecutionFailedEventAttributes sets the RequestCancelExternalWorkflowExecutionFailedEventAttributes field's value.

func (*HistoryEvent) SetRequestCancelExternalWorkflowExecutionInitiatedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetRequestCancelExternalWorkflowExecutionInitiatedEventAttributes(v *RequestCancelExternalWorkflowExecutionInitiatedEventAttributes) *HistoryEvent

SetRequestCancelExternalWorkflowExecutionInitiatedEventAttributes sets the RequestCancelExternalWorkflowExecutionInitiatedEventAttributes field's value.

func (*HistoryEvent) SetScheduleActivityTaskFailedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetScheduleActivityTaskFailedEventAttributes(v *ScheduleActivityTaskFailedEventAttributes) *HistoryEvent

SetScheduleActivityTaskFailedEventAttributes sets the ScheduleActivityTaskFailedEventAttributes field's value.

func (*HistoryEvent) SetScheduleLambdaFunctionFailedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetScheduleLambdaFunctionFailedEventAttributes(v *ScheduleLambdaFunctionFailedEventAttributes) *HistoryEvent

SetScheduleLambdaFunctionFailedEventAttributes sets the ScheduleLambdaFunctionFailedEventAttributes field's value.

func (*HistoryEvent) SetSignalExternalWorkflowExecutionFailedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetSignalExternalWorkflowExecutionFailedEventAttributes(v *SignalExternalWorkflowExecutionFailedEventAttributes) *HistoryEvent

SetSignalExternalWorkflowExecutionFailedEventAttributes sets the SignalExternalWorkflowExecutionFailedEventAttributes field's value.

func (*HistoryEvent) SetSignalExternalWorkflowExecutionInitiatedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetSignalExternalWorkflowExecutionInitiatedEventAttributes(v *SignalExternalWorkflowExecutionInitiatedEventAttributes) *HistoryEvent

SetSignalExternalWorkflowExecutionInitiatedEventAttributes sets the SignalExternalWorkflowExecutionInitiatedEventAttributes field's value.

func (*HistoryEvent) SetStartChildWorkflowExecutionFailedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetStartChildWorkflowExecutionFailedEventAttributes(v *StartChildWorkflowExecutionFailedEventAttributes) *HistoryEvent

SetStartChildWorkflowExecutionFailedEventAttributes sets the StartChildWorkflowExecutionFailedEventAttributes field's value.

func (*HistoryEvent) SetStartChildWorkflowExecutionInitiatedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetStartChildWorkflowExecutionInitiatedEventAttributes(v *StartChildWorkflowExecutionInitiatedEventAttributes) *HistoryEvent

SetStartChildWorkflowExecutionInitiatedEventAttributes sets the StartChildWorkflowExecutionInitiatedEventAttributes field's value.

func (*HistoryEvent) SetStartLambdaFunctionFailedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetStartLambdaFunctionFailedEventAttributes(v *StartLambdaFunctionFailedEventAttributes) *HistoryEvent

SetStartLambdaFunctionFailedEventAttributes sets the StartLambdaFunctionFailedEventAttributes field's value.

func (*HistoryEvent) SetStartTimerFailedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetStartTimerFailedEventAttributes(v *StartTimerFailedEventAttributes) *HistoryEvent

SetStartTimerFailedEventAttributes sets the StartTimerFailedEventAttributes field's value.

func (*HistoryEvent) SetTimerCanceledEventAttributes added in v1.5.0

func (s *HistoryEvent) SetTimerCanceledEventAttributes(v *TimerCanceledEventAttributes) *HistoryEvent

SetTimerCanceledEventAttributes sets the TimerCanceledEventAttributes field's value.

func (*HistoryEvent) SetTimerFiredEventAttributes added in v1.5.0

func (s *HistoryEvent) SetTimerFiredEventAttributes(v *TimerFiredEventAttributes) *HistoryEvent

SetTimerFiredEventAttributes sets the TimerFiredEventAttributes field's value.

func (*HistoryEvent) SetTimerStartedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetTimerStartedEventAttributes(v *TimerStartedEventAttributes) *HistoryEvent

SetTimerStartedEventAttributes sets the TimerStartedEventAttributes field's value.

func (*HistoryEvent) SetWorkflowExecutionCancelRequestedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetWorkflowExecutionCancelRequestedEventAttributes(v *WorkflowExecutionCancelRequestedEventAttributes) *HistoryEvent

SetWorkflowExecutionCancelRequestedEventAttributes sets the WorkflowExecutionCancelRequestedEventAttributes field's value.

func (*HistoryEvent) SetWorkflowExecutionCanceledEventAttributes added in v1.5.0

func (s *HistoryEvent) SetWorkflowExecutionCanceledEventAttributes(v *WorkflowExecutionCanceledEventAttributes) *HistoryEvent

SetWorkflowExecutionCanceledEventAttributes sets the WorkflowExecutionCanceledEventAttributes field's value.

func (*HistoryEvent) SetWorkflowExecutionCompletedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetWorkflowExecutionCompletedEventAttributes(v *WorkflowExecutionCompletedEventAttributes) *HistoryEvent

SetWorkflowExecutionCompletedEventAttributes sets the WorkflowExecutionCompletedEventAttributes field's value.

func (*HistoryEvent) SetWorkflowExecutionContinuedAsNewEventAttributes added in v1.5.0

func (s *HistoryEvent) SetWorkflowExecutionContinuedAsNewEventAttributes(v *WorkflowExecutionContinuedAsNewEventAttributes) *HistoryEvent

SetWorkflowExecutionContinuedAsNewEventAttributes sets the WorkflowExecutionContinuedAsNewEventAttributes field's value.

func (*HistoryEvent) SetWorkflowExecutionFailedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetWorkflowExecutionFailedEventAttributes(v *WorkflowExecutionFailedEventAttributes) *HistoryEvent

SetWorkflowExecutionFailedEventAttributes sets the WorkflowExecutionFailedEventAttributes field's value.

func (*HistoryEvent) SetWorkflowExecutionSignaledEventAttributes added in v1.5.0

func (s *HistoryEvent) SetWorkflowExecutionSignaledEventAttributes(v *WorkflowExecutionSignaledEventAttributes) *HistoryEvent

SetWorkflowExecutionSignaledEventAttributes sets the WorkflowExecutionSignaledEventAttributes field's value.

func (*HistoryEvent) SetWorkflowExecutionStartedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetWorkflowExecutionStartedEventAttributes(v *WorkflowExecutionStartedEventAttributes) *HistoryEvent

SetWorkflowExecutionStartedEventAttributes sets the WorkflowExecutionStartedEventAttributes field's value.

func (*HistoryEvent) SetWorkflowExecutionTerminatedEventAttributes added in v1.5.0

func (s *HistoryEvent) SetWorkflowExecutionTerminatedEventAttributes(v *WorkflowExecutionTerminatedEventAttributes) *HistoryEvent

SetWorkflowExecutionTerminatedEventAttributes sets the WorkflowExecutionTerminatedEventAttributes field's value.

func (*HistoryEvent) SetWorkflowExecutionTimedOutEventAttributes added in v1.5.0

func (s *HistoryEvent) SetWorkflowExecutionTimedOutEventAttributes(v *WorkflowExecutionTimedOutEventAttributes) *HistoryEvent

SetWorkflowExecutionTimedOutEventAttributes sets the WorkflowExecutionTimedOutEventAttributes field's value.

func (HistoryEvent) String added in v0.6.5

func (s HistoryEvent) String() string

String returns the string representation

type LambdaFunctionCompletedEventAttributes added in v0.7.3

type LambdaFunctionCompletedEventAttributes struct {

	// The results of the Lambda task.
	Result *string `locationName:"result" type:"string"`

	// The ID of the LambdaFunctionScheduled event that was recorded when this Lambda
	// task was scheduled. To help diagnose issues, use this information to trace
	// back the chain of events leading up to this event.
	//
	// ScheduledEventId is a required field
	ScheduledEventId *int64 `locationName:"scheduledEventId" type:"long" required:"true"`

	// The ID of the LambdaFunctionStarted event recorded when this activity task
	// started. To help diagnose issues, use this information to trace back the
	// chain of events leading up to this event.
	//
	// StartedEventId is a required field
	StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the LambdaFunctionCompleted event. It isn't set for other event types.

func (LambdaFunctionCompletedEventAttributes) GoString added in v0.7.3

GoString returns the string representation

func (*LambdaFunctionCompletedEventAttributes) SetResult added in v1.5.0

SetResult sets the Result field's value.

func (*LambdaFunctionCompletedEventAttributes) SetScheduledEventId added in v1.5.0

SetScheduledEventId sets the ScheduledEventId field's value.

func (*LambdaFunctionCompletedEventAttributes) SetStartedEventId added in v1.5.0

SetStartedEventId sets the StartedEventId field's value.

func (LambdaFunctionCompletedEventAttributes) String added in v0.7.3

String returns the string representation

type LambdaFunctionFailedEventAttributes added in v0.7.3

type LambdaFunctionFailedEventAttributes struct {

	// The details of the failure.
	Details *string `locationName:"details" type:"string"`

	// The reason provided for the failure.
	Reason *string `locationName:"reason" type:"string"`

	// The ID of the LambdaFunctionScheduled event that was recorded when this activity
	// task was scheduled. To help diagnose issues, use this information to trace
	// back the chain of events leading up to this event.
	//
	// ScheduledEventId is a required field
	ScheduledEventId *int64 `locationName:"scheduledEventId" type:"long" required:"true"`

	// The ID of the LambdaFunctionStarted event recorded when this activity task
	// started. To help diagnose issues, use this information to trace back the
	// chain of events leading up to this event.
	//
	// StartedEventId is a required field
	StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the LambdaFunctionFailed event. It isn't set for other event types.

func (LambdaFunctionFailedEventAttributes) GoString added in v0.7.3

GoString returns the string representation

func (*LambdaFunctionFailedEventAttributes) SetDetails added in v1.5.0

SetDetails sets the Details field's value.

func (*LambdaFunctionFailedEventAttributes) SetReason added in v1.5.0

SetReason sets the Reason field's value.

func (*LambdaFunctionFailedEventAttributes) SetScheduledEventId added in v1.5.0

SetScheduledEventId sets the ScheduledEventId field's value.

func (*LambdaFunctionFailedEventAttributes) SetStartedEventId added in v1.5.0

SetStartedEventId sets the StartedEventId field's value.

func (LambdaFunctionFailedEventAttributes) String added in v0.7.3

String returns the string representation

type LambdaFunctionScheduledEventAttributes added in v0.7.3

type LambdaFunctionScheduledEventAttributes struct {

	// Data attached to the event that the decider can use in subsequent workflow
	// tasks. This data isn't sent to the Lambda task.
	Control *string `locationName:"control" type:"string"`

	// The ID of the LambdaFunctionCompleted event corresponding to the decision
	// that resulted in scheduling this activity task. To help diagnose issues,
	// use this information to trace back the chain of events leading up to this
	// event.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// The unique ID of the Lambda task.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"1" type:"string" required:"true"`

	// The input provided to the Lambda task.
	Input *string `locationName:"input" type:"string"`

	// The name of the Lambda function.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The maximum amount of time a worker can take to process the Lambda task.
	StartToCloseTimeout *string `locationName:"startToCloseTimeout" type:"string"`
	// contains filtered or unexported fields
}

Provides the details of the LambdaFunctionScheduled event. It isn't set for other event types.

func (LambdaFunctionScheduledEventAttributes) GoString added in v0.7.3

GoString returns the string representation

func (*LambdaFunctionScheduledEventAttributes) SetControl added in v1.10.9

SetControl sets the Control field's value.

func (*LambdaFunctionScheduledEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*LambdaFunctionScheduledEventAttributes) SetId added in v1.5.0

SetId sets the Id field's value.

func (*LambdaFunctionScheduledEventAttributes) SetInput added in v1.5.0

SetInput sets the Input field's value.

func (*LambdaFunctionScheduledEventAttributes) SetName added in v1.5.0

SetName sets the Name field's value.

func (*LambdaFunctionScheduledEventAttributes) SetStartToCloseTimeout added in v1.5.0

SetStartToCloseTimeout sets the StartToCloseTimeout field's value.

func (LambdaFunctionScheduledEventAttributes) String added in v0.7.3

String returns the string representation

type LambdaFunctionStartedEventAttributes added in v0.7.3

type LambdaFunctionStartedEventAttributes struct {

	// The ID of the LambdaFunctionScheduled event that was recorded when this activity
	// task was scheduled. To help diagnose issues, use this information to trace
	// back the chain of events leading up to this event.
	//
	// ScheduledEventId is a required field
	ScheduledEventId *int64 `locationName:"scheduledEventId" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the LambdaFunctionStarted event. It isn't set for other event types.

func (LambdaFunctionStartedEventAttributes) GoString added in v0.7.3

GoString returns the string representation

func (*LambdaFunctionStartedEventAttributes) SetScheduledEventId added in v1.5.0

SetScheduledEventId sets the ScheduledEventId field's value.

func (LambdaFunctionStartedEventAttributes) String added in v0.7.3

String returns the string representation

type LambdaFunctionTimedOutEventAttributes added in v0.7.3

type LambdaFunctionTimedOutEventAttributes struct {

	// The ID of the LambdaFunctionScheduled event that was recorded when this activity
	// task was scheduled. To help diagnose issues, use this information to trace
	// back the chain of events leading up to this event.
	//
	// ScheduledEventId is a required field
	ScheduledEventId *int64 `locationName:"scheduledEventId" type:"long" required:"true"`

	// The ID of the ActivityTaskStarted event that was recorded when this activity
	// task started. To help diagnose issues, use this information to trace back
	// the chain of events leading up to this event.
	//
	// StartedEventId is a required field
	StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`

	// The type of the timeout that caused this event.
	TimeoutType *string `locationName:"timeoutType" type:"string" enum:"LambdaFunctionTimeoutType"`
	// contains filtered or unexported fields
}

Provides details of the LambdaFunctionTimedOut event.

func (LambdaFunctionTimedOutEventAttributes) GoString added in v0.7.3

GoString returns the string representation

func (*LambdaFunctionTimedOutEventAttributes) SetScheduledEventId added in v1.5.0

SetScheduledEventId sets the ScheduledEventId field's value.

func (*LambdaFunctionTimedOutEventAttributes) SetStartedEventId added in v1.5.0

SetStartedEventId sets the StartedEventId field's value.

func (*LambdaFunctionTimedOutEventAttributes) SetTimeoutType added in v1.5.0

SetTimeoutType sets the TimeoutType field's value.

func (LambdaFunctionTimedOutEventAttributes) String added in v0.7.3

String returns the string representation

type ListActivityTypesInput

type ListActivityTypesInput struct {

	// The name of the domain in which the activity types have been registered.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// The maximum number of results that are returned per call. nextPageToken can
	// be used to obtain futher pages of results. The default is 1000, which is
	// the maximum allowed page size. You can, however, specify a page size smaller
	// than the maximum.
	//
	// This is an upper limit only; the actual number of results returned per call
	// may be fewer than the specified maximum.
	MaximumPageSize *int64 `locationName:"maximumPageSize" type:"integer"`

	// If specified, only lists the activity types that have this name.
	Name *string `locationName:"name" min:"1" type:"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.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`

	// Specifies the registration status of the activity types to list.
	//
	// RegistrationStatus is a required field
	RegistrationStatus *string `locationName:"registrationStatus" type:"string" required:"true" enum:"RegistrationStatus"`

	// When set to true, returns the results in reverse order. By default, the results
	// are returned in ascending alphabetical order by name of the activity types.
	ReverseOrder *bool `locationName:"reverseOrder" type:"boolean"`
	// contains filtered or unexported fields
}

func (ListActivityTypesInput) GoString added in v0.6.5

func (s ListActivityTypesInput) GoString() string

GoString returns the string representation

func (*ListActivityTypesInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*ListActivityTypesInput) SetMaximumPageSize added in v1.5.0

func (s *ListActivityTypesInput) SetMaximumPageSize(v int64) *ListActivityTypesInput

SetMaximumPageSize sets the MaximumPageSize field's value.

func (*ListActivityTypesInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*ListActivityTypesInput) SetNextPageToken added in v1.5.0

func (s *ListActivityTypesInput) SetNextPageToken(v string) *ListActivityTypesInput

SetNextPageToken sets the NextPageToken field's value.

func (*ListActivityTypesInput) SetRegistrationStatus added in v1.5.0

func (s *ListActivityTypesInput) SetRegistrationStatus(v string) *ListActivityTypesInput

SetRegistrationStatus sets the RegistrationStatus field's value.

func (*ListActivityTypesInput) SetReverseOrder added in v1.5.0

func (s *ListActivityTypesInput) SetReverseOrder(v bool) *ListActivityTypesInput

SetReverseOrder sets the ReverseOrder field's value.

func (ListActivityTypesInput) String added in v0.6.5

func (s ListActivityTypesInput) String() string

String returns the string representation

func (*ListActivityTypesInput) Validate added in v1.1.21

func (s *ListActivityTypesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListActivityTypesOutput

type ListActivityTypesOutput struct {

	// 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.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`

	// List of activity type information.
	//
	// TypeInfos is a required field
	TypeInfos []*ActivityTypeInfo `locationName:"typeInfos" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains a paginated list of activity type information structures.

func (ListActivityTypesOutput) GoString added in v0.6.5

func (s ListActivityTypesOutput) GoString() string

GoString returns the string representation

func (*ListActivityTypesOutput) SetNextPageToken added in v1.5.0

func (s *ListActivityTypesOutput) SetNextPageToken(v string) *ListActivityTypesOutput

SetNextPageToken sets the NextPageToken field's value.

func (*ListActivityTypesOutput) SetTypeInfos added in v1.5.0

SetTypeInfos sets the TypeInfos field's value.

func (ListActivityTypesOutput) String added in v0.6.5

func (s ListActivityTypesOutput) String() string

String returns the string representation

type ListClosedWorkflowExecutionsInput

type ListClosedWorkflowExecutionsInput struct {

	// If specified, only workflow executions that match this close status are listed.
	// For example, if TERMINATED is specified, then only TERMINATED workflow executions
	// are listed.
	//
	// closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually
	// exclusive. You can specify at most one of these in a request.
	CloseStatusFilter *CloseStatusFilter `locationName:"closeStatusFilter" type:"structure"`

	// If specified, the workflow executions are included in the returned results
	// based on whether their close times are within the range specified by this
	// filter. Also, if this parameter is specified, the returned results are ordered
	// by their close times.
	//
	// startTimeFilter and closeTimeFilter are mutually exclusive. You must specify
	// one of these in a request but not both.
	CloseTimeFilter *ExecutionTimeFilter `locationName:"closeTimeFilter" type:"structure"`

	// The name of the domain that contains the workflow executions to list.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// If specified, only workflow executions matching the workflow ID specified
	// in the filter are returned.
	//
	// closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually
	// exclusive. You can specify at most one of these in a request.
	ExecutionFilter *WorkflowExecutionFilter `locationName:"executionFilter" type:"structure"`

	// The maximum number of results that are returned per call. nextPageToken can
	// be used to obtain futher pages of results. The default is 1000, which is
	// the maximum allowed page size. You can, however, specify a page size smaller
	// than the maximum.
	//
	// This is an upper limit only; the actual number of results returned per call
	// may be fewer than the specified maximum.
	MaximumPageSize *int64 `locationName:"maximumPageSize" type:"integer"`

	// 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.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`

	// When set to true, returns the results in reverse order. By default the results
	// are returned in descending order of the start or the close time of the executions.
	ReverseOrder *bool `locationName:"reverseOrder" type:"boolean"`

	// If specified, the workflow executions are included in the returned results
	// based on whether their start times are within the range specified by this
	// filter. Also, if this parameter is specified, the returned results are ordered
	// by their start times.
	//
	// startTimeFilter and closeTimeFilter are mutually exclusive. You must specify
	// one of these in a request but not both.
	StartTimeFilter *ExecutionTimeFilter `locationName:"startTimeFilter" type:"structure"`

	// If specified, only executions that have the matching tag are listed.
	//
	// closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually
	// exclusive. You can specify at most one of these in a request.
	TagFilter *TagFilter `locationName:"tagFilter" type:"structure"`

	// If specified, only executions of the type specified in the filter are returned.
	//
	// closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually
	// exclusive. You can specify at most one of these in a request.
	TypeFilter *WorkflowTypeFilter `locationName:"typeFilter" type:"structure"`
	// contains filtered or unexported fields
}

func (ListClosedWorkflowExecutionsInput) GoString added in v0.6.5

GoString returns the string representation

func (*ListClosedWorkflowExecutionsInput) SetCloseStatusFilter added in v1.5.0

SetCloseStatusFilter sets the CloseStatusFilter field's value.

func (*ListClosedWorkflowExecutionsInput) SetCloseTimeFilter added in v1.5.0

SetCloseTimeFilter sets the CloseTimeFilter field's value.

func (*ListClosedWorkflowExecutionsInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*ListClosedWorkflowExecutionsInput) SetExecutionFilter added in v1.5.0

SetExecutionFilter sets the ExecutionFilter field's value.

func (*ListClosedWorkflowExecutionsInput) SetMaximumPageSize added in v1.5.0

SetMaximumPageSize sets the MaximumPageSize field's value.

func (*ListClosedWorkflowExecutionsInput) SetNextPageToken added in v1.5.0

SetNextPageToken sets the NextPageToken field's value.

func (*ListClosedWorkflowExecutionsInput) SetReverseOrder added in v1.5.0

SetReverseOrder sets the ReverseOrder field's value.

func (*ListClosedWorkflowExecutionsInput) SetStartTimeFilter added in v1.5.0

SetStartTimeFilter sets the StartTimeFilter field's value.

func (*ListClosedWorkflowExecutionsInput) SetTagFilter added in v1.5.0

SetTagFilter sets the TagFilter field's value.

func (*ListClosedWorkflowExecutionsInput) SetTypeFilter added in v1.5.0

SetTypeFilter sets the TypeFilter field's value.

func (ListClosedWorkflowExecutionsInput) String added in v0.6.5

String returns the string representation

func (*ListClosedWorkflowExecutionsInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type ListDomainsInput

type ListDomainsInput struct {

	// The maximum number of results that are returned per call. nextPageToken can
	// be used to obtain futher pages of results. The default is 1000, which is
	// the maximum allowed page size. You can, however, specify a page size smaller
	// than the maximum.
	//
	// This is an upper limit only; the actual number of results returned per call
	// may be fewer than the specified maximum.
	MaximumPageSize *int64 `locationName:"maximumPageSize" type:"integer"`

	// 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.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`

	// Specifies the registration status of the domains to list.
	//
	// RegistrationStatus is a required field
	RegistrationStatus *string `locationName:"registrationStatus" type:"string" required:"true" enum:"RegistrationStatus"`

	// When set to true, returns the results in reverse order. By default, the results
	// are returned in ascending alphabetical order by name of the domains.
	ReverseOrder *bool `locationName:"reverseOrder" type:"boolean"`
	// contains filtered or unexported fields
}

func (ListDomainsInput) GoString added in v0.6.5

func (s ListDomainsInput) GoString() string

GoString returns the string representation

func (*ListDomainsInput) SetMaximumPageSize added in v1.5.0

func (s *ListDomainsInput) SetMaximumPageSize(v int64) *ListDomainsInput

SetMaximumPageSize sets the MaximumPageSize field's value.

func (*ListDomainsInput) SetNextPageToken added in v1.5.0

func (s *ListDomainsInput) SetNextPageToken(v string) *ListDomainsInput

SetNextPageToken sets the NextPageToken field's value.

func (*ListDomainsInput) SetRegistrationStatus added in v1.5.0

func (s *ListDomainsInput) SetRegistrationStatus(v string) *ListDomainsInput

SetRegistrationStatus sets the RegistrationStatus field's value.

func (*ListDomainsInput) SetReverseOrder added in v1.5.0

func (s *ListDomainsInput) SetReverseOrder(v bool) *ListDomainsInput

SetReverseOrder sets the ReverseOrder field's value.

func (ListDomainsInput) String added in v0.6.5

func (s ListDomainsInput) String() string

String returns the string representation

func (*ListDomainsInput) Validate added in v1.1.21

func (s *ListDomainsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDomainsOutput

type ListDomainsOutput struct {

	// A list of DomainInfo structures.
	//
	// DomainInfos is a required field
	DomainInfos []*DomainInfo `locationName:"domainInfos" type:"list" required:"true"`

	// 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.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

Contains a paginated collection of DomainInfo structures.

func (ListDomainsOutput) GoString added in v0.6.5

func (s ListDomainsOutput) GoString() string

GoString returns the string representation

func (*ListDomainsOutput) SetDomainInfos added in v1.5.0

func (s *ListDomainsOutput) SetDomainInfos(v []*DomainInfo) *ListDomainsOutput

SetDomainInfos sets the DomainInfos field's value.

func (*ListDomainsOutput) SetNextPageToken added in v1.5.0

func (s *ListDomainsOutput) SetNextPageToken(v string) *ListDomainsOutput

SetNextPageToken sets the NextPageToken field's value.

func (ListDomainsOutput) String added in v0.6.5

func (s ListDomainsOutput) String() string

String returns the string representation

type ListOpenWorkflowExecutionsInput

type ListOpenWorkflowExecutionsInput struct {

	// The name of the domain that contains the workflow executions to list.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// If specified, only workflow executions matching the workflow ID specified
	// in the filter are returned.
	//
	// executionFilter, typeFilter and tagFilter are mutually exclusive. You can
	// specify at most one of these in a request.
	ExecutionFilter *WorkflowExecutionFilter `locationName:"executionFilter" type:"structure"`

	// The maximum number of results that are returned per call. nextPageToken can
	// be used to obtain futher pages of results. The default is 1000, which is
	// the maximum allowed page size. You can, however, specify a page size smaller
	// than the maximum.
	//
	// This is an upper limit only; the actual number of results returned per call
	// may be fewer than the specified maximum.
	MaximumPageSize *int64 `locationName:"maximumPageSize" type:"integer"`

	// 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.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`

	// When set to true, returns the results in reverse order. By default the results
	// are returned in descending order of the start time of the executions.
	ReverseOrder *bool `locationName:"reverseOrder" type:"boolean"`

	// Workflow executions are included in the returned results based on whether
	// their start times are within the range specified by this filter.
	//
	// StartTimeFilter is a required field
	StartTimeFilter *ExecutionTimeFilter `locationName:"startTimeFilter" type:"structure" required:"true"`

	// If specified, only executions that have the matching tag are listed.
	//
	// executionFilter, typeFilter and tagFilter are mutually exclusive. You can
	// specify at most one of these in a request.
	TagFilter *TagFilter `locationName:"tagFilter" type:"structure"`

	// If specified, only executions of the type specified in the filter are returned.
	//
	// executionFilter, typeFilter and tagFilter are mutually exclusive. You can
	// specify at most one of these in a request.
	TypeFilter *WorkflowTypeFilter `locationName:"typeFilter" type:"structure"`
	// contains filtered or unexported fields
}

func (ListOpenWorkflowExecutionsInput) GoString added in v0.6.5

GoString returns the string representation

func (*ListOpenWorkflowExecutionsInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*ListOpenWorkflowExecutionsInput) SetExecutionFilter added in v1.5.0

SetExecutionFilter sets the ExecutionFilter field's value.

func (*ListOpenWorkflowExecutionsInput) SetMaximumPageSize added in v1.5.0

SetMaximumPageSize sets the MaximumPageSize field's value.

func (*ListOpenWorkflowExecutionsInput) SetNextPageToken added in v1.5.0

SetNextPageToken sets the NextPageToken field's value.

func (*ListOpenWorkflowExecutionsInput) SetReverseOrder added in v1.5.0

SetReverseOrder sets the ReverseOrder field's value.

func (*ListOpenWorkflowExecutionsInput) SetStartTimeFilter added in v1.5.0

SetStartTimeFilter sets the StartTimeFilter field's value.

func (*ListOpenWorkflowExecutionsInput) SetTagFilter added in v1.5.0

SetTagFilter sets the TagFilter field's value.

func (*ListOpenWorkflowExecutionsInput) SetTypeFilter added in v1.5.0

SetTypeFilter sets the TypeFilter field's value.

func (ListOpenWorkflowExecutionsInput) String added in v0.6.5

String returns the string representation

func (*ListOpenWorkflowExecutionsInput) Validate added in v1.1.21

func (s *ListOpenWorkflowExecutionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListWorkflowTypesInput

type ListWorkflowTypesInput struct {

	// The name of the domain in which the workflow types have been registered.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// The maximum number of results that are returned per call. nextPageToken can
	// be used to obtain futher pages of results. The default is 1000, which is
	// the maximum allowed page size. You can, however, specify a page size smaller
	// than the maximum.
	//
	// This is an upper limit only; the actual number of results returned per call
	// may be fewer than the specified maximum.
	MaximumPageSize *int64 `locationName:"maximumPageSize" type:"integer"`

	// If specified, lists the workflow type with this name.
	Name *string `locationName:"name" min:"1" type:"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.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`

	// Specifies the registration status of the workflow types to list.
	//
	// RegistrationStatus is a required field
	RegistrationStatus *string `locationName:"registrationStatus" type:"string" required:"true" enum:"RegistrationStatus"`

	// When set to true, returns the results in reverse order. By default the results
	// are returned in ascending alphabetical order of the name of the workflow
	// types.
	ReverseOrder *bool `locationName:"reverseOrder" type:"boolean"`
	// contains filtered or unexported fields
}

func (ListWorkflowTypesInput) GoString added in v0.6.5

func (s ListWorkflowTypesInput) GoString() string

GoString returns the string representation

func (*ListWorkflowTypesInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*ListWorkflowTypesInput) SetMaximumPageSize added in v1.5.0

func (s *ListWorkflowTypesInput) SetMaximumPageSize(v int64) *ListWorkflowTypesInput

SetMaximumPageSize sets the MaximumPageSize field's value.

func (*ListWorkflowTypesInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*ListWorkflowTypesInput) SetNextPageToken added in v1.5.0

func (s *ListWorkflowTypesInput) SetNextPageToken(v string) *ListWorkflowTypesInput

SetNextPageToken sets the NextPageToken field's value.

func (*ListWorkflowTypesInput) SetRegistrationStatus added in v1.5.0

func (s *ListWorkflowTypesInput) SetRegistrationStatus(v string) *ListWorkflowTypesInput

SetRegistrationStatus sets the RegistrationStatus field's value.

func (*ListWorkflowTypesInput) SetReverseOrder added in v1.5.0

func (s *ListWorkflowTypesInput) SetReverseOrder(v bool) *ListWorkflowTypesInput

SetReverseOrder sets the ReverseOrder field's value.

func (ListWorkflowTypesInput) String added in v0.6.5

func (s ListWorkflowTypesInput) String() string

String returns the string representation

func (*ListWorkflowTypesInput) Validate added in v1.1.21

func (s *ListWorkflowTypesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListWorkflowTypesOutput

type ListWorkflowTypesOutput struct {

	// 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.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`

	// The list of workflow type information.
	//
	// TypeInfos is a required field
	TypeInfos []*WorkflowTypeInfo `locationName:"typeInfos" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains a paginated list of information structures about workflow types.

func (ListWorkflowTypesOutput) GoString added in v0.6.5

func (s ListWorkflowTypesOutput) GoString() string

GoString returns the string representation

func (*ListWorkflowTypesOutput) SetNextPageToken added in v1.5.0

func (s *ListWorkflowTypesOutput) SetNextPageToken(v string) *ListWorkflowTypesOutput

SetNextPageToken sets the NextPageToken field's value.

func (*ListWorkflowTypesOutput) SetTypeInfos added in v1.5.0

SetTypeInfos sets the TypeInfos field's value.

func (ListWorkflowTypesOutput) String added in v0.6.5

func (s ListWorkflowTypesOutput) String() string

String returns the string representation

type MarkerRecordedEventAttributes

type MarkerRecordedEventAttributes struct {

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// The details of the marker.
	Details *string `locationName:"details" type:"string"`

	// The name of the marker.
	//
	// MarkerName is a required field
	MarkerName *string `locationName:"markerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the MarkerRecorded event.

func (MarkerRecordedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*MarkerRecordedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

func (s *MarkerRecordedEventAttributes) SetDecisionTaskCompletedEventId(v int64) *MarkerRecordedEventAttributes

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*MarkerRecordedEventAttributes) SetDetails added in v1.5.0

SetDetails sets the Details field's value.

func (*MarkerRecordedEventAttributes) SetMarkerName added in v1.5.0

SetMarkerName sets the MarkerName field's value.

func (MarkerRecordedEventAttributes) String added in v0.6.5

String returns the string representation

type PendingTaskCount

type PendingTaskCount struct {

	// The number of tasks in the task list.
	//
	// Count is a required field
	Count *int64 `locationName:"count" type:"integer" required:"true"`

	// If set to true, indicates that the actual count was more than the maximum
	// supported by this API and the count returned is the truncated value.
	Truncated *bool `locationName:"truncated" type:"boolean"`
	// contains filtered or unexported fields
}

Contains the count of tasks in a task list.

func (PendingTaskCount) GoString added in v0.6.5

func (s PendingTaskCount) GoString() string

GoString returns the string representation

func (*PendingTaskCount) SetCount added in v1.5.0

func (s *PendingTaskCount) SetCount(v int64) *PendingTaskCount

SetCount sets the Count field's value.

func (*PendingTaskCount) SetTruncated added in v1.5.0

func (s *PendingTaskCount) SetTruncated(v bool) *PendingTaskCount

SetTruncated sets the Truncated field's value.

func (PendingTaskCount) String added in v0.6.5

func (s PendingTaskCount) String() string

String returns the string representation

type PollForActivityTaskInput

type PollForActivityTaskInput struct {

	// The name of the domain that contains the task lists being polled.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// Identity of the worker making the request, recorded in the ActivityTaskStarted
	// event in the workflow history. This enables diagnostic tracing when problems
	// arise. The form of this identity is user defined.
	Identity *string `locationName:"identity" type:"string"`

	// Specifies the task list to poll for activity tasks.
	//
	// The specified string must not start or end with whitespace. It must not contain
	// a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f
	// | \u007f-\u009f). Also, it must not contain the literal string arn.
	//
	// TaskList is a required field
	TaskList *TaskList `locationName:"taskList" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PollForActivityTaskInput) GoString added in v0.6.5

func (s PollForActivityTaskInput) GoString() string

GoString returns the string representation

func (*PollForActivityTaskInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*PollForActivityTaskInput) SetIdentity added in v1.5.0

SetIdentity sets the Identity field's value.

func (*PollForActivityTaskInput) SetTaskList added in v1.5.0

SetTaskList sets the TaskList field's value.

func (PollForActivityTaskInput) String added in v0.6.5

func (s PollForActivityTaskInput) String() string

String returns the string representation

func (*PollForActivityTaskInput) Validate added in v1.1.21

func (s *PollForActivityTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PollForActivityTaskOutput

type PollForActivityTaskOutput struct {

	// The unique ID of the task.
	//
	// ActivityId is a required field
	ActivityId *string `locationName:"activityId" min:"1" type:"string" required:"true"`

	// The type of this activity task.
	//
	// ActivityType is a required field
	ActivityType *ActivityType `locationName:"activityType" type:"structure" required:"true"`

	// The inputs provided when the activity task was scheduled. The form of the
	// input is user defined and should be meaningful to the activity implementation.
	Input *string `locationName:"input" type:"string"`

	// The ID of the ActivityTaskStarted event recorded in the history.
	//
	// StartedEventId is a required field
	StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`

	// The opaque string used as a handle on the task. This token is used by workers
	// to communicate progress and response information back to the system about
	// the task.
	//
	// TaskToken is a required field
	TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`

	// The workflow execution that started this activity task.
	//
	// WorkflowExecution is a required field
	WorkflowExecution *WorkflowExecution `locationName:"workflowExecution" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Unit of work sent to an activity worker.

func (PollForActivityTaskOutput) GoString added in v0.6.5

func (s PollForActivityTaskOutput) GoString() string

GoString returns the string representation

func (*PollForActivityTaskOutput) SetActivityId added in v1.5.0

SetActivityId sets the ActivityId field's value.

func (*PollForActivityTaskOutput) SetActivityType added in v1.5.0

SetActivityType sets the ActivityType field's value.

func (*PollForActivityTaskOutput) SetInput added in v1.5.0

SetInput sets the Input field's value.

func (*PollForActivityTaskOutput) SetStartedEventId added in v1.5.0

SetStartedEventId sets the StartedEventId field's value.

func (*PollForActivityTaskOutput) SetTaskToken added in v1.5.0

SetTaskToken sets the TaskToken field's value.

func (*PollForActivityTaskOutput) SetWorkflowExecution added in v1.5.0

SetWorkflowExecution sets the WorkflowExecution field's value.

func (PollForActivityTaskOutput) String added in v0.6.5

func (s PollForActivityTaskOutput) String() string

String returns the string representation

type PollForDecisionTaskInput

type PollForDecisionTaskInput struct {

	// The name of the domain containing the task lists to poll.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// Identity of the decider making the request, which is recorded in the DecisionTaskStarted
	// event in the workflow history. This enables diagnostic tracing when problems
	// arise. The form of this identity is user defined.
	Identity *string `locationName:"identity" type:"string"`

	// The maximum number of results that are returned per call. nextPageToken can
	// be used to obtain futher pages of results. The default is 1000, which is
	// the maximum allowed page size. You can, however, specify a page size smaller
	// than the maximum.
	//
	// This is an upper limit only; the actual number of results returned per call
	// may be fewer than the specified maximum.
	MaximumPageSize *int64 `locationName:"maximumPageSize" type:"integer"`

	// 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.
	//
	// The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory
	// to get the next page. You must call PollForDecisionTask again (with the nextPageToken)
	// to retrieve the next page of history records. Calling PollForDecisionTask
	// with a nextPageToken doesn't return a new decision task.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`

	// 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.
	ReverseOrder *bool `locationName:"reverseOrder" type:"boolean"`

	// Specifies the task list to poll for decision tasks.
	//
	// The specified string must not start or end with whitespace. It must not contain
	// a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f
	// | \u007f-\u009f). Also, it must not contain the literal string arn.
	//
	// TaskList is a required field
	TaskList *TaskList `locationName:"taskList" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PollForDecisionTaskInput) GoString added in v0.6.5

func (s PollForDecisionTaskInput) GoString() string

GoString returns the string representation

func (*PollForDecisionTaskInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*PollForDecisionTaskInput) SetIdentity added in v1.5.0

SetIdentity sets the Identity field's value.

func (*PollForDecisionTaskInput) SetMaximumPageSize added in v1.5.0

func (s *PollForDecisionTaskInput) SetMaximumPageSize(v int64) *PollForDecisionTaskInput

SetMaximumPageSize sets the MaximumPageSize field's value.

func (*PollForDecisionTaskInput) SetNextPageToken added in v1.5.0

SetNextPageToken sets the NextPageToken field's value.

func (*PollForDecisionTaskInput) SetReverseOrder added in v1.5.0

SetReverseOrder sets the ReverseOrder field's value.

func (*PollForDecisionTaskInput) SetTaskList added in v1.5.0

SetTaskList sets the TaskList field's value.

func (PollForDecisionTaskInput) String added in v0.6.5

func (s PollForDecisionTaskInput) String() string

String returns the string representation

func (*PollForDecisionTaskInput) Validate added in v1.1.21

func (s *PollForDecisionTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PollForDecisionTaskOutput

type PollForDecisionTaskOutput struct {

	// A paginated list of history events of the workflow execution. The decider
	// uses this during the processing of the decision task.
	//
	// Events is a required field
	Events []*HistoryEvent `locationName:"events" type:"list" required:"true"`

	// 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.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`

	// The ID of the DecisionTaskStarted event of the previous decision task of
	// this workflow execution that was processed by the decider. This can be used
	// to determine the events in the history new since the last decision task received
	// by the decider.
	PreviousStartedEventId *int64 `locationName:"previousStartedEventId" type:"long"`

	// The ID of the DecisionTaskStarted event recorded in the history.
	//
	// StartedEventId is a required field
	StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`

	// The opaque string used as a handle on the task. This token is used by workers
	// to communicate progress and response information back to the system about
	// the task.
	//
	// TaskToken is a required field
	TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`

	// The workflow execution for which this decision task was created.
	//
	// WorkflowExecution is a required field
	WorkflowExecution *WorkflowExecution `locationName:"workflowExecution" type:"structure" required:"true"`

	// The type of the workflow execution for which this decision task was created.
	//
	// WorkflowType is a required field
	WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

A structure that represents a decision task. Decision tasks are sent to deciders in order for them to make decisions.

func (PollForDecisionTaskOutput) GoString added in v0.6.5

func (s PollForDecisionTaskOutput) GoString() string

GoString returns the string representation

func (*PollForDecisionTaskOutput) SetEvents added in v1.5.0

SetEvents sets the Events field's value.

func (*PollForDecisionTaskOutput) SetNextPageToken added in v1.5.0

SetNextPageToken sets the NextPageToken field's value.

func (*PollForDecisionTaskOutput) SetPreviousStartedEventId added in v1.5.0

func (s *PollForDecisionTaskOutput) SetPreviousStartedEventId(v int64) *PollForDecisionTaskOutput

SetPreviousStartedEventId sets the PreviousStartedEventId field's value.

func (*PollForDecisionTaskOutput) SetStartedEventId added in v1.5.0

SetStartedEventId sets the StartedEventId field's value.

func (*PollForDecisionTaskOutput) SetTaskToken added in v1.5.0

SetTaskToken sets the TaskToken field's value.

func (*PollForDecisionTaskOutput) SetWorkflowExecution added in v1.5.0

SetWorkflowExecution sets the WorkflowExecution field's value.

func (*PollForDecisionTaskOutput) SetWorkflowType added in v1.5.0

SetWorkflowType sets the WorkflowType field's value.

func (PollForDecisionTaskOutput) String added in v0.6.5

func (s PollForDecisionTaskOutput) String() string

String returns the string representation

type RecordActivityTaskHeartbeatInput

type RecordActivityTaskHeartbeatInput struct {

	// If specified, contains details about the progress of the task.
	Details *string `locationName:"details" type:"string"`

	// The taskToken of the ActivityTask.
	//
	// taskToken is generated by the service and should be treated as an opaque
	// value. If the task is passed to another process, its taskToken must also
	// be passed. This enables it to provide its progress and respond with results.
	//
	// TaskToken is a required field
	TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RecordActivityTaskHeartbeatInput) GoString added in v0.6.5

GoString returns the string representation

func (*RecordActivityTaskHeartbeatInput) SetDetails added in v1.5.0

SetDetails sets the Details field's value.

func (*RecordActivityTaskHeartbeatInput) SetTaskToken added in v1.5.0

SetTaskToken sets the TaskToken field's value.

func (RecordActivityTaskHeartbeatInput) String added in v0.6.5

String returns the string representation

func (*RecordActivityTaskHeartbeatInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type RecordActivityTaskHeartbeatOutput

type RecordActivityTaskHeartbeatOutput struct {

	// Set to true if cancellation of the task is requested.
	//
	// CancelRequested is a required field
	CancelRequested *bool `locationName:"cancelRequested" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Status information about an activity task.

func (RecordActivityTaskHeartbeatOutput) GoString added in v0.6.5

GoString returns the string representation

func (*RecordActivityTaskHeartbeatOutput) SetCancelRequested added in v1.5.0

SetCancelRequested sets the CancelRequested field's value.

func (RecordActivityTaskHeartbeatOutput) String added in v0.6.5

String returns the string representation

type RecordMarkerDecisionAttributes

type RecordMarkerDecisionAttributes struct {

	// The details of the marker.
	Details *string `locationName:"details" type:"string"`

	// The name of the marker.
	//
	// MarkerName is a required field
	MarkerName *string `locationName:"markerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the RecordMarker decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

func (RecordMarkerDecisionAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*RecordMarkerDecisionAttributes) SetDetails added in v1.5.0

SetDetails sets the Details field's value.

func (*RecordMarkerDecisionAttributes) SetMarkerName added in v1.5.0

SetMarkerName sets the MarkerName field's value.

func (RecordMarkerDecisionAttributes) String added in v0.6.5

String returns the string representation

func (*RecordMarkerDecisionAttributes) Validate added in v1.1.21

func (s *RecordMarkerDecisionAttributes) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RecordMarkerFailedEventAttributes

type RecordMarkerFailedEventAttributes struct {

	// The cause of the failure. This information is generated by the system and
	// can be useful for diagnostic purposes.
	//
	// 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 (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html)
	// in the Amazon SWF Developer Guide.
	//
	// Cause is a required field
	Cause *string `locationName:"cause" type:"string" required:"true" enum:"RecordMarkerFailedCause"`

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// The marker's name.
	//
	// MarkerName is a required field
	MarkerName *string `locationName:"markerName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the RecordMarkerFailed event.

func (RecordMarkerFailedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*RecordMarkerFailedEventAttributes) SetCause added in v1.5.0

SetCause sets the Cause field's value.

func (*RecordMarkerFailedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

func (s *RecordMarkerFailedEventAttributes) SetDecisionTaskCompletedEventId(v int64) *RecordMarkerFailedEventAttributes

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*RecordMarkerFailedEventAttributes) SetMarkerName added in v1.5.0

SetMarkerName sets the MarkerName field's value.

func (RecordMarkerFailedEventAttributes) String added in v0.6.5

String returns the string representation

type RegisterActivityTypeInput

type RegisterActivityTypeInput struct {

	// If set, specifies the default maximum time before which a worker processing
	// a task of this type must report progress by calling RecordActivityTaskHeartbeat.
	// If the timeout is exceeded, the activity task is automatically timed out.
	// This default can be overridden when scheduling an activity task using the
	// ScheduleActivityTaskDecision. If the activity worker subsequently attempts
	// to record a heartbeat or returns a result, the activity worker receives an
	// UnknownResource fault. In this case, Amazon SWF no longer considers the activity
	// task to be valid; the activity worker should clean up the activity task.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	DefaultTaskHeartbeatTimeout *string `locationName:"defaultTaskHeartbeatTimeout" type:"string"`

	// If set, specifies the default task list to use for scheduling tasks of this
	// activity type. This default task list is used if a task list isn't provided
	// when a task is scheduled through the ScheduleActivityTaskDecision.
	DefaultTaskList *TaskList `locationName:"defaultTaskList" type:"structure"`

	// The default task priority to assign to the activity type. If not assigned,
	// then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE
	// (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate
	// higher priority.
	//
	// For more information about setting task priority, see Setting Task Priority
	// (http://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html)
	// in the in the Amazon SWF Developer Guide..
	DefaultTaskPriority *string `locationName:"defaultTaskPriority" type:"string"`

	// If set, specifies the default maximum duration for a task of this activity
	// type. This default can be overridden when scheduling an activity task using
	// the ScheduleActivityTaskDecision.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	DefaultTaskScheduleToCloseTimeout *string `locationName:"defaultTaskScheduleToCloseTimeout" type:"string"`

	// If set, specifies the default maximum duration that a task of this activity
	// type can wait before being assigned to a worker. This default can be overridden
	// when scheduling an activity task using the ScheduleActivityTaskDecision.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	DefaultTaskScheduleToStartTimeout *string `locationName:"defaultTaskScheduleToStartTimeout" type:"string"`

	// If set, specifies the default maximum duration that a worker can take to
	// process tasks of this activity type. This default can be overridden when
	// scheduling an activity task using the ScheduleActivityTaskDecision.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	DefaultTaskStartToCloseTimeout *string `locationName:"defaultTaskStartToCloseTimeout" type:"string"`

	// A textual description of the activity type.
	Description *string `locationName:"description" type:"string"`

	// The name of the domain in which this activity is to be registered.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// The name of the activity type within the domain.
	//
	// The specified string must not start or end with whitespace. It must not contain
	// a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f
	// | \u007f-\u009f). Also, it must not contain the literal string arn.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The version of the activity type.
	//
	// The activity type consists of the name and version, the combination of which
	// must be unique within the domain.
	//
	// The specified string must not start or end with whitespace. It must not contain
	// a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f
	// | \u007f-\u009f). Also, it must not contain the literal string arn.
	//
	// Version is a required field
	Version *string `locationName:"version" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RegisterActivityTypeInput) GoString added in v0.6.5

func (s RegisterActivityTypeInput) GoString() string

GoString returns the string representation

func (*RegisterActivityTypeInput) SetDefaultTaskHeartbeatTimeout added in v1.5.0

func (s *RegisterActivityTypeInput) SetDefaultTaskHeartbeatTimeout(v string) *RegisterActivityTypeInput

SetDefaultTaskHeartbeatTimeout sets the DefaultTaskHeartbeatTimeout field's value.

func (*RegisterActivityTypeInput) SetDefaultTaskList added in v1.5.0

SetDefaultTaskList sets the DefaultTaskList field's value.

func (*RegisterActivityTypeInput) SetDefaultTaskPriority added in v1.5.0

func (s *RegisterActivityTypeInput) SetDefaultTaskPriority(v string) *RegisterActivityTypeInput

SetDefaultTaskPriority sets the DefaultTaskPriority field's value.

func (*RegisterActivityTypeInput) SetDefaultTaskScheduleToCloseTimeout added in v1.5.0

func (s *RegisterActivityTypeInput) SetDefaultTaskScheduleToCloseTimeout(v string) *RegisterActivityTypeInput

SetDefaultTaskScheduleToCloseTimeout sets the DefaultTaskScheduleToCloseTimeout field's value.

func (*RegisterActivityTypeInput) SetDefaultTaskScheduleToStartTimeout added in v1.5.0

func (s *RegisterActivityTypeInput) SetDefaultTaskScheduleToStartTimeout(v string) *RegisterActivityTypeInput

SetDefaultTaskScheduleToStartTimeout sets the DefaultTaskScheduleToStartTimeout field's value.

func (*RegisterActivityTypeInput) SetDefaultTaskStartToCloseTimeout added in v1.5.0

func (s *RegisterActivityTypeInput) SetDefaultTaskStartToCloseTimeout(v string) *RegisterActivityTypeInput

SetDefaultTaskStartToCloseTimeout sets the DefaultTaskStartToCloseTimeout field's value.

func (*RegisterActivityTypeInput) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*RegisterActivityTypeInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*RegisterActivityTypeInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*RegisterActivityTypeInput) SetVersion added in v1.5.0

SetVersion sets the Version field's value.

func (RegisterActivityTypeInput) String added in v0.6.5

func (s RegisterActivityTypeInput) String() string

String returns the string representation

func (*RegisterActivityTypeInput) Validate added in v1.1.21

func (s *RegisterActivityTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterActivityTypeOutput

type RegisterActivityTypeOutput struct {
	// contains filtered or unexported fields
}

func (RegisterActivityTypeOutput) GoString added in v0.6.5

func (s RegisterActivityTypeOutput) GoString() string

GoString returns the string representation

func (RegisterActivityTypeOutput) String added in v0.6.5

String returns the string representation

type RegisterDomainInput

type RegisterDomainInput struct {

	// A text description of the domain.
	Description *string `locationName:"description" type:"string"`

	// Name of the domain to register. The name must be unique in the region that
	// the domain is registered in.
	//
	// The specified string must not start or end with whitespace. It must not contain
	// a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f
	// | \u007f-\u009f). Also, it must not contain the literal string arn.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The duration (in days) that records and histories of workflow executions
	// on the domain should be kept by the service. After the retention period,
	// the workflow execution isn't available in the results of visibility calls.
	//
	// If you pass the value NONE or 0 (zero), then the workflow execution history
	// isn't retained. As soon as the workflow execution completes, the execution
	// record and its history are deleted.
	//
	// The maximum workflow execution retention period is 90 days. For more information
	// about Amazon SWF service limits, see: Amazon SWF Service Limits (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-limits.html)
	// in the Amazon SWF Developer Guide.
	//
	// WorkflowExecutionRetentionPeriodInDays is a required field
	WorkflowExecutionRetentionPeriodInDays *string `locationName:"workflowExecutionRetentionPeriodInDays" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RegisterDomainInput) GoString added in v0.6.5

func (s RegisterDomainInput) GoString() string

GoString returns the string representation

func (*RegisterDomainInput) SetDescription added in v1.5.0

func (s *RegisterDomainInput) SetDescription(v string) *RegisterDomainInput

SetDescription sets the Description field's value.

func (*RegisterDomainInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*RegisterDomainInput) SetWorkflowExecutionRetentionPeriodInDays added in v1.5.0

func (s *RegisterDomainInput) SetWorkflowExecutionRetentionPeriodInDays(v string) *RegisterDomainInput

SetWorkflowExecutionRetentionPeriodInDays sets the WorkflowExecutionRetentionPeriodInDays field's value.

func (RegisterDomainInput) String added in v0.6.5

func (s RegisterDomainInput) String() string

String returns the string representation

func (*RegisterDomainInput) Validate added in v1.1.21

func (s *RegisterDomainInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterDomainOutput

type RegisterDomainOutput struct {
	// contains filtered or unexported fields
}

func (RegisterDomainOutput) GoString added in v0.6.5

func (s RegisterDomainOutput) GoString() string

GoString returns the string representation

func (RegisterDomainOutput) String added in v0.6.5

func (s RegisterDomainOutput) String() string

String returns the string representation

type RegisterWorkflowTypeInput

type RegisterWorkflowTypeInput struct {

	// If set, specifies the default policy to use for the child workflow executions
	// when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution
	// action explicitly or due to an expired timeout. This default can be overridden
	// when starting a workflow execution using the StartWorkflowExecution action
	// or the StartChildWorkflowExecutionDecision.
	//
	// The supported child policies are:
	//
	//    * TERMINATE – The child executions are terminated.
	//
	//    * REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.
	DefaultChildPolicy *string `locationName:"defaultChildPolicy" type:"string" enum:"ChildPolicy"`

	// If set, specifies the default maximum duration for executions of this workflow
	// type. You can override this default when starting an execution through the
	// StartWorkflowExecution Action or StartChildWorkflowExecutionDecision.
	//
	// The duration is specified in seconds; an integer greater than or equal to
	// 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot
	// specify a value of "NONE" for defaultExecutionStartToCloseTimeout; there
	// is a one-year max limit on the time that a workflow execution can run. Exceeding
	// this limit always causes the workflow execution to time out.
	DefaultExecutionStartToCloseTimeout *string `locationName:"defaultExecutionStartToCloseTimeout" type:"string"`

	// The default IAM role attached to this workflow type.
	//
	// Executions of this workflow type need IAM roles to invoke Lambda functions.
	// If you don't specify an IAM role when you start this workflow type, the default
	// Lambda role is attached to the execution. For more information, see http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html
	// (http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html)
	// in the Amazon SWF Developer Guide.
	DefaultLambdaRole *string `locationName:"defaultLambdaRole" min:"1" type:"string"`

	// If set, specifies the default task list to use for scheduling decision tasks
	// for executions of this workflow type. This default is used only if a task
	// list isn't provided when starting the execution through the StartWorkflowExecution
	// Action or StartChildWorkflowExecutionDecision.
	DefaultTaskList *TaskList `locationName:"defaultTaskList" type:"structure"`

	// The default task priority to assign to the workflow type. If not assigned,
	// then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE
	// (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate
	// higher priority.
	//
	// For more information about setting task priority, see Setting Task Priority
	// (http://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html)
	// in the Amazon SWF Developer Guide.
	DefaultTaskPriority *string `locationName:"defaultTaskPriority" type:"string"`

	// If set, specifies the default maximum duration of decision tasks for this
	// workflow type. This default can be overridden when starting a workflow execution
	// using the StartWorkflowExecution action or the StartChildWorkflowExecutionDecision.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	DefaultTaskStartToCloseTimeout *string `locationName:"defaultTaskStartToCloseTimeout" type:"string"`

	// Textual description of the workflow type.
	Description *string `locationName:"description" type:"string"`

	// The name of the domain in which to register the workflow type.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// The name of the workflow type.
	//
	// The specified string must not start or end with whitespace. It must not contain
	// a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f
	// | \u007f-\u009f). Also, it must not contain the literal string arn.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The version of the workflow type.
	//
	// The workflow type consists of the name and version, the combination of which
	// must be unique within the domain. To get a list of all currently registered
	// workflow types, use the ListWorkflowTypes action.
	//
	// The specified string must not start or end with whitespace. It must not contain
	// a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f
	// | \u007f-\u009f). Also, it must not contain the literal string arn.
	//
	// Version is a required field
	Version *string `locationName:"version" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RegisterWorkflowTypeInput) GoString added in v0.6.5

func (s RegisterWorkflowTypeInput) GoString() string

GoString returns the string representation

func (*RegisterWorkflowTypeInput) SetDefaultChildPolicy added in v1.5.0

func (s *RegisterWorkflowTypeInput) SetDefaultChildPolicy(v string) *RegisterWorkflowTypeInput

SetDefaultChildPolicy sets the DefaultChildPolicy field's value.

func (*RegisterWorkflowTypeInput) SetDefaultExecutionStartToCloseTimeout added in v1.5.0

func (s *RegisterWorkflowTypeInput) SetDefaultExecutionStartToCloseTimeout(v string) *RegisterWorkflowTypeInput

SetDefaultExecutionStartToCloseTimeout sets the DefaultExecutionStartToCloseTimeout field's value.

func (*RegisterWorkflowTypeInput) SetDefaultLambdaRole added in v1.5.0

func (s *RegisterWorkflowTypeInput) SetDefaultLambdaRole(v string) *RegisterWorkflowTypeInput

SetDefaultLambdaRole sets the DefaultLambdaRole field's value.

func (*RegisterWorkflowTypeInput) SetDefaultTaskList added in v1.5.0

SetDefaultTaskList sets the DefaultTaskList field's value.

func (*RegisterWorkflowTypeInput) SetDefaultTaskPriority added in v1.5.0

func (s *RegisterWorkflowTypeInput) SetDefaultTaskPriority(v string) *RegisterWorkflowTypeInput

SetDefaultTaskPriority sets the DefaultTaskPriority field's value.

func (*RegisterWorkflowTypeInput) SetDefaultTaskStartToCloseTimeout added in v1.5.0

func (s *RegisterWorkflowTypeInput) SetDefaultTaskStartToCloseTimeout(v string) *RegisterWorkflowTypeInput

SetDefaultTaskStartToCloseTimeout sets the DefaultTaskStartToCloseTimeout field's value.

func (*RegisterWorkflowTypeInput) SetDescription added in v1.5.0

SetDescription sets the Description field's value.

func (*RegisterWorkflowTypeInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*RegisterWorkflowTypeInput) SetName added in v1.5.0

SetName sets the Name field's value.

func (*RegisterWorkflowTypeInput) SetVersion added in v1.5.0

SetVersion sets the Version field's value.

func (RegisterWorkflowTypeInput) String added in v0.6.5

func (s RegisterWorkflowTypeInput) String() string

String returns the string representation

func (*RegisterWorkflowTypeInput) Validate added in v1.1.21

func (s *RegisterWorkflowTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterWorkflowTypeOutput

type RegisterWorkflowTypeOutput struct {
	// contains filtered or unexported fields
}

func (RegisterWorkflowTypeOutput) GoString added in v0.6.5

func (s RegisterWorkflowTypeOutput) GoString() string

GoString returns the string representation

func (RegisterWorkflowTypeOutput) String added in v0.6.5

String returns the string representation

type RequestCancelActivityTaskDecisionAttributes

type RequestCancelActivityTaskDecisionAttributes struct {

	// The activityId of the activity task to be canceled.
	//
	// ActivityId is a required field
	ActivityId *string `locationName:"activityId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the RequestCancelActivityTask decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

func (RequestCancelActivityTaskDecisionAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*RequestCancelActivityTaskDecisionAttributes) SetActivityId added in v1.5.0

SetActivityId sets the ActivityId field's value.

func (RequestCancelActivityTaskDecisionAttributes) String added in v0.6.5

String returns the string representation

func (*RequestCancelActivityTaskDecisionAttributes) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type RequestCancelActivityTaskFailedEventAttributes

type RequestCancelActivityTaskFailedEventAttributes struct {

	// The activityId provided in the RequestCancelActivityTask decision that failed.
	//
	// ActivityId is a required field
	ActivityId *string `locationName:"activityId" min:"1" type:"string" required:"true"`

	// The cause of the failure. This information is generated by the system and
	// can be useful for diagnostic purposes.
	//
	// 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 (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html)
	// in the Amazon SWF Developer Guide.
	//
	// Cause is a required field
	Cause *string `locationName:"cause" type:"string" required:"true" enum:"RequestCancelActivityTaskFailedCause"`

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the RequestCancelActivityTaskFailed event.

func (RequestCancelActivityTaskFailedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*RequestCancelActivityTaskFailedEventAttributes) SetActivityId added in v1.5.0

SetActivityId sets the ActivityId field's value.

func (*RequestCancelActivityTaskFailedEventAttributes) SetCause added in v1.5.0

SetCause sets the Cause field's value.

func (*RequestCancelActivityTaskFailedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (RequestCancelActivityTaskFailedEventAttributes) String added in v0.6.5

String returns the string representation

type RequestCancelExternalWorkflowExecutionDecisionAttributes

type RequestCancelExternalWorkflowExecutionDecisionAttributes struct {

	// The data attached to the event that can be used by the decider in subsequent
	// workflow tasks.
	Control *string `locationName:"control" type:"string"`

	// The runId of the external workflow execution to cancel.
	RunId *string `locationName:"runId" type:"string"`

	// The workflowId of the external workflow execution to cancel.
	//
	// WorkflowId is a required field
	WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the RequestCancelExternalWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

func (RequestCancelExternalWorkflowExecutionDecisionAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*RequestCancelExternalWorkflowExecutionDecisionAttributes) SetControl added in v1.5.0

SetControl sets the Control field's value.

func (*RequestCancelExternalWorkflowExecutionDecisionAttributes) SetRunId added in v1.5.0

SetRunId sets the RunId field's value.

func (*RequestCancelExternalWorkflowExecutionDecisionAttributes) SetWorkflowId added in v1.5.0

SetWorkflowId sets the WorkflowId field's value.

func (RequestCancelExternalWorkflowExecutionDecisionAttributes) String added in v0.6.5

String returns the string representation

func (*RequestCancelExternalWorkflowExecutionDecisionAttributes) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type RequestCancelExternalWorkflowExecutionFailedEventAttributes

type RequestCancelExternalWorkflowExecutionFailedEventAttributes struct {

	// The cause of the failure. This information is generated by the system and
	// can be useful for diagnostic purposes.
	//
	// 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 (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html)
	// in the Amazon SWF Developer Guide.
	//
	// Cause is a required field
	Cause *string `locationName:"cause" type:"string" required:"true" enum:"RequestCancelExternalWorkflowExecutionFailedCause"`

	// The data attached to the event that the decider can use in subsequent workflow
	// tasks. This data isn't sent to the workflow execution.
	Control *string `locationName:"control" type:"string"`

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// 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.
	//
	// InitiatedEventId is a required field
	InitiatedEventId *int64 `locationName:"initiatedEventId" type:"long" required:"true"`

	// The runId of the external workflow execution.
	RunId *string `locationName:"runId" type:"string"`

	// The workflowId of the external workflow to which the cancel request was to
	// be delivered.
	//
	// WorkflowId is a required field
	WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the RequestCancelExternalWorkflowExecutionFailed event.

func (RequestCancelExternalWorkflowExecutionFailedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*RequestCancelExternalWorkflowExecutionFailedEventAttributes) SetCause added in v1.5.0

SetCause sets the Cause field's value.

func (*RequestCancelExternalWorkflowExecutionFailedEventAttributes) SetControl added in v1.5.0

SetControl sets the Control field's value.

func (*RequestCancelExternalWorkflowExecutionFailedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*RequestCancelExternalWorkflowExecutionFailedEventAttributes) SetInitiatedEventId added in v1.5.0

SetInitiatedEventId sets the InitiatedEventId field's value.

func (*RequestCancelExternalWorkflowExecutionFailedEventAttributes) SetRunId added in v1.5.0

SetRunId sets the RunId field's value.

func (*RequestCancelExternalWorkflowExecutionFailedEventAttributes) SetWorkflowId added in v1.5.0

SetWorkflowId sets the WorkflowId field's value.

func (RequestCancelExternalWorkflowExecutionFailedEventAttributes) String added in v0.6.5

String returns the string representation

type RequestCancelExternalWorkflowExecutionInitiatedEventAttributes

type RequestCancelExternalWorkflowExecutionInitiatedEventAttributes struct {

	// Data attached to the event that can be used by the decider in subsequent
	// workflow tasks.
	Control *string `locationName:"control" type:"string"`

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// The runId of the external workflow execution to be canceled.
	RunId *string `locationName:"runId" type:"string"`

	// The workflowId of the external workflow execution to be canceled.
	//
	// WorkflowId is a required field
	WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the RequestCancelExternalWorkflowExecutionInitiated event.

func (RequestCancelExternalWorkflowExecutionInitiatedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*RequestCancelExternalWorkflowExecutionInitiatedEventAttributes) SetControl added in v1.5.0

SetControl sets the Control field's value.

func (*RequestCancelExternalWorkflowExecutionInitiatedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*RequestCancelExternalWorkflowExecutionInitiatedEventAttributes) SetRunId added in v1.5.0

SetRunId sets the RunId field's value.

func (*RequestCancelExternalWorkflowExecutionInitiatedEventAttributes) SetWorkflowId added in v1.5.0

SetWorkflowId sets the WorkflowId field's value.

func (RequestCancelExternalWorkflowExecutionInitiatedEventAttributes) String added in v0.6.5

String returns the string representation

type RequestCancelWorkflowExecutionInput

type RequestCancelWorkflowExecutionInput struct {

	// The name of the domain containing the workflow execution to cancel.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// The runId of the workflow execution to cancel.
	RunId *string `locationName:"runId" type:"string"`

	// The workflowId of the workflow execution to cancel.
	//
	// WorkflowId is a required field
	WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RequestCancelWorkflowExecutionInput) GoString added in v0.6.5

GoString returns the string representation

func (*RequestCancelWorkflowExecutionInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*RequestCancelWorkflowExecutionInput) SetRunId added in v1.5.0

SetRunId sets the RunId field's value.

func (*RequestCancelWorkflowExecutionInput) SetWorkflowId added in v1.5.0

SetWorkflowId sets the WorkflowId field's value.

func (RequestCancelWorkflowExecutionInput) String added in v0.6.5

String returns the string representation

func (*RequestCancelWorkflowExecutionInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type RequestCancelWorkflowExecutionOutput

type RequestCancelWorkflowExecutionOutput struct {
	// contains filtered or unexported fields
}

func (RequestCancelWorkflowExecutionOutput) GoString added in v0.6.5

GoString returns the string representation

func (RequestCancelWorkflowExecutionOutput) String added in v0.6.5

String returns the string representation

type RespondActivityTaskCanceledInput

type RespondActivityTaskCanceledInput struct {

	// Information about the cancellation.
	Details *string `locationName:"details" type:"string"`

	// The taskToken of the ActivityTask.
	//
	// taskToken is generated by the service and should be treated as an opaque
	// value. If the task is passed to another process, its taskToken must also
	// be passed. This enables it to provide its progress and respond with results.
	//
	// TaskToken is a required field
	TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RespondActivityTaskCanceledInput) GoString added in v0.6.5

GoString returns the string representation

func (*RespondActivityTaskCanceledInput) SetDetails added in v1.5.0

SetDetails sets the Details field's value.

func (*RespondActivityTaskCanceledInput) SetTaskToken added in v1.5.0

SetTaskToken sets the TaskToken field's value.

func (RespondActivityTaskCanceledInput) String added in v0.6.5

String returns the string representation

func (*RespondActivityTaskCanceledInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type RespondActivityTaskCanceledOutput

type RespondActivityTaskCanceledOutput struct {
	// contains filtered or unexported fields
}

func (RespondActivityTaskCanceledOutput) GoString added in v0.6.5

GoString returns the string representation

func (RespondActivityTaskCanceledOutput) String added in v0.6.5

String returns the string representation

type RespondActivityTaskCompletedInput

type RespondActivityTaskCompletedInput struct {

	// The result of the activity task. It is a free form string that is implementation
	// specific.
	Result *string `locationName:"result" type:"string"`

	// The taskToken of the ActivityTask.
	//
	// taskToken is generated by the service and should be treated as an opaque
	// value. If the task is passed to another process, its taskToken must also
	// be passed. This enables it to provide its progress and respond with results.
	//
	// TaskToken is a required field
	TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RespondActivityTaskCompletedInput) GoString added in v0.6.5

GoString returns the string representation

func (*RespondActivityTaskCompletedInput) SetResult added in v1.5.0

SetResult sets the Result field's value.

func (*RespondActivityTaskCompletedInput) SetTaskToken added in v1.5.0

SetTaskToken sets the TaskToken field's value.

func (RespondActivityTaskCompletedInput) String added in v0.6.5

String returns the string representation

func (*RespondActivityTaskCompletedInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type RespondActivityTaskCompletedOutput

type RespondActivityTaskCompletedOutput struct {
	// contains filtered or unexported fields
}

func (RespondActivityTaskCompletedOutput) GoString added in v0.6.5

GoString returns the string representation

func (RespondActivityTaskCompletedOutput) String added in v0.6.5

String returns the string representation

type RespondActivityTaskFailedInput

type RespondActivityTaskFailedInput struct {

	// Detailed information about the failure.
	Details *string `locationName:"details" type:"string"`

	// Description of the error that may assist in diagnostics.
	Reason *string `locationName:"reason" type:"string"`

	// The taskToken of the ActivityTask.
	//
	// taskToken is generated by the service and should be treated as an opaque
	// value. If the task is passed to another process, its taskToken must also
	// be passed. This enables it to provide its progress and respond with results.
	//
	// TaskToken is a required field
	TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RespondActivityTaskFailedInput) GoString added in v0.6.5

GoString returns the string representation

func (*RespondActivityTaskFailedInput) SetDetails added in v1.5.0

SetDetails sets the Details field's value.

func (*RespondActivityTaskFailedInput) SetReason added in v1.5.0

SetReason sets the Reason field's value.

func (*RespondActivityTaskFailedInput) SetTaskToken added in v1.5.0

SetTaskToken sets the TaskToken field's value.

func (RespondActivityTaskFailedInput) String added in v0.6.5

String returns the string representation

func (*RespondActivityTaskFailedInput) Validate added in v1.1.21

func (s *RespondActivityTaskFailedInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RespondActivityTaskFailedOutput

type RespondActivityTaskFailedOutput struct {
	// contains filtered or unexported fields
}

func (RespondActivityTaskFailedOutput) GoString added in v0.6.5

GoString returns the string representation

func (RespondActivityTaskFailedOutput) String added in v0.6.5

String returns the string representation

type RespondDecisionTaskCompletedInput

type RespondDecisionTaskCompletedInput struct {

	// The list of decisions (possibly empty) made by the decider while processing
	// this decision task. See the docs for the Decision structure for details.
	Decisions []*Decision `locationName:"decisions" type:"list"`

	// User defined context to add to workflow execution.
	ExecutionContext *string `locationName:"executionContext" type:"string"`

	// The taskToken from the DecisionTask.
	//
	// taskToken is generated by the service and should be treated as an opaque
	// value. If the task is passed to another process, its taskToken must also
	// be passed. This enables it to provide its progress and respond with results.
	//
	// TaskToken is a required field
	TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input data for a TaskCompleted response to a decision task.

func (RespondDecisionTaskCompletedInput) GoString added in v0.6.5

GoString returns the string representation

func (*RespondDecisionTaskCompletedInput) SetDecisions added in v1.5.0

SetDecisions sets the Decisions field's value.

func (*RespondDecisionTaskCompletedInput) SetExecutionContext added in v1.5.0

SetExecutionContext sets the ExecutionContext field's value.

func (*RespondDecisionTaskCompletedInput) SetTaskToken added in v1.5.0

SetTaskToken sets the TaskToken field's value.

func (RespondDecisionTaskCompletedInput) String added in v0.6.5

String returns the string representation

func (*RespondDecisionTaskCompletedInput) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type RespondDecisionTaskCompletedOutput

type RespondDecisionTaskCompletedOutput struct {
	// contains filtered or unexported fields
}

func (RespondDecisionTaskCompletedOutput) GoString added in v0.6.5

GoString returns the string representation

func (RespondDecisionTaskCompletedOutput) String added in v0.6.5

String returns the string representation

type SWF

type SWF struct {
	*client.Client
}

SWF provides the API operation methods for making requests to Amazon Simple Workflow Service. See this package's package overview docs for details on the service.

SWF methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *SWF

New creates a new instance of the SWF client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a SWF client from just a session.
svc := swf.New(mySession)

// Create a SWF client with additional configuration
svc := swf.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*SWF) CountClosedWorkflowExecutions

func (c *SWF) CountClosedWorkflowExecutions(input *CountClosedWorkflowExecutionsInput) (*WorkflowExecutionCount, error)

CountClosedWorkflowExecutions API operation for Amazon Simple Workflow Service.

Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.

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:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

typeFilter.name: String constraint. The key is swf:typeFilter.name.

typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation CountClosedWorkflowExecutions for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) CountClosedWorkflowExecutionsRequest

func (c *SWF) CountClosedWorkflowExecutionsRequest(input *CountClosedWorkflowExecutionsInput) (req *request.Request, output *WorkflowExecutionCount)

CountClosedWorkflowExecutionsRequest generates a "aws/request.Request" representing the client's request for the CountClosedWorkflowExecutions operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CountClosedWorkflowExecutions for more information on using the CountClosedWorkflowExecutions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CountClosedWorkflowExecutionsRequest method.
req, resp := client.CountClosedWorkflowExecutionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) CountClosedWorkflowExecutionsWithContext added in v1.8.0

func (c *SWF) CountClosedWorkflowExecutionsWithContext(ctx aws.Context, input *CountClosedWorkflowExecutionsInput, opts ...request.Option) (*WorkflowExecutionCount, error)

CountClosedWorkflowExecutionsWithContext is the same as CountClosedWorkflowExecutions with the addition of the ability to pass a context and additional request options.

See CountClosedWorkflowExecutions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) CountOpenWorkflowExecutions

func (c *SWF) CountOpenWorkflowExecutions(input *CountOpenWorkflowExecutionsInput) (*WorkflowExecutionCount, error)

CountOpenWorkflowExecutions API operation for Amazon Simple Workflow Service.

Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.

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:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

typeFilter.name: String constraint. The key is swf:typeFilter.name.

typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation CountOpenWorkflowExecutions for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) CountOpenWorkflowExecutionsRequest

func (c *SWF) CountOpenWorkflowExecutionsRequest(input *CountOpenWorkflowExecutionsInput) (req *request.Request, output *WorkflowExecutionCount)

CountOpenWorkflowExecutionsRequest generates a "aws/request.Request" representing the client's request for the CountOpenWorkflowExecutions operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CountOpenWorkflowExecutions for more information on using the CountOpenWorkflowExecutions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CountOpenWorkflowExecutionsRequest method.
req, resp := client.CountOpenWorkflowExecutionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) CountOpenWorkflowExecutionsWithContext added in v1.8.0

func (c *SWF) CountOpenWorkflowExecutionsWithContext(ctx aws.Context, input *CountOpenWorkflowExecutionsInput, opts ...request.Option) (*WorkflowExecutionCount, error)

CountOpenWorkflowExecutionsWithContext is the same as CountOpenWorkflowExecutions with the addition of the ability to pass a context and additional request options.

See CountOpenWorkflowExecutions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) CountPendingActivityTasks

func (c *SWF) CountPendingActivityTasks(input *CountPendingActivityTasksInput) (*PendingTaskCount, error)

CountPendingActivityTasks API operation for Amazon Simple Workflow Service.

Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 is returned.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation CountPendingActivityTasks for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) CountPendingActivityTasksRequest

func (c *SWF) CountPendingActivityTasksRequest(input *CountPendingActivityTasksInput) (req *request.Request, output *PendingTaskCount)

CountPendingActivityTasksRequest generates a "aws/request.Request" representing the client's request for the CountPendingActivityTasks operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CountPendingActivityTasks for more information on using the CountPendingActivityTasks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CountPendingActivityTasksRequest method.
req, resp := client.CountPendingActivityTasksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) CountPendingActivityTasksWithContext added in v1.8.0

func (c *SWF) CountPendingActivityTasksWithContext(ctx aws.Context, input *CountPendingActivityTasksInput, opts ...request.Option) (*PendingTaskCount, error)

CountPendingActivityTasksWithContext is the same as CountPendingActivityTasks with the addition of the ability to pass a context and additional request options.

See CountPendingActivityTasks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) CountPendingDecisionTasks

func (c *SWF) CountPendingDecisionTasks(input *CountPendingDecisionTasksInput) (*PendingTaskCount, error)

CountPendingDecisionTasks API operation for Amazon Simple Workflow Service.

Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 is returned.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation CountPendingDecisionTasks for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) CountPendingDecisionTasksRequest

func (c *SWF) CountPendingDecisionTasksRequest(input *CountPendingDecisionTasksInput) (req *request.Request, output *PendingTaskCount)

CountPendingDecisionTasksRequest generates a "aws/request.Request" representing the client's request for the CountPendingDecisionTasks operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CountPendingDecisionTasks for more information on using the CountPendingDecisionTasks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CountPendingDecisionTasksRequest method.
req, resp := client.CountPendingDecisionTasksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) CountPendingDecisionTasksWithContext added in v1.8.0

func (c *SWF) CountPendingDecisionTasksWithContext(ctx aws.Context, input *CountPendingDecisionTasksInput, opts ...request.Option) (*PendingTaskCount, error)

CountPendingDecisionTasksWithContext is the same as CountPendingDecisionTasks with the addition of the ability to pass a context and additional request options.

See CountPendingDecisionTasks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) DeprecateActivityType

func (c *SWF) DeprecateActivityType(input *DeprecateActivityTypeInput) (*DeprecateActivityTypeOutput, error)

DeprecateActivityType API operation for Amazon Simple Workflow Service.

Deprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated continue to run.

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:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

activityType.name: String constraint. The key is swf:activityType.name.

activityType.version: String constraint. The key is swf:activityType.version.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation DeprecateActivityType for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeTypeDeprecatedFault "TypeDeprecatedFault" Returned when the specified activity or workflow type was already deprecated.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) DeprecateActivityTypeRequest

func (c *SWF) DeprecateActivityTypeRequest(input *DeprecateActivityTypeInput) (req *request.Request, output *DeprecateActivityTypeOutput)

DeprecateActivityTypeRequest generates a "aws/request.Request" representing the client's request for the DeprecateActivityType operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeprecateActivityType for more information on using the DeprecateActivityType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeprecateActivityTypeRequest method.
req, resp := client.DeprecateActivityTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) DeprecateActivityTypeWithContext added in v1.8.0

func (c *SWF) DeprecateActivityTypeWithContext(ctx aws.Context, input *DeprecateActivityTypeInput, opts ...request.Option) (*DeprecateActivityTypeOutput, error)

DeprecateActivityTypeWithContext is the same as DeprecateActivityType with the addition of the ability to pass a context and additional request options.

See DeprecateActivityType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) DeprecateDomain

func (c *SWF) DeprecateDomain(input *DeprecateDomainInput) (*DeprecateDomainOutput, error)

DeprecateDomain API operation for Amazon Simple Workflow Service.

Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated continues to run.

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:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation DeprecateDomain for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeDomainDeprecatedFault "DomainDeprecatedFault" Returned when the specified domain has been deprecated.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) DeprecateDomainRequest

func (c *SWF) DeprecateDomainRequest(input *DeprecateDomainInput) (req *request.Request, output *DeprecateDomainOutput)

DeprecateDomainRequest generates a "aws/request.Request" representing the client's request for the DeprecateDomain operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeprecateDomain for more information on using the DeprecateDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeprecateDomainRequest method.
req, resp := client.DeprecateDomainRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) DeprecateDomainWithContext added in v1.8.0

func (c *SWF) DeprecateDomainWithContext(ctx aws.Context, input *DeprecateDomainInput, opts ...request.Option) (*DeprecateDomainOutput, error)

DeprecateDomainWithContext is the same as DeprecateDomain with the addition of the ability to pass a context and additional request options.

See DeprecateDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) DeprecateWorkflowType

func (c *SWF) DeprecateWorkflowType(input *DeprecateWorkflowTypeInput) (*DeprecateWorkflowTypeOutput, error)

DeprecateWorkflowType API operation for Amazon Simple Workflow Service.

Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated continues to run. A deprecated workflow type may still be used when calling visibility actions.

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:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

workflowType.name: String constraint. The key is swf:workflowType.name.

workflowType.version: String constraint. The key is swf:workflowType.version.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation DeprecateWorkflowType for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeTypeDeprecatedFault "TypeDeprecatedFault" Returned when the specified activity or workflow type was already deprecated.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) DeprecateWorkflowTypeRequest

func (c *SWF) DeprecateWorkflowTypeRequest(input *DeprecateWorkflowTypeInput) (req *request.Request, output *DeprecateWorkflowTypeOutput)

DeprecateWorkflowTypeRequest generates a "aws/request.Request" representing the client's request for the DeprecateWorkflowType operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeprecateWorkflowType for more information on using the DeprecateWorkflowType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeprecateWorkflowTypeRequest method.
req, resp := client.DeprecateWorkflowTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) DeprecateWorkflowTypeWithContext added in v1.8.0

func (c *SWF) DeprecateWorkflowTypeWithContext(ctx aws.Context, input *DeprecateWorkflowTypeInput, opts ...request.Option) (*DeprecateWorkflowTypeOutput, error)

DeprecateWorkflowTypeWithContext is the same as DeprecateWorkflowType with the addition of the ability to pass a context and additional request options.

See DeprecateWorkflowType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) DescribeActivityType

func (c *SWF) DescribeActivityType(input *DescribeActivityTypeInput) (*DescribeActivityTypeOutput, error)

DescribeActivityType API operation for Amazon Simple Workflow Service.

Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

activityType.name: String constraint. The key is swf:activityType.name.

activityType.version: String constraint. The key is swf:activityType.version.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation DescribeActivityType for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) DescribeActivityTypeRequest

func (c *SWF) DescribeActivityTypeRequest(input *DescribeActivityTypeInput) (req *request.Request, output *DescribeActivityTypeOutput)

DescribeActivityTypeRequest generates a "aws/request.Request" representing the client's request for the DescribeActivityType operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeActivityType for more information on using the DescribeActivityType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeActivityTypeRequest method.
req, resp := client.DescribeActivityTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) DescribeActivityTypeWithContext added in v1.8.0

func (c *SWF) DescribeActivityTypeWithContext(ctx aws.Context, input *DescribeActivityTypeInput, opts ...request.Option) (*DescribeActivityTypeOutput, error)

DescribeActivityTypeWithContext is the same as DescribeActivityType with the addition of the ability to pass a context and additional request options.

See DescribeActivityType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) DescribeDomain

func (c *SWF) DescribeDomain(input *DescribeDomainInput) (*DescribeDomainOutput, error)

DescribeDomain API operation for Amazon Simple Workflow Service.

Returns information about the specified domain, including description and status.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation DescribeDomain for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) DescribeDomainRequest

func (c *SWF) DescribeDomainRequest(input *DescribeDomainInput) (req *request.Request, output *DescribeDomainOutput)

DescribeDomainRequest generates a "aws/request.Request" representing the client's request for the DescribeDomain operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDomain for more information on using the DescribeDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDomainRequest method.
req, resp := client.DescribeDomainRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) DescribeDomainWithContext added in v1.8.0

func (c *SWF) DescribeDomainWithContext(ctx aws.Context, input *DescribeDomainInput, opts ...request.Option) (*DescribeDomainOutput, error)

DescribeDomainWithContext is the same as DescribeDomain with the addition of the ability to pass a context and additional request options.

See DescribeDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) DescribeWorkflowExecution

func (c *SWF) DescribeWorkflowExecution(input *DescribeWorkflowExecutionInput) (*DescribeWorkflowExecutionOutput, error)

DescribeWorkflowExecution API operation for Amazon Simple Workflow Service.

Returns information about the specified workflow execution including its type and some statistics.

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:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation DescribeWorkflowExecution for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) DescribeWorkflowExecutionRequest

func (c *SWF) DescribeWorkflowExecutionRequest(input *DescribeWorkflowExecutionInput) (req *request.Request, output *DescribeWorkflowExecutionOutput)

DescribeWorkflowExecutionRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkflowExecution operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWorkflowExecution for more information on using the DescribeWorkflowExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeWorkflowExecutionRequest method.
req, resp := client.DescribeWorkflowExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) DescribeWorkflowExecutionWithContext added in v1.8.0

func (c *SWF) DescribeWorkflowExecutionWithContext(ctx aws.Context, input *DescribeWorkflowExecutionInput, opts ...request.Option) (*DescribeWorkflowExecutionOutput, error)

DescribeWorkflowExecutionWithContext is the same as DescribeWorkflowExecution with the addition of the ability to pass a context and additional request options.

See DescribeWorkflowExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) DescribeWorkflowType

func (c *SWF) DescribeWorkflowType(input *DescribeWorkflowTypeInput) (*DescribeWorkflowTypeOutput, error)

DescribeWorkflowType API operation for Amazon Simple Workflow Service.

Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

workflowType.name: String constraint. The key is swf:workflowType.name.

workflowType.version: String constraint. The key is swf:workflowType.version.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation DescribeWorkflowType for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) DescribeWorkflowTypeRequest

func (c *SWF) DescribeWorkflowTypeRequest(input *DescribeWorkflowTypeInput) (req *request.Request, output *DescribeWorkflowTypeOutput)

DescribeWorkflowTypeRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkflowType operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWorkflowType for more information on using the DescribeWorkflowType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeWorkflowTypeRequest method.
req, resp := client.DescribeWorkflowTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) DescribeWorkflowTypeWithContext added in v1.8.0

func (c *SWF) DescribeWorkflowTypeWithContext(ctx aws.Context, input *DescribeWorkflowTypeInput, opts ...request.Option) (*DescribeWorkflowTypeOutput, error)

DescribeWorkflowTypeWithContext is the same as DescribeWorkflowType with the addition of the ability to pass a context and additional request options.

See DescribeWorkflowType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) GetWorkflowExecutionHistory

func (c *SWF) GetWorkflowExecutionHistory(input *GetWorkflowExecutionHistoryInput) (*GetWorkflowExecutionHistoryOutput, error)

GetWorkflowExecutionHistory API operation for Amazon Simple Workflow Service.

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.

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:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation GetWorkflowExecutionHistory for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) GetWorkflowExecutionHistoryPages

func (c *SWF) GetWorkflowExecutionHistoryPages(input *GetWorkflowExecutionHistoryInput, fn func(*GetWorkflowExecutionHistoryOutput, bool) bool) error

GetWorkflowExecutionHistoryPages iterates over the pages of a GetWorkflowExecutionHistory operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetWorkflowExecutionHistory method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetWorkflowExecutionHistory operation.
pageNum := 0
err := client.GetWorkflowExecutionHistoryPages(params,
    func(page *GetWorkflowExecutionHistoryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SWF) GetWorkflowExecutionHistoryPagesWithContext added in v1.8.0

func (c *SWF) GetWorkflowExecutionHistoryPagesWithContext(ctx aws.Context, input *GetWorkflowExecutionHistoryInput, fn func(*GetWorkflowExecutionHistoryOutput, bool) bool, opts ...request.Option) error

GetWorkflowExecutionHistoryPagesWithContext same as GetWorkflowExecutionHistoryPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) GetWorkflowExecutionHistoryRequest

func (c *SWF) GetWorkflowExecutionHistoryRequest(input *GetWorkflowExecutionHistoryInput) (req *request.Request, output *GetWorkflowExecutionHistoryOutput)

GetWorkflowExecutionHistoryRequest generates a "aws/request.Request" representing the client's request for the GetWorkflowExecutionHistory operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetWorkflowExecutionHistory for more information on using the GetWorkflowExecutionHistory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetWorkflowExecutionHistoryRequest method.
req, resp := client.GetWorkflowExecutionHistoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) GetWorkflowExecutionHistoryWithContext added in v1.8.0

func (c *SWF) GetWorkflowExecutionHistoryWithContext(ctx aws.Context, input *GetWorkflowExecutionHistoryInput, opts ...request.Option) (*GetWorkflowExecutionHistoryOutput, error)

GetWorkflowExecutionHistoryWithContext is the same as GetWorkflowExecutionHistory with the addition of the ability to pass a context and additional request options.

See GetWorkflowExecutionHistory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) ListActivityTypes

func (c *SWF) ListActivityTypes(input *ListActivityTypesInput) (*ListActivityTypesOutput, error)

ListActivityTypes API operation for Amazon Simple Workflow Service.

Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation ListActivityTypes for usage and error information.

Returned Error Codes:

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

func (*SWF) ListActivityTypesPages

func (c *SWF) ListActivityTypesPages(input *ListActivityTypesInput, fn func(*ListActivityTypesOutput, bool) bool) error

ListActivityTypesPages iterates over the pages of a ListActivityTypes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListActivityTypes method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListActivityTypes operation.
pageNum := 0
err := client.ListActivityTypesPages(params,
    func(page *ListActivityTypesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SWF) ListActivityTypesPagesWithContext added in v1.8.0

func (c *SWF) ListActivityTypesPagesWithContext(ctx aws.Context, input *ListActivityTypesInput, fn func(*ListActivityTypesOutput, bool) bool, opts ...request.Option) error

ListActivityTypesPagesWithContext same as ListActivityTypesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) ListActivityTypesRequest

func (c *SWF) ListActivityTypesRequest(input *ListActivityTypesInput) (req *request.Request, output *ListActivityTypesOutput)

ListActivityTypesRequest generates a "aws/request.Request" representing the client's request for the ListActivityTypes operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListActivityTypes for more information on using the ListActivityTypes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListActivityTypesRequest method.
req, resp := client.ListActivityTypesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) ListActivityTypesWithContext added in v1.8.0

func (c *SWF) ListActivityTypesWithContext(ctx aws.Context, input *ListActivityTypesInput, opts ...request.Option) (*ListActivityTypesOutput, error)

ListActivityTypesWithContext is the same as ListActivityTypes with the addition of the ability to pass a context and additional request options.

See ListActivityTypes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) ListClosedWorkflowExecutions

func (c *SWF) ListClosedWorkflowExecutions(input *ListClosedWorkflowExecutionsInput) (*WorkflowExecutionInfos, error)

ListClosedWorkflowExecutions API operation for Amazon Simple Workflow Service.

Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

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:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

typeFilter.name: String constraint. The key is swf:typeFilter.name.

typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation ListClosedWorkflowExecutions for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) ListClosedWorkflowExecutionsPages

func (c *SWF) ListClosedWorkflowExecutionsPages(input *ListClosedWorkflowExecutionsInput, fn func(*WorkflowExecutionInfos, bool) bool) error

ListClosedWorkflowExecutionsPages iterates over the pages of a ListClosedWorkflowExecutions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListClosedWorkflowExecutions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListClosedWorkflowExecutions operation.
pageNum := 0
err := client.ListClosedWorkflowExecutionsPages(params,
    func(page *WorkflowExecutionInfos, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SWF) ListClosedWorkflowExecutionsPagesWithContext added in v1.8.0

func (c *SWF) ListClosedWorkflowExecutionsPagesWithContext(ctx aws.Context, input *ListClosedWorkflowExecutionsInput, fn func(*WorkflowExecutionInfos, bool) bool, opts ...request.Option) error

ListClosedWorkflowExecutionsPagesWithContext same as ListClosedWorkflowExecutionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) ListClosedWorkflowExecutionsRequest

func (c *SWF) ListClosedWorkflowExecutionsRequest(input *ListClosedWorkflowExecutionsInput) (req *request.Request, output *WorkflowExecutionInfos)

ListClosedWorkflowExecutionsRequest generates a "aws/request.Request" representing the client's request for the ListClosedWorkflowExecutions operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListClosedWorkflowExecutions for more information on using the ListClosedWorkflowExecutions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListClosedWorkflowExecutionsRequest method.
req, resp := client.ListClosedWorkflowExecutionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) ListClosedWorkflowExecutionsWithContext added in v1.8.0

func (c *SWF) ListClosedWorkflowExecutionsWithContext(ctx aws.Context, input *ListClosedWorkflowExecutionsInput, opts ...request.Option) (*WorkflowExecutionInfos, error)

ListClosedWorkflowExecutionsWithContext is the same as ListClosedWorkflowExecutions with the addition of the ability to pass a context and additional request options.

See ListClosedWorkflowExecutions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) ListDomains

func (c *SWF) ListDomains(input *ListDomainsInput) (*ListDomainsOutput, error)

ListDomains API operation for Amazon Simple Workflow Service.

Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

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:

  • Use a Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation ListDomains for usage and error information.

Returned Error Codes:

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) ListDomainsPages

func (c *SWF) ListDomainsPages(input *ListDomainsInput, fn func(*ListDomainsOutput, bool) bool) error

ListDomainsPages iterates over the pages of a ListDomains operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDomains method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListDomains operation.
pageNum := 0
err := client.ListDomainsPages(params,
    func(page *ListDomainsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SWF) ListDomainsPagesWithContext added in v1.8.0

func (c *SWF) ListDomainsPagesWithContext(ctx aws.Context, input *ListDomainsInput, fn func(*ListDomainsOutput, bool) bool, opts ...request.Option) error

ListDomainsPagesWithContext same as ListDomainsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) ListDomainsRequest

func (c *SWF) ListDomainsRequest(input *ListDomainsInput) (req *request.Request, output *ListDomainsOutput)

ListDomainsRequest generates a "aws/request.Request" representing the client's request for the ListDomains operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDomains for more information on using the ListDomains API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDomainsRequest method.
req, resp := client.ListDomainsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) ListDomainsWithContext added in v1.8.0

func (c *SWF) ListDomainsWithContext(ctx aws.Context, input *ListDomainsInput, opts ...request.Option) (*ListDomainsOutput, error)

ListDomainsWithContext is the same as ListDomains with the addition of the ability to pass a context and additional request options.

See ListDomains for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) ListOpenWorkflowExecutions

func (c *SWF) ListOpenWorkflowExecutions(input *ListOpenWorkflowExecutionsInput) (*WorkflowExecutionInfos, error)

ListOpenWorkflowExecutions API operation for Amazon Simple Workflow Service.

Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

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:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

typeFilter.name: String constraint. The key is swf:typeFilter.name.

typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation ListOpenWorkflowExecutions for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) ListOpenWorkflowExecutionsPages

func (c *SWF) ListOpenWorkflowExecutionsPages(input *ListOpenWorkflowExecutionsInput, fn func(*WorkflowExecutionInfos, bool) bool) error

ListOpenWorkflowExecutionsPages iterates over the pages of a ListOpenWorkflowExecutions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListOpenWorkflowExecutions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListOpenWorkflowExecutions operation.
pageNum := 0
err := client.ListOpenWorkflowExecutionsPages(params,
    func(page *WorkflowExecutionInfos, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SWF) ListOpenWorkflowExecutionsPagesWithContext added in v1.8.0

func (c *SWF) ListOpenWorkflowExecutionsPagesWithContext(ctx aws.Context, input *ListOpenWorkflowExecutionsInput, fn func(*WorkflowExecutionInfos, bool) bool, opts ...request.Option) error

ListOpenWorkflowExecutionsPagesWithContext same as ListOpenWorkflowExecutionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) ListOpenWorkflowExecutionsRequest

func (c *SWF) ListOpenWorkflowExecutionsRequest(input *ListOpenWorkflowExecutionsInput) (req *request.Request, output *WorkflowExecutionInfos)

ListOpenWorkflowExecutionsRequest generates a "aws/request.Request" representing the client's request for the ListOpenWorkflowExecutions operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListOpenWorkflowExecutions for more information on using the ListOpenWorkflowExecutions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListOpenWorkflowExecutionsRequest method.
req, resp := client.ListOpenWorkflowExecutionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) ListOpenWorkflowExecutionsWithContext added in v1.8.0

func (c *SWF) ListOpenWorkflowExecutionsWithContext(ctx aws.Context, input *ListOpenWorkflowExecutionsInput, opts ...request.Option) (*WorkflowExecutionInfos, error)

ListOpenWorkflowExecutionsWithContext is the same as ListOpenWorkflowExecutions with the addition of the ability to pass a context and additional request options.

See ListOpenWorkflowExecutions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) ListWorkflowTypes

func (c *SWF) ListWorkflowTypes(input *ListWorkflowTypesInput) (*ListWorkflowTypesOutput, error)

ListWorkflowTypes API operation for Amazon Simple Workflow Service.

Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation ListWorkflowTypes for usage and error information.

Returned Error Codes:

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

func (*SWF) ListWorkflowTypesPages

func (c *SWF) ListWorkflowTypesPages(input *ListWorkflowTypesInput, fn func(*ListWorkflowTypesOutput, bool) bool) error

ListWorkflowTypesPages iterates over the pages of a ListWorkflowTypes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListWorkflowTypes method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListWorkflowTypes operation.
pageNum := 0
err := client.ListWorkflowTypesPages(params,
    func(page *ListWorkflowTypesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SWF) ListWorkflowTypesPagesWithContext added in v1.8.0

func (c *SWF) ListWorkflowTypesPagesWithContext(ctx aws.Context, input *ListWorkflowTypesInput, fn func(*ListWorkflowTypesOutput, bool) bool, opts ...request.Option) error

ListWorkflowTypesPagesWithContext same as ListWorkflowTypesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) ListWorkflowTypesRequest

func (c *SWF) ListWorkflowTypesRequest(input *ListWorkflowTypesInput) (req *request.Request, output *ListWorkflowTypesOutput)

ListWorkflowTypesRequest generates a "aws/request.Request" representing the client's request for the ListWorkflowTypes operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListWorkflowTypes for more information on using the ListWorkflowTypes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListWorkflowTypesRequest method.
req, resp := client.ListWorkflowTypesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) ListWorkflowTypesWithContext added in v1.8.0

func (c *SWF) ListWorkflowTypesWithContext(ctx aws.Context, input *ListWorkflowTypesInput, opts ...request.Option) (*ListWorkflowTypesOutput, error)

ListWorkflowTypesWithContext is the same as ListWorkflowTypes with the addition of the ability to pass a context and additional request options.

See ListWorkflowTypes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) PollForActivityTask

func (c *SWF) PollForActivityTask(input *PollForActivityTaskInput) (*PollForActivityTaskOutput, error)

PollForActivityTask API operation for Amazon Simple Workflow Service.

Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.

Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation PollForActivityTask for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

  • ErrCodeLimitExceededFault "LimitExceededFault" Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

func (*SWF) PollForActivityTaskRequest

func (c *SWF) PollForActivityTaskRequest(input *PollForActivityTaskInput) (req *request.Request, output *PollForActivityTaskOutput)

PollForActivityTaskRequest generates a "aws/request.Request" representing the client's request for the PollForActivityTask operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PollForActivityTask for more information on using the PollForActivityTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PollForActivityTaskRequest method.
req, resp := client.PollForActivityTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) PollForActivityTaskWithContext added in v1.8.0

func (c *SWF) PollForActivityTaskWithContext(ctx aws.Context, input *PollForActivityTaskInput, opts ...request.Option) (*PollForActivityTaskOutput, error)

PollForActivityTaskWithContext is the same as PollForActivityTask with the addition of the ability to pass a context and additional request options.

See PollForActivityTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) PollForDecisionTask

func (c *SWF) PollForDecisionTask(input *PollForDecisionTaskInput) (*PollForDecisionTaskOutput, error)

PollForDecisionTask API operation for Amazon Simple Workflow Service.

Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.

This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.

Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).

Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation PollForDecisionTask for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

  • ErrCodeLimitExceededFault "LimitExceededFault" Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

func (*SWF) PollForDecisionTaskPages

func (c *SWF) PollForDecisionTaskPages(input *PollForDecisionTaskInput, fn func(*PollForDecisionTaskOutput, bool) bool) error

PollForDecisionTaskPages iterates over the pages of a PollForDecisionTask operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See PollForDecisionTask method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a PollForDecisionTask operation.
pageNum := 0
err := client.PollForDecisionTaskPages(params,
    func(page *PollForDecisionTaskOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SWF) PollForDecisionTaskPagesWithContext added in v1.8.0

func (c *SWF) PollForDecisionTaskPagesWithContext(ctx aws.Context, input *PollForDecisionTaskInput, fn func(*PollForDecisionTaskOutput, bool) bool, opts ...request.Option) error

PollForDecisionTaskPagesWithContext same as PollForDecisionTaskPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) PollForDecisionTaskRequest

func (c *SWF) PollForDecisionTaskRequest(input *PollForDecisionTaskInput) (req *request.Request, output *PollForDecisionTaskOutput)

PollForDecisionTaskRequest generates a "aws/request.Request" representing the client's request for the PollForDecisionTask operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PollForDecisionTask for more information on using the PollForDecisionTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PollForDecisionTaskRequest method.
req, resp := client.PollForDecisionTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) PollForDecisionTaskWithContext added in v1.8.0

func (c *SWF) PollForDecisionTaskWithContext(ctx aws.Context, input *PollForDecisionTaskInput, opts ...request.Option) (*PollForDecisionTaskOutput, error)

PollForDecisionTaskWithContext is the same as PollForDecisionTask with the addition of the ability to pass a context and additional request options.

See PollForDecisionTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) RecordActivityTaskHeartbeat

func (c *SWF) RecordActivityTaskHeartbeat(input *RecordActivityTaskHeartbeatInput) (*RecordActivityTaskHeartbeatOutput, error)

RecordActivityTaskHeartbeat API operation for Amazon Simple Workflow Service.

Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true.

This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType.

This action doesn't in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history contains a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker.

The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType.

This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.

If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation RecordActivityTaskHeartbeat for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) RecordActivityTaskHeartbeatRequest

func (c *SWF) RecordActivityTaskHeartbeatRequest(input *RecordActivityTaskHeartbeatInput) (req *request.Request, output *RecordActivityTaskHeartbeatOutput)

RecordActivityTaskHeartbeatRequest generates a "aws/request.Request" representing the client's request for the RecordActivityTaskHeartbeat operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RecordActivityTaskHeartbeat for more information on using the RecordActivityTaskHeartbeat API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RecordActivityTaskHeartbeatRequest method.
req, resp := client.RecordActivityTaskHeartbeatRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) RecordActivityTaskHeartbeatWithContext added in v1.8.0

func (c *SWF) RecordActivityTaskHeartbeatWithContext(ctx aws.Context, input *RecordActivityTaskHeartbeatInput, opts ...request.Option) (*RecordActivityTaskHeartbeatOutput, error)

RecordActivityTaskHeartbeatWithContext is the same as RecordActivityTaskHeartbeat with the addition of the ability to pass a context and additional request options.

See RecordActivityTaskHeartbeat for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) RegisterActivityType

func (c *SWF) RegisterActivityType(input *RegisterActivityTypeInput) (*RegisterActivityTypeOutput, error)

RegisterActivityType API operation for Amazon Simple Workflow Service.

Registers a new activity type along with its configuration settings in the specified domain.

A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.

name: String constraint. The key is swf:name.

version: String constraint. The key is swf:version.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation RegisterActivityType for usage and error information.

Returned Error Codes:

  • ErrCodeTypeAlreadyExistsFault "TypeAlreadyExistsFault" Returned if the type already exists in the specified domain. You get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type.

  • ErrCodeLimitExceededFault "LimitExceededFault" Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) RegisterActivityTypeRequest

func (c *SWF) RegisterActivityTypeRequest(input *RegisterActivityTypeInput) (req *request.Request, output *RegisterActivityTypeOutput)

RegisterActivityTypeRequest generates a "aws/request.Request" representing the client's request for the RegisterActivityType operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterActivityType for more information on using the RegisterActivityType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RegisterActivityTypeRequest method.
req, resp := client.RegisterActivityTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) RegisterActivityTypeWithContext added in v1.8.0

func (c *SWF) RegisterActivityTypeWithContext(ctx aws.Context, input *RegisterActivityTypeInput, opts ...request.Option) (*RegisterActivityTypeOutput, error)

RegisterActivityTypeWithContext is the same as RegisterActivityType with the addition of the ability to pass a context and additional request options.

See RegisterActivityType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) RegisterDomain

func (c *SWF) RegisterDomain(input *RegisterDomainInput) (*RegisterDomainOutput, error)

RegisterDomain API operation for Amazon Simple Workflow Service.

Registers a new domain.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation RegisterDomain for usage and error information.

Returned Error Codes:

  • ErrCodeDomainAlreadyExistsFault "DomainAlreadyExistsFault" Returned if the specified domain already exists. You get this fault even if the existing domain is in deprecated status.

  • ErrCodeLimitExceededFault "LimitExceededFault" Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) RegisterDomainRequest

func (c *SWF) RegisterDomainRequest(input *RegisterDomainInput) (req *request.Request, output *RegisterDomainOutput)

RegisterDomainRequest generates a "aws/request.Request" representing the client's request for the RegisterDomain operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterDomain for more information on using the RegisterDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RegisterDomainRequest method.
req, resp := client.RegisterDomainRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) RegisterDomainWithContext added in v1.8.0

func (c *SWF) RegisterDomainWithContext(ctx aws.Context, input *RegisterDomainInput, opts ...request.Option) (*RegisterDomainOutput, error)

RegisterDomainWithContext is the same as RegisterDomain with the addition of the ability to pass a context and additional request options.

See RegisterDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) RegisterWorkflowType

func (c *SWF) RegisterWorkflowType(input *RegisterWorkflowTypeInput) (*RegisterWorkflowTypeOutput, error)

RegisterWorkflowType API operation for Amazon Simple Workflow Service.

Registers a new workflow type and its configuration settings in the specified domain.

The retention period for the workflow history is set by the RegisterDomain action.

If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.

name: String constraint. The key is swf:name.

version: String constraint. The key is swf:version.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation RegisterWorkflowType for usage and error information.

Returned Error Codes:

  • ErrCodeTypeAlreadyExistsFault "TypeAlreadyExistsFault" Returned if the type already exists in the specified domain. You get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type.

  • ErrCodeLimitExceededFault "LimitExceededFault" Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) RegisterWorkflowTypeRequest

func (c *SWF) RegisterWorkflowTypeRequest(input *RegisterWorkflowTypeInput) (req *request.Request, output *RegisterWorkflowTypeOutput)

RegisterWorkflowTypeRequest generates a "aws/request.Request" representing the client's request for the RegisterWorkflowType operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterWorkflowType for more information on using the RegisterWorkflowType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RegisterWorkflowTypeRequest method.
req, resp := client.RegisterWorkflowTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) RegisterWorkflowTypeWithContext added in v1.8.0

func (c *SWF) RegisterWorkflowTypeWithContext(ctx aws.Context, input *RegisterWorkflowTypeInput, opts ...request.Option) (*RegisterWorkflowTypeOutput, error)

RegisterWorkflowTypeWithContext is the same as RegisterWorkflowType with the addition of the ability to pass a context and additional request options.

See RegisterWorkflowType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) RequestCancelWorkflowExecution

func (c *SWF) RequestCancelWorkflowExecution(input *RequestCancelWorkflowExecutionInput) (*RequestCancelWorkflowExecutionOutput, error)

RequestCancelWorkflowExecution API operation for Amazon Simple Workflow Service.

Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.

If the runId isn't specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.

Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation RequestCancelWorkflowExecution for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) RequestCancelWorkflowExecutionRequest

func (c *SWF) RequestCancelWorkflowExecutionRequest(input *RequestCancelWorkflowExecutionInput) (req *request.Request, output *RequestCancelWorkflowExecutionOutput)

RequestCancelWorkflowExecutionRequest generates a "aws/request.Request" representing the client's request for the RequestCancelWorkflowExecution operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RequestCancelWorkflowExecution for more information on using the RequestCancelWorkflowExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RequestCancelWorkflowExecutionRequest method.
req, resp := client.RequestCancelWorkflowExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) RequestCancelWorkflowExecutionWithContext added in v1.8.0

func (c *SWF) RequestCancelWorkflowExecutionWithContext(ctx aws.Context, input *RequestCancelWorkflowExecutionInput, opts ...request.Option) (*RequestCancelWorkflowExecutionOutput, error)

RequestCancelWorkflowExecutionWithContext is the same as RequestCancelWorkflowExecution with the addition of the ability to pass a context and additional request options.

See RequestCancelWorkflowExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) RespondActivityTaskCanceled

func (c *SWF) RespondActivityTaskCanceled(input *RespondActivityTaskCanceledInput) (*RespondActivityTaskCanceledOutput, error)

RespondActivityTaskCanceled API operation for Amazon Simple Workflow Service.

Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be provided using the details argument.

These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.

Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types).

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation RespondActivityTaskCanceled for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) RespondActivityTaskCanceledRequest

func (c *SWF) RespondActivityTaskCanceledRequest(input *RespondActivityTaskCanceledInput) (req *request.Request, output *RespondActivityTaskCanceledOutput)

RespondActivityTaskCanceledRequest generates a "aws/request.Request" representing the client's request for the RespondActivityTaskCanceled operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RespondActivityTaskCanceled for more information on using the RespondActivityTaskCanceled API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RespondActivityTaskCanceledRequest method.
req, resp := client.RespondActivityTaskCanceledRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) RespondActivityTaskCanceledWithContext added in v1.8.0

func (c *SWF) RespondActivityTaskCanceledWithContext(ctx aws.Context, input *RespondActivityTaskCanceledInput, opts ...request.Option) (*RespondActivityTaskCanceledOutput, error)

RespondActivityTaskCanceledWithContext is the same as RespondActivityTaskCanceled with the addition of the ability to pass a context and additional request options.

See RespondActivityTaskCanceled for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) RespondActivityTaskCompleted

func (c *SWF) RespondActivityTaskCompleted(input *RespondActivityTaskCompletedInput) (*RespondActivityTaskCompletedOutput, error)

RespondActivityTaskCompleted API operation for Amazon Simple Workflow Service.

Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history.

If the requested task doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types).

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation RespondActivityTaskCompleted for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) RespondActivityTaskCompletedRequest

func (c *SWF) RespondActivityTaskCompletedRequest(input *RespondActivityTaskCompletedInput) (req *request.Request, output *RespondActivityTaskCompletedOutput)

RespondActivityTaskCompletedRequest generates a "aws/request.Request" representing the client's request for the RespondActivityTaskCompleted operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RespondActivityTaskCompleted for more information on using the RespondActivityTaskCompleted API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RespondActivityTaskCompletedRequest method.
req, resp := client.RespondActivityTaskCompletedRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) RespondActivityTaskCompletedWithContext added in v1.8.0

func (c *SWF) RespondActivityTaskCompletedWithContext(ctx aws.Context, input *RespondActivityTaskCompletedInput, opts ...request.Option) (*RespondActivityTaskCompletedOutput, error)

RespondActivityTaskCompletedWithContext is the same as RespondActivityTaskCompleted with the addition of the ability to pass a context and additional request options.

See RespondActivityTaskCompleted for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) RespondActivityTaskFailed

func (c *SWF) RespondActivityTaskFailed(input *RespondActivityTaskFailedInput) (*RespondActivityTaskFailedOutput, error)

RespondActivityTaskFailed API operation for Amazon Simple Workflow Service.

Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in the ActivityTaskFailed event added to the workflow history.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types).

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation RespondActivityTaskFailed for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) RespondActivityTaskFailedRequest

func (c *SWF) RespondActivityTaskFailedRequest(input *RespondActivityTaskFailedInput) (req *request.Request, output *RespondActivityTaskFailedOutput)

RespondActivityTaskFailedRequest generates a "aws/request.Request" representing the client's request for the RespondActivityTaskFailed operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RespondActivityTaskFailed for more information on using the RespondActivityTaskFailed API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RespondActivityTaskFailedRequest method.
req, resp := client.RespondActivityTaskFailedRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) RespondActivityTaskFailedWithContext added in v1.8.0

func (c *SWF) RespondActivityTaskFailedWithContext(ctx aws.Context, input *RespondActivityTaskFailedInput, opts ...request.Option) (*RespondActivityTaskFailedOutput, error)

RespondActivityTaskFailedWithContext is the same as RespondActivityTaskFailed with the addition of the ability to pass a context and additional request options.

See RespondActivityTaskFailed for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) RespondDecisionTaskCompleted

func (c *SWF) RespondDecisionTaskCompleted(input *RespondDecisionTaskCompletedInput) (*RespondDecisionTaskCompletedOutput, error)

RespondDecisionTaskCompleted API operation for Amazon Simple Workflow Service.

Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task.

A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is attached to the event in the workflow execution history.

Access Control

If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions for the list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation RespondDecisionTaskCompleted for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) RespondDecisionTaskCompletedRequest

func (c *SWF) RespondDecisionTaskCompletedRequest(input *RespondDecisionTaskCompletedInput) (req *request.Request, output *RespondDecisionTaskCompletedOutput)

RespondDecisionTaskCompletedRequest generates a "aws/request.Request" representing the client's request for the RespondDecisionTaskCompleted operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RespondDecisionTaskCompleted for more information on using the RespondDecisionTaskCompleted API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RespondDecisionTaskCompletedRequest method.
req, resp := client.RespondDecisionTaskCompletedRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) RespondDecisionTaskCompletedWithContext added in v1.8.0

func (c *SWF) RespondDecisionTaskCompletedWithContext(ctx aws.Context, input *RespondDecisionTaskCompletedInput, opts ...request.Option) (*RespondDecisionTaskCompletedOutput, error)

RespondDecisionTaskCompletedWithContext is the same as RespondDecisionTaskCompleted with the addition of the ability to pass a context and additional request options.

See RespondDecisionTaskCompleted for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) SignalWorkflowExecution

func (c *SWF) SignalWorkflowExecution(input *SignalWorkflowExecutionInput) (*SignalWorkflowExecutionOutput, error)

SignalWorkflowExecution API operation for Amazon Simple Workflow Service.

Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).

If a runId isn't specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain.

If the specified workflow execution isn't open, this method fails with UnknownResource.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation SignalWorkflowExecution for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) SignalWorkflowExecutionRequest

func (c *SWF) SignalWorkflowExecutionRequest(input *SignalWorkflowExecutionInput) (req *request.Request, output *SignalWorkflowExecutionOutput)

SignalWorkflowExecutionRequest generates a "aws/request.Request" representing the client's request for the SignalWorkflowExecution operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SignalWorkflowExecution for more information on using the SignalWorkflowExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SignalWorkflowExecutionRequest method.
req, resp := client.SignalWorkflowExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) SignalWorkflowExecutionWithContext added in v1.8.0

func (c *SWF) SignalWorkflowExecutionWithContext(ctx aws.Context, input *SignalWorkflowExecutionInput, opts ...request.Option) (*SignalWorkflowExecutionOutput, error)

SignalWorkflowExecutionWithContext is the same as SignalWorkflowExecution with the addition of the ability to pass a context and additional request options.

See SignalWorkflowExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) StartWorkflowExecution

func (c *SWF) StartWorkflowExecution(input *StartWorkflowExecutionInput) (*StartWorkflowExecutionOutput, error)

StartWorkflowExecution API operation for Amazon Simple Workflow Service.

Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.

This action returns the newly started workflow execution.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

tagList.member.0: The key is swf:tagList.member.0.

tagList.member.1: The key is swf:tagList.member.1.

tagList.member.2: The key is swf:tagList.member.2.

tagList.member.3: The key is swf:tagList.member.3.

tagList.member.4: The key is swf:tagList.member.4.

taskList: String constraint. The key is swf:taskList.name.

workflowType.name: String constraint. The key is swf:workflowType.name.

workflowType.version: String constraint. The key is swf:workflowType.version.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation StartWorkflowExecution for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeTypeDeprecatedFault "TypeDeprecatedFault" Returned when the specified activity or workflow type was already deprecated.

  • ErrCodeWorkflowExecutionAlreadyStartedFault "WorkflowExecutionAlreadyStartedFault" Returned by StartWorkflowExecution when an open execution with the same workflowId is already running in the specified domain.

  • ErrCodeLimitExceededFault "LimitExceededFault" Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

  • ErrCodeDefaultUndefinedFault "DefaultUndefinedFault" The StartWorkflowExecution API action was called without the required parameters set.

    Some workflow execution parameters, such as the decision taskList, must be set to start the execution. However, these parameters might have been set as defaults when the workflow type was registered. In this case, you can omit these parameters from the StartWorkflowExecution call and Amazon SWF uses the values defined in the workflow type.

    If these parameters aren't set and no default parameters were defined in the workflow type, this error is displayed.

func (*SWF) StartWorkflowExecutionRequest

func (c *SWF) StartWorkflowExecutionRequest(input *StartWorkflowExecutionInput) (req *request.Request, output *StartWorkflowExecutionOutput)

StartWorkflowExecutionRequest generates a "aws/request.Request" representing the client's request for the StartWorkflowExecution operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartWorkflowExecution for more information on using the StartWorkflowExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartWorkflowExecutionRequest method.
req, resp := client.StartWorkflowExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) StartWorkflowExecutionWithContext added in v1.8.0

func (c *SWF) StartWorkflowExecutionWithContext(ctx aws.Context, input *StartWorkflowExecutionInput, opts ...request.Option) (*StartWorkflowExecutionOutput, error)

StartWorkflowExecutionWithContext is the same as StartWorkflowExecution with the addition of the ability to pass a context and additional request options.

See StartWorkflowExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SWF) TerminateWorkflowExecution

func (c *SWF) TerminateWorkflowExecution(input *TerminateWorkflowExecutionInput) (*TerminateWorkflowExecutionOutput, error)

TerminateWorkflowExecution API operation for Amazon Simple Workflow Service.

Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.

If the identified workflow execution was in progress, it is terminated immediately.

If a runId isn't specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain.

You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Workflow Service's API operation TerminateWorkflowExecution for usage and error information.

Returned Error Codes:

  • ErrCodeUnknownResourceFault "UnknownResourceFault" Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

  • ErrCodeOperationNotPermittedFault "OperationNotPermittedFault" Returned when the caller doesn't have sufficient permissions to invoke the action.

func (*SWF) TerminateWorkflowExecutionRequest

func (c *SWF) TerminateWorkflowExecutionRequest(input *TerminateWorkflowExecutionInput) (req *request.Request, output *TerminateWorkflowExecutionOutput)

TerminateWorkflowExecutionRequest generates a "aws/request.Request" representing the client's request for the TerminateWorkflowExecution operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TerminateWorkflowExecution for more information on using the TerminateWorkflowExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TerminateWorkflowExecutionRequest method.
req, resp := client.TerminateWorkflowExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SWF) TerminateWorkflowExecutionWithContext added in v1.8.0

func (c *SWF) TerminateWorkflowExecutionWithContext(ctx aws.Context, input *TerminateWorkflowExecutionInput, opts ...request.Option) (*TerminateWorkflowExecutionOutput, error)

TerminateWorkflowExecutionWithContext is the same as TerminateWorkflowExecution with the addition of the ability to pass a context and additional request options.

See TerminateWorkflowExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ScheduleActivityTaskDecisionAttributes

type ScheduleActivityTaskDecisionAttributes struct {

	// The activityId of the activity task.
	//
	// The specified string must not start or end with whitespace. It must not contain
	// a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f
	// | \u007f-\u009f). Also, it must not contain the literal string arn.
	//
	// ActivityId is a required field
	ActivityId *string `locationName:"activityId" min:"1" type:"string" required:"true"`

	// The type of the activity task to schedule.
	//
	// ActivityType is a required field
	ActivityType *ActivityType `locationName:"activityType" type:"structure" required:"true"`

	// Data attached to the event that can be used by the decider in subsequent
	// workflow tasks. This data isn't sent to the activity.
	Control *string `locationName:"control" type:"string"`

	// If set, specifies the maximum time before which a worker processing a task
	// of this type must report progress by calling RecordActivityTaskHeartbeat.
	// If the timeout is exceeded, the activity task is automatically timed out.
	// If the worker subsequently attempts to record a heartbeat or returns a result,
	// it is ignored. This overrides the default heartbeat timeout specified when
	// registering the activity type using RegisterActivityType.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	HeartbeatTimeout *string `locationName:"heartbeatTimeout" type:"string"`

	// The input provided to the activity task.
	Input *string `locationName:"input" type:"string"`

	// The maximum duration for this activity task.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	//
	// A schedule-to-close timeout for this activity task must be specified either
	// as a default for the activity type or through this field. If neither this
	// field is set nor a default schedule-to-close timeout was specified at registration
	// time then a fault is returned.
	ScheduleToCloseTimeout *string `locationName:"scheduleToCloseTimeout" type:"string"`

	// If set, specifies the maximum duration the activity task can wait to be assigned
	// to a worker. This overrides the default schedule-to-start timeout specified
	// when registering the activity type using RegisterActivityType.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	//
	// A schedule-to-start timeout for this activity task must be specified either
	// as a default for the activity type or through this field. If neither this
	// field is set nor a default schedule-to-start timeout was specified at registration
	// time then a fault is returned.
	ScheduleToStartTimeout *string `locationName:"scheduleToStartTimeout" type:"string"`

	// If set, specifies the maximum duration a worker may take to process this
	// activity task. This overrides the default start-to-close timeout specified
	// when registering the activity type using RegisterActivityType.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	//
	// A start-to-close timeout for this activity task must be specified either
	// as a default for the activity type or through this field. If neither this
	// field is set nor a default start-to-close timeout was specified at registration
	// time then a fault is returned.
	StartToCloseTimeout *string `locationName:"startToCloseTimeout" type:"string"`

	// If set, specifies the name of the task list in which to schedule the activity
	// task. If not specified, the defaultTaskList registered with the activity
	// type is used.
	//
	// A task list for this activity task must be specified either as a default
	// for the activity type or through this field. If neither this field is set
	// nor a default task list was specified at registration time then a fault is
	// returned.
	//
	// The specified string must not start or end with whitespace. It must not contain
	// a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f
	// | \u007f-\u009f). Also, it must not contain the literal string arn.
	TaskList *TaskList `locationName:"taskList" type:"structure"`

	// If set, specifies the priority with which the activity task is to be assigned
	// to a worker. This overrides the defaultTaskPriority specified when registering
	// the activity type using RegisterActivityType. Valid values are integers that
	// range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647).
	// Higher numbers indicate higher priority.
	//
	// For more information about setting task priority, see Setting Task Priority
	// (http://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html)
	// in the Amazon SWF Developer Guide.
	TaskPriority *string `locationName:"taskPriority" type:"string"`
	// contains filtered or unexported fields
}

Provides the details of the ScheduleActivityTask decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

activityType.name – String constraint. The key is swf:activityType.name.

activityType.version – String constraint. The key is swf:activityType.version.

taskList – String constraint. The key is swf:taskList.name.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

func (ScheduleActivityTaskDecisionAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ScheduleActivityTaskDecisionAttributes) SetActivityId added in v1.5.0

SetActivityId sets the ActivityId field's value.

func (*ScheduleActivityTaskDecisionAttributes) SetActivityType added in v1.5.0

SetActivityType sets the ActivityType field's value.

func (*ScheduleActivityTaskDecisionAttributes) SetControl added in v1.5.0

SetControl sets the Control field's value.

func (*ScheduleActivityTaskDecisionAttributes) SetHeartbeatTimeout added in v1.5.0

SetHeartbeatTimeout sets the HeartbeatTimeout field's value.

func (*ScheduleActivityTaskDecisionAttributes) SetInput added in v1.5.0

SetInput sets the Input field's value.

func (*ScheduleActivityTaskDecisionAttributes) SetScheduleToCloseTimeout added in v1.5.0

SetScheduleToCloseTimeout sets the ScheduleToCloseTimeout field's value.

func (*ScheduleActivityTaskDecisionAttributes) SetScheduleToStartTimeout added in v1.5.0

SetScheduleToStartTimeout sets the ScheduleToStartTimeout field's value.

func (*ScheduleActivityTaskDecisionAttributes) SetStartToCloseTimeout added in v1.5.0

SetStartToCloseTimeout sets the StartToCloseTimeout field's value.

func (*ScheduleActivityTaskDecisionAttributes) SetTaskList added in v1.5.0

SetTaskList sets the TaskList field's value.

func (*ScheduleActivityTaskDecisionAttributes) SetTaskPriority added in v1.5.0

SetTaskPriority sets the TaskPriority field's value.

func (ScheduleActivityTaskDecisionAttributes) String added in v0.6.5

String returns the string representation

func (*ScheduleActivityTaskDecisionAttributes) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type ScheduleActivityTaskFailedEventAttributes

type ScheduleActivityTaskFailedEventAttributes struct {

	// The activityId provided in the ScheduleActivityTask decision that failed.
	//
	// ActivityId is a required field
	ActivityId *string `locationName:"activityId" min:"1" type:"string" required:"true"`

	// The activity type provided in the ScheduleActivityTask decision that failed.
	//
	// ActivityType is a required field
	ActivityType *ActivityType `locationName:"activityType" type:"structure" required:"true"`

	// The cause of the failure. This information is generated by the system and
	// can be useful for diagnostic purposes.
	//
	// 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 (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html)
	// in the Amazon SWF Developer Guide.
	//
	// Cause is a required field
	Cause *string `locationName:"cause" type:"string" required:"true" enum:"ScheduleActivityTaskFailedCause"`

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the ScheduleActivityTaskFailed event.

func (ScheduleActivityTaskFailedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*ScheduleActivityTaskFailedEventAttributes) SetActivityId added in v1.5.0

SetActivityId sets the ActivityId field's value.

func (*ScheduleActivityTaskFailedEventAttributes) SetActivityType added in v1.5.0

SetActivityType sets the ActivityType field's value.

func (*ScheduleActivityTaskFailedEventAttributes) SetCause added in v1.5.0

SetCause sets the Cause field's value.

func (*ScheduleActivityTaskFailedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (ScheduleActivityTaskFailedEventAttributes) String added in v0.6.5

String returns the string representation

type ScheduleLambdaFunctionDecisionAttributes added in v0.7.3

type ScheduleLambdaFunctionDecisionAttributes struct {

	// The data attached to the event that the decider can use in subsequent workflow
	// tasks. This data isn't sent to the Lambda task.
	Control *string `locationName:"control" type:"string"`

	// A string that identifies the Lambda function execution in the event history.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"1" type:"string" required:"true"`

	// The optional input data to be supplied to the Lambda function.
	Input *string `locationName:"input" type:"string"`

	// The name, or ARN, of the Lambda function to schedule.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The timeout value, in seconds, after which the Lambda function is considered
	// to be failed once it has started. This can be any integer from 1-300 (1s-5m).
	// If no value is supplied, than a default value of 300s is assumed.
	StartToCloseTimeout *string `locationName:"startToCloseTimeout" type:"string"`
	// contains filtered or unexported fields
}

Decision attributes specified in scheduleLambdaFunctionDecisionAttributes within the list of decisions decisions passed to RespondDecisionTaskCompleted.

func (ScheduleLambdaFunctionDecisionAttributes) GoString added in v0.7.3

GoString returns the string representation

func (*ScheduleLambdaFunctionDecisionAttributes) SetControl added in v1.10.9

SetControl sets the Control field's value.

func (*ScheduleLambdaFunctionDecisionAttributes) SetId added in v1.5.0

SetId sets the Id field's value.

func (*ScheduleLambdaFunctionDecisionAttributes) SetInput added in v1.5.0

SetInput sets the Input field's value.

func (*ScheduleLambdaFunctionDecisionAttributes) SetName added in v1.5.0

SetName sets the Name field's value.

func (*ScheduleLambdaFunctionDecisionAttributes) SetStartToCloseTimeout added in v1.5.0

SetStartToCloseTimeout sets the StartToCloseTimeout field's value.

func (ScheduleLambdaFunctionDecisionAttributes) String added in v0.7.3

String returns the string representation

func (*ScheduleLambdaFunctionDecisionAttributes) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type ScheduleLambdaFunctionFailedEventAttributes added in v0.7.3

type ScheduleLambdaFunctionFailedEventAttributes struct {

	// The cause of the failure. To help diagnose issues, use this information to
	// trace back the chain of events leading up to this event.
	//
	// 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 (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html)
	// in the Amazon SWF Developer Guide.
	//
	// Cause is a required field
	Cause *string `locationName:"cause" type:"string" required:"true" enum:"ScheduleLambdaFunctionFailedCause"`

	// The ID of the LambdaFunctionCompleted event corresponding to the decision
	// that resulted in scheduling this Lambda task. To help diagnose issues, use
	// this information to trace back the chain of events leading up to this event.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// The ID provided in the ScheduleLambdaFunction decision that failed.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"1" type:"string" required:"true"`

	// The name of the Lambda function.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set for other event types.

func (ScheduleLambdaFunctionFailedEventAttributes) GoString added in v0.7.3

GoString returns the string representation

func (*ScheduleLambdaFunctionFailedEventAttributes) SetCause added in v1.5.0

SetCause sets the Cause field's value.

func (*ScheduleLambdaFunctionFailedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*ScheduleLambdaFunctionFailedEventAttributes) SetId added in v1.5.0

SetId sets the Id field's value.

func (*ScheduleLambdaFunctionFailedEventAttributes) SetName added in v1.5.0

SetName sets the Name field's value.

func (ScheduleLambdaFunctionFailedEventAttributes) String added in v0.7.3

String returns the string representation

type SignalExternalWorkflowExecutionDecisionAttributes

type SignalExternalWorkflowExecutionDecisionAttributes struct {

	// The data attached to the event that can be used by the decider in subsequent
	// decision tasks.
	Control *string `locationName:"control" type:"string"`

	// The input data to be provided with the signal. The target workflow execution
	// uses the signal name and input data to process the signal.
	Input *string `locationName:"input" type:"string"`

	// The runId of the workflow execution to be signaled.
	RunId *string `locationName:"runId" type:"string"`

	// The name of the signal.The target workflow execution uses the signal name
	// and input to process the signal.
	//
	// SignalName is a required field
	SignalName *string `locationName:"signalName" min:"1" type:"string" required:"true"`

	// The workflowId of the workflow execution to be signaled.
	//
	// WorkflowId is a required field
	WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the SignalExternalWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

func (SignalExternalWorkflowExecutionDecisionAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*SignalExternalWorkflowExecutionDecisionAttributes) SetControl added in v1.5.0

SetControl sets the Control field's value.

func (*SignalExternalWorkflowExecutionDecisionAttributes) SetInput added in v1.5.0

SetInput sets the Input field's value.

func (*SignalExternalWorkflowExecutionDecisionAttributes) SetRunId added in v1.5.0

SetRunId sets the RunId field's value.

func (*SignalExternalWorkflowExecutionDecisionAttributes) SetSignalName added in v1.5.0

SetSignalName sets the SignalName field's value.

func (*SignalExternalWorkflowExecutionDecisionAttributes) SetWorkflowId added in v1.5.0

SetWorkflowId sets the WorkflowId field's value.

func (SignalExternalWorkflowExecutionDecisionAttributes) String added in v0.6.5

String returns the string representation

func (*SignalExternalWorkflowExecutionDecisionAttributes) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type SignalExternalWorkflowExecutionFailedEventAttributes

type SignalExternalWorkflowExecutionFailedEventAttributes struct {

	// The cause of the failure. This information is generated by the system and
	// can be useful for diagnostic purposes.
	//
	// 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 (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html)
	// in the Amazon SWF Developer Guide.
	//
	// Cause is a required field
	Cause *string `locationName:"cause" type:"string" required:"true" enum:"SignalExternalWorkflowExecutionFailedCause"`

	// The data attached to the event that the decider can use in subsequent workflow
	// tasks. This data isn't sent to the workflow execution.
	Control *string `locationName:"control" type:"string"`

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// 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.
	//
	// InitiatedEventId is a required field
	InitiatedEventId *int64 `locationName:"initiatedEventId" type:"long" required:"true"`

	// The runId of the external workflow execution that the signal was being delivered
	// to.
	RunId *string `locationName:"runId" type:"string"`

	// The workflowId of the external workflow execution that the signal was being
	// delivered to.
	//
	// WorkflowId is a required field
	WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the SignalExternalWorkflowExecutionFailed event.

func (SignalExternalWorkflowExecutionFailedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*SignalExternalWorkflowExecutionFailedEventAttributes) SetCause added in v1.5.0

SetCause sets the Cause field's value.

func (*SignalExternalWorkflowExecutionFailedEventAttributes) SetControl added in v1.5.0

SetControl sets the Control field's value.

func (*SignalExternalWorkflowExecutionFailedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*SignalExternalWorkflowExecutionFailedEventAttributes) SetInitiatedEventId added in v1.5.0

SetInitiatedEventId sets the InitiatedEventId field's value.

func (*SignalExternalWorkflowExecutionFailedEventAttributes) SetRunId added in v1.5.0

SetRunId sets the RunId field's value.

func (*SignalExternalWorkflowExecutionFailedEventAttributes) SetWorkflowId added in v1.5.0

SetWorkflowId sets the WorkflowId field's value.

func (SignalExternalWorkflowExecutionFailedEventAttributes) String added in v0.6.5

String returns the string representation

type SignalExternalWorkflowExecutionInitiatedEventAttributes

type SignalExternalWorkflowExecutionInitiatedEventAttributes struct {

	// Data attached to the event that can be used by the decider in subsequent
	// decision tasks.
	Control *string `locationName:"control" type:"string"`

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// The input provided to the signal.
	Input *string `locationName:"input" type:"string"`

	// The runId of the external workflow execution to send the signal to.
	RunId *string `locationName:"runId" type:"string"`

	// The name of the signal.
	//
	// SignalName is a required field
	SignalName *string `locationName:"signalName" min:"1" type:"string" required:"true"`

	// The workflowId of the external workflow execution.
	//
	// WorkflowId is a required field
	WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the SignalExternalWorkflowExecutionInitiated event.

func (SignalExternalWorkflowExecutionInitiatedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*SignalExternalWorkflowExecutionInitiatedEventAttributes) SetControl added in v1.5.0

SetControl sets the Control field's value.

func (*SignalExternalWorkflowExecutionInitiatedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*SignalExternalWorkflowExecutionInitiatedEventAttributes) SetInput added in v1.5.0

SetInput sets the Input field's value.

func (*SignalExternalWorkflowExecutionInitiatedEventAttributes) SetRunId added in v1.5.0

SetRunId sets the RunId field's value.

func (*SignalExternalWorkflowExecutionInitiatedEventAttributes) SetSignalName added in v1.5.0

SetSignalName sets the SignalName field's value.

func (*SignalExternalWorkflowExecutionInitiatedEventAttributes) SetWorkflowId added in v1.5.0

SetWorkflowId sets the WorkflowId field's value.

func (SignalExternalWorkflowExecutionInitiatedEventAttributes) String added in v0.6.5

String returns the string representation

type SignalWorkflowExecutionInput

type SignalWorkflowExecutionInput struct {

	// The name of the domain containing the workflow execution to signal.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// Data to attach to the WorkflowExecutionSignaled event in the target workflow
	// execution's history.
	Input *string `locationName:"input" type:"string"`

	// The runId of the workflow execution to signal.
	RunId *string `locationName:"runId" type:"string"`

	// The name of the signal. This name must be meaningful to the target workflow.
	//
	// SignalName is a required field
	SignalName *string `locationName:"signalName" min:"1" type:"string" required:"true"`

	// The workflowId of the workflow execution to signal.
	//
	// WorkflowId is a required field
	WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SignalWorkflowExecutionInput) GoString added in v0.6.5

func (s SignalWorkflowExecutionInput) GoString() string

GoString returns the string representation

func (*SignalWorkflowExecutionInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*SignalWorkflowExecutionInput) SetInput added in v1.5.0

SetInput sets the Input field's value.

func (*SignalWorkflowExecutionInput) SetRunId added in v1.5.0

SetRunId sets the RunId field's value.

func (*SignalWorkflowExecutionInput) SetSignalName added in v1.5.0

SetSignalName sets the SignalName field's value.

func (*SignalWorkflowExecutionInput) SetWorkflowId added in v1.5.0

SetWorkflowId sets the WorkflowId field's value.

func (SignalWorkflowExecutionInput) String added in v0.6.5

String returns the string representation

func (*SignalWorkflowExecutionInput) Validate added in v1.1.21

func (s *SignalWorkflowExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SignalWorkflowExecutionOutput

type SignalWorkflowExecutionOutput struct {
	// contains filtered or unexported fields
}

func (SignalWorkflowExecutionOutput) GoString added in v0.6.5

GoString returns the string representation

func (SignalWorkflowExecutionOutput) String added in v0.6.5

String returns the string representation

type StartChildWorkflowExecutionDecisionAttributes

type StartChildWorkflowExecutionDecisionAttributes struct {

	// If set, specifies the policy to use for the child workflow executions if
	// the workflow execution being started is terminated by calling the TerminateWorkflowExecution
	// action explicitly or due to an expired timeout. This policy overrides the
	// default child policy specified when registering the workflow type using RegisterWorkflowType.
	//
	// The supported child policies are:
	//
	//    * TERMINATE – The child executions are terminated.
	//
	//    * REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.
	//
	// A child policy for this workflow execution must be specified either as a
	// default for the workflow type or through this parameter. If neither this
	// parameter is set nor a default child policy was specified at registration
	// time then a fault is returned.
	ChildPolicy *string `locationName:"childPolicy" type:"string" enum:"ChildPolicy"`

	// The data attached to the event that can be used by the decider in subsequent
	// workflow tasks. This data isn't sent to the child workflow execution.
	Control *string `locationName:"control" type:"string"`

	// The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout
	// specified when registering the workflow type.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	//
	// An execution start-to-close timeout for this workflow execution must be specified
	// either as a default for the workflow type or through this parameter. If neither
	// this parameter is set nor a default execution start-to-close timeout was
	// specified at registration time then a fault is returned.
	ExecutionStartToCloseTimeout *string `locationName:"executionStartToCloseTimeout" type:"string"`

	// The input to be provided to the workflow execution.
	Input *string `locationName:"input" type:"string"`

	// The IAM role attached to the child workflow execution.
	LambdaRole *string `locationName:"lambdaRole" min:"1" type:"string"`

	// The list of tags to associate with the child workflow execution. A maximum
	// of 5 tags can be specified. You can list workflow executions with a specific
	// tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions
	// and specifying a TagFilter.
	TagList []*string `locationName:"tagList" type:"list"`

	// The name of the task list to be used for decision tasks of the child workflow
	// execution.
	//
	// A task list for this workflow execution must be specified either as a default
	// for the workflow type or through this parameter. If neither this parameter
	// is set nor a default task list was specified at registration time then a
	// fault is returned.
	//
	// The specified string must not start or end with whitespace. It must not contain
	// a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f
	// | \u007f-\u009f). Also, it must not contain the literal string arn.
	TaskList *TaskList `locationName:"taskList" type:"structure"`

	// A task priority that, if set, specifies the priority for a decision task
	// of this workflow execution. This overrides the defaultTaskPriority specified
	// when registering the workflow type. Valid values are integers that range
	// from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647).
	// Higher numbers indicate higher priority.
	//
	// For more information about setting task priority, see Setting Task Priority
	// (http://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html)
	// in the Amazon SWF Developer Guide.
	TaskPriority *string `locationName:"taskPriority" type:"string"`

	// Specifies the maximum duration of decision tasks for this workflow execution.
	// This parameter overrides the defaultTaskStartToCloseTimout specified when
	// registering the workflow type using RegisterWorkflowType.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	//
	// A task start-to-close timeout for this workflow execution must be specified
	// either as a default for the workflow type or through this parameter. If neither
	// this parameter is set nor a default task start-to-close timeout was specified
	// at registration time then a fault is returned.
	TaskStartToCloseTimeout *string `locationName:"taskStartToCloseTimeout" type:"string"`

	// The workflowId of the workflow execution.
	//
	// The specified string must not start or end with whitespace. It must not contain
	// a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f
	// | \u007f-\u009f). Also, it must not contain the literal string arn.
	//
	// WorkflowId is a required field
	WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`

	// The type of the workflow execution to be started.
	//
	// WorkflowType is a required field
	WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the StartChildWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

tagList.member.N – The key is "swf:tagList.N" where N is the tag number from

0 to 4, inclusive.

taskList – String constraint. The key is swf:taskList.name.

workflowType.name – String constraint. The key is swf:workflowType.name.

workflowType.version – String constraint. The key is swf:workflowType.version.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

func (StartChildWorkflowExecutionDecisionAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*StartChildWorkflowExecutionDecisionAttributes) SetChildPolicy added in v1.5.0

SetChildPolicy sets the ChildPolicy field's value.

func (*StartChildWorkflowExecutionDecisionAttributes) SetControl added in v1.5.0

SetControl sets the Control field's value.

func (*StartChildWorkflowExecutionDecisionAttributes) SetExecutionStartToCloseTimeout added in v1.5.0

SetExecutionStartToCloseTimeout sets the ExecutionStartToCloseTimeout field's value.

func (*StartChildWorkflowExecutionDecisionAttributes) SetInput added in v1.5.0

SetInput sets the Input field's value.

func (*StartChildWorkflowExecutionDecisionAttributes) SetLambdaRole added in v1.5.0

SetLambdaRole sets the LambdaRole field's value.

func (*StartChildWorkflowExecutionDecisionAttributes) SetTagList added in v1.5.0

SetTagList sets the TagList field's value.

func (*StartChildWorkflowExecutionDecisionAttributes) SetTaskList added in v1.5.0

SetTaskList sets the TaskList field's value.

func (*StartChildWorkflowExecutionDecisionAttributes) SetTaskPriority added in v1.5.0

SetTaskPriority sets the TaskPriority field's value.

func (*StartChildWorkflowExecutionDecisionAttributes) SetTaskStartToCloseTimeout added in v1.5.0

SetTaskStartToCloseTimeout sets the TaskStartToCloseTimeout field's value.

func (*StartChildWorkflowExecutionDecisionAttributes) SetWorkflowId added in v1.5.0

SetWorkflowId sets the WorkflowId field's value.

func (*StartChildWorkflowExecutionDecisionAttributes) SetWorkflowType added in v1.5.0

SetWorkflowType sets the WorkflowType field's value.

func (StartChildWorkflowExecutionDecisionAttributes) String added in v0.6.5

String returns the string representation

func (*StartChildWorkflowExecutionDecisionAttributes) Validate added in v1.1.21

Validate inspects the fields of the type to determine if they are valid.

type StartChildWorkflowExecutionFailedEventAttributes

type StartChildWorkflowExecutionFailedEventAttributes struct {

	// The cause of the failure. This information is generated by the system and
	// can be useful for diagnostic purposes.
	//
	// When cause is set to OPERATION_NOT_PERMITTED, the decision fails because
	// it lacks sufficient permissions. For details and example IAM policies, see
	//  Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html)
	// in the Amazon SWF Developer Guide.
	//
	// Cause is a required field
	Cause *string `locationName:"cause" type:"string" required:"true" enum:"StartChildWorkflowExecutionFailedCause"`

	// The data attached to the event that the decider can use in subsequent workflow
	// tasks. This data isn't sent to the child workflow execution.
	Control *string `locationName:"control" type:"string"`

	// The ID of the DecisionTaskCompleted event corresponding to the decision task
	// that resulted in the StartChildWorkflowExecutionDecision to request this
	// child workflow execution. This information can be useful for diagnosing problems
	// by tracing back the chain of events.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is the ID of
	// the StartChildWorkflowExecutionInitiated event that corresponds to the StartChildWorkflowExecutionDecision
	// to start the workflow execution. You can use this information to diagnose
	// problems by tracing back the chain of events leading up to this event.
	//
	// When the cause isn't WORKFLOW_ALREADY_RUNNING, initiatedEventId is set to
	// 0 because the StartChildWorkflowExecutionInitiated event doesn't exist.
	//
	// InitiatedEventId is a required field
	InitiatedEventId *int64 `locationName:"initiatedEventId" type:"long" required:"true"`

	// The workflowId of the child workflow execution.
	//
	// WorkflowId is a required field
	WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`

	// The workflow type provided in the StartChildWorkflowExecutionDecision that
	// failed.
	//
	// WorkflowType is a required field
	WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the StartChildWorkflowExecutionFailed event.

func (StartChildWorkflowExecutionFailedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*StartChildWorkflowExecutionFailedEventAttributes) SetCause added in v1.5.0

SetCause sets the Cause field's value.

func (*StartChildWorkflowExecutionFailedEventAttributes) SetControl added in v1.5.0

SetControl sets the Control field's value.

func (*StartChildWorkflowExecutionFailedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*StartChildWorkflowExecutionFailedEventAttributes) SetInitiatedEventId added in v1.5.0

SetInitiatedEventId sets the InitiatedEventId field's value.

func (*StartChildWorkflowExecutionFailedEventAttributes) SetWorkflowId added in v1.5.0

SetWorkflowId sets the WorkflowId field's value.

func (*StartChildWorkflowExecutionFailedEventAttributes) SetWorkflowType added in v1.5.0

SetWorkflowType sets the WorkflowType field's value.

func (StartChildWorkflowExecutionFailedEventAttributes) String added in v0.6.5

String returns the string representation

type StartChildWorkflowExecutionInitiatedEventAttributes

type StartChildWorkflowExecutionInitiatedEventAttributes struct {

	// The policy to use for the child workflow executions if this execution gets
	// terminated by explicitly calling the TerminateWorkflowExecution action or
	// due to an expired timeout.
	//
	// The supported child policies are:
	//
	//    * TERMINATE – The child executions are terminated.
	//
	//    * REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.
	//
	// ChildPolicy is a required field
	ChildPolicy *string `locationName:"childPolicy" type:"string" required:"true" enum:"ChildPolicy"`

	// Data attached to the event that can be used by the decider in subsequent
	// decision tasks. This data isn't sent to the activity.
	Control *string `locationName:"control" type:"string"`

	// The ID of the DecisionTaskCompleted event corresponding to the decision task
	// that resulted in the StartChildWorkflowExecutionDecision to request this
	// child workflow execution. This information can be useful for diagnosing problems
	// by tracing back the cause of events.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// The maximum duration for the child workflow execution. If the workflow execution
	// isn't closed within this duration, it is timed out and force-terminated.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	ExecutionStartToCloseTimeout *string `locationName:"executionStartToCloseTimeout" type:"string"`

	// The inputs provided to the child workflow execution.
	Input *string `locationName:"input" type:"string"`

	// The IAM role to attach to the child workflow execution.
	LambdaRole *string `locationName:"lambdaRole" min:"1" type:"string"`

	// The list of tags to associated with the child workflow execution.
	TagList []*string `locationName:"tagList" type:"list"`

	// The name of the task list used for the decision tasks of the child workflow
	// execution.
	//
	// TaskList is a required field
	TaskList *TaskList `locationName:"taskList" type:"structure" required:"true"`

	// 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 (2147483647). Higher numbers indicate higher priority.
	//
	// For more information about setting task priority, see Setting Task Priority
	// (http://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html)
	// in the Amazon SWF Developer Guide.
	TaskPriority *string `locationName:"taskPriority" type:"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. You can use NONE to specify unlimited duration.
	TaskStartToCloseTimeout *string `locationName:"taskStartToCloseTimeout" type:"string"`

	// The workflowId of the child workflow execution.
	//
	// WorkflowId is a required field
	WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`

	// The type of the child workflow execution.
	//
	// WorkflowType is a required field
	WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the StartChildWorkflowExecutionInitiated event.

func (StartChildWorkflowExecutionInitiatedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*StartChildWorkflowExecutionInitiatedEventAttributes) SetChildPolicy added in v1.5.0

SetChildPolicy sets the ChildPolicy field's value.

func (*StartChildWorkflowExecutionInitiatedEventAttributes) SetControl added in v1.5.0

SetControl sets the Control field's value.

func (*StartChildWorkflowExecutionInitiatedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*StartChildWorkflowExecutionInitiatedEventAttributes) SetExecutionStartToCloseTimeout added in v1.5.0

SetExecutionStartToCloseTimeout sets the ExecutionStartToCloseTimeout field's value.

func (*StartChildWorkflowExecutionInitiatedEventAttributes) SetInput added in v1.5.0

SetInput sets the Input field's value.

func (*StartChildWorkflowExecutionInitiatedEventAttributes) SetLambdaRole added in v1.5.0

SetLambdaRole sets the LambdaRole field's value.

func (*StartChildWorkflowExecutionInitiatedEventAttributes) SetTagList added in v1.5.0

SetTagList sets the TagList field's value.

func (*StartChildWorkflowExecutionInitiatedEventAttributes) SetTaskList added in v1.5.0

SetTaskList sets the TaskList field's value.

func (*StartChildWorkflowExecutionInitiatedEventAttributes) SetTaskPriority added in v1.5.0

SetTaskPriority sets the TaskPriority field's value.

func (*StartChildWorkflowExecutionInitiatedEventAttributes) SetTaskStartToCloseTimeout added in v1.5.0

SetTaskStartToCloseTimeout sets the TaskStartToCloseTimeout field's value.

func (*StartChildWorkflowExecutionInitiatedEventAttributes) SetWorkflowId added in v1.5.0

SetWorkflowId sets the WorkflowId field's value.

func (*StartChildWorkflowExecutionInitiatedEventAttributes) SetWorkflowType added in v1.5.0

SetWorkflowType sets the WorkflowType field's value.

func (StartChildWorkflowExecutionInitiatedEventAttributes) String added in v0.6.5

String returns the string representation

type StartLambdaFunctionFailedEventAttributes added in v0.7.3

type StartLambdaFunctionFailedEventAttributes struct {

	// The cause of the failure. To help diagnose issues, use this information to
	// trace back the chain of events leading up to this event.
	//
	// If cause is set to OPERATION_NOT_PERMITTED, the decision failed because the
	// IAM role attached to the execution lacked sufficient permissions. For details
	// and example IAM policies, see Lambda Tasks (http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html)
	// in the Amazon SWF Developer Guide.
	Cause *string `locationName:"cause" type:"string" enum:"StartLambdaFunctionFailedCause"`

	// A description that can help diagnose the cause of the fault.
	Message *string `locationName:"message" type:"string"`

	// The ID of the ActivityTaskScheduled event that was recorded when this activity
	// task was scheduled. To help diagnose issues, use this information to trace
	// back the chain of events leading up to this event.
	ScheduledEventId *int64 `locationName:"scheduledEventId" type:"long"`
	// contains filtered or unexported fields
}

Provides the details of the StartLambdaFunctionFailed event. It isn't set for other event types.

func (StartLambdaFunctionFailedEventAttributes) GoString added in v0.7.3

GoString returns the string representation

func (*StartLambdaFunctionFailedEventAttributes) SetCause added in v1.5.0

SetCause sets the Cause field's value.

func (*StartLambdaFunctionFailedEventAttributes) SetMessage added in v1.5.0

SetMessage sets the Message field's value.

func (*StartLambdaFunctionFailedEventAttributes) SetScheduledEventId added in v1.5.0

SetScheduledEventId sets the ScheduledEventId field's value.

func (StartLambdaFunctionFailedEventAttributes) String added in v0.7.3

String returns the string representation

type StartTimerDecisionAttributes

type StartTimerDecisionAttributes struct {

	// The data attached to the event that can be used by the decider in subsequent
	// workflow tasks.
	Control *string `locationName:"control" type:"string"`

	// The duration to wait before firing the timer.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0.
	//
	// StartToFireTimeout is a required field
	StartToFireTimeout *string `locationName:"startToFireTimeout" min:"1" type:"string" required:"true"`

	// The unique ID of the timer.
	//
	// The specified string must not start or end with whitespace. It must not contain
	// a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f
	// | \u007f-\u009f). Also, it must not contain the literal string arn.
	//
	// TimerId is a required field
	TimerId *string `locationName:"timerId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the StartTimer decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) in the Amazon SWF Developer Guide.

func (StartTimerDecisionAttributes) GoString added in v0.6.5

func (s StartTimerDecisionAttributes) GoString() string

GoString returns the string representation

func (*StartTimerDecisionAttributes) SetControl added in v1.5.0

SetControl sets the Control field's value.

func (*StartTimerDecisionAttributes) SetStartToFireTimeout added in v1.5.0

SetStartToFireTimeout sets the StartToFireTimeout field's value.

func (*StartTimerDecisionAttributes) SetTimerId added in v1.5.0

SetTimerId sets the TimerId field's value.

func (StartTimerDecisionAttributes) String added in v0.6.5

String returns the string representation

func (*StartTimerDecisionAttributes) Validate added in v1.1.21

func (s *StartTimerDecisionAttributes) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartTimerFailedEventAttributes

type StartTimerFailedEventAttributes struct {

	// The cause of the failure. This information is generated by the system and
	// can be useful for diagnostic purposes.
	//
	// 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 (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html)
	// in the Amazon SWF Developer Guide.
	//
	// Cause is a required field
	Cause *string `locationName:"cause" type:"string" required:"true" enum:"StartTimerFailedCause"`

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// The timerId provided in the StartTimer decision that failed.
	//
	// TimerId is a required field
	TimerId *string `locationName:"timerId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the StartTimerFailed event.

func (StartTimerFailedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*StartTimerFailedEventAttributes) SetCause added in v1.5.0

SetCause sets the Cause field's value.

func (*StartTimerFailedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

func (s *StartTimerFailedEventAttributes) SetDecisionTaskCompletedEventId(v int64) *StartTimerFailedEventAttributes

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*StartTimerFailedEventAttributes) SetTimerId added in v1.5.0

SetTimerId sets the TimerId field's value.

func (StartTimerFailedEventAttributes) String added in v0.6.5

String returns the string representation

type StartWorkflowExecutionInput

type StartWorkflowExecutionInput struct {

	// If set, specifies the policy to use for the child workflow executions of
	// this workflow execution if it is terminated, by calling the TerminateWorkflowExecution
	// action explicitly or due to an expired timeout. This policy overrides the
	// default child policy specified when registering the workflow type using RegisterWorkflowType.
	//
	// The supported child policies are:
	//
	//    * TERMINATE – The child executions are terminated.
	//
	//    * REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.
	//
	// A child policy for this workflow execution must be specified either as a
	// default for the workflow type or through this parameter. If neither this
	// parameter is set nor a default child policy was specified at registration
	// time then a fault is returned.
	ChildPolicy *string `locationName:"childPolicy" type:"string" enum:"ChildPolicy"`

	// The name of the domain in which the workflow execution is created.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout
	// specified when registering the workflow type.
	//
	// The duration is specified in seconds; an integer greater than or equal to
	// 0. Exceeding this limit causes the workflow execution to time out. Unlike
	// some of the other timeout parameters in Amazon SWF, you cannot specify a
	// value of "NONE" for this timeout; there is a one-year max limit on the time
	// that a workflow execution can run.
	//
	// An execution start-to-close timeout must be specified either through this
	// parameter or as a default when the workflow type is registered. If neither
	// this parameter nor a default execution start-to-close timeout is specified,
	// a fault is returned.
	ExecutionStartToCloseTimeout *string `locationName:"executionStartToCloseTimeout" type:"string"`

	// The input for the workflow execution. This is a free form string which should
	// be meaningful to the workflow you are starting. This input is made available
	// to the new workflow execution in the WorkflowExecutionStarted history event.
	Input *string `locationName:"input" type:"string"`

	// The IAM role to attach to this workflow execution.
	//
	// Executions of this workflow type need IAM roles to invoke Lambda functions.
	// If you don't attach an IAM role, any attempt to schedule a Lambda task fails.
	// This results in a ScheduleLambdaFunctionFailed history event. For more information,
	// see http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html
	// (http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html)
	// in the Amazon SWF Developer Guide.
	LambdaRole *string `locationName:"lambdaRole" min:"1" type:"string"`

	// The list of tags to associate with the workflow execution. You can specify
	// a maximum of 5 tags. You can list workflow executions with a specific tag
	// by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and
	// specifying a TagFilter.
	TagList []*string `locationName:"tagList" type:"list"`

	// The task list to use for the decision tasks generated for this workflow execution.
	// This overrides the defaultTaskList specified when registering the workflow
	// type.
	//
	// A task list for this workflow execution must be specified either as a default
	// for the workflow type or through this parameter. If neither this parameter
	// is set nor a default task list was specified at registration time then a
	// fault is returned.
	//
	// The specified string must not start or end with whitespace. It must not contain
	// a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f
	// | \u007f-\u009f). Also, it must not contain the literal string arn.
	TaskList *TaskList `locationName:"taskList" type:"structure"`

	// The task priority to use for this workflow execution. This overrides any
	// default priority that was assigned when the workflow type was registered.
	// If not set, then the default task priority for the workflow type is used.
	// Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648)
	// to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
	//
	// For more information about setting task priority, see Setting Task Priority
	// (http://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html)
	// in the Amazon SWF Developer Guide.
	TaskPriority *string `locationName:"taskPriority" type:"string"`

	// Specifies the maximum duration of decision tasks for this workflow execution.
	// This parameter overrides the defaultTaskStartToCloseTimout specified when
	// registering the workflow type using RegisterWorkflowType.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	//
	// A task start-to-close timeout for this workflow execution must be specified
	// either as a default for the workflow type or through this parameter. If neither
	// this parameter is set nor a default task start-to-close timeout was specified
	// at registration time then a fault is returned.
	TaskStartToCloseTimeout *string `locationName:"taskStartToCloseTimeout" type:"string"`

	// The user defined identifier associated with the workflow execution. You can
	// use this to associate a custom identifier with the workflow execution. You
	// may specify the same identifier if a workflow execution is logically a restart
	// of a previous execution. You cannot have two open workflow executions with
	// the same workflowId at the same time.
	//
	// The specified string must not start or end with whitespace. It must not contain
	// a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f
	// | \u007f-\u009f). Also, it must not contain the literal string arn.
	//
	// WorkflowId is a required field
	WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`

	// The type of the workflow to start.
	//
	// WorkflowType is a required field
	WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartWorkflowExecutionInput) GoString added in v0.6.5

func (s StartWorkflowExecutionInput) GoString() string

GoString returns the string representation

func (*StartWorkflowExecutionInput) SetChildPolicy added in v1.5.0

SetChildPolicy sets the ChildPolicy field's value.

func (*StartWorkflowExecutionInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*StartWorkflowExecutionInput) SetExecutionStartToCloseTimeout added in v1.5.0

func (s *StartWorkflowExecutionInput) SetExecutionStartToCloseTimeout(v string) *StartWorkflowExecutionInput

SetExecutionStartToCloseTimeout sets the ExecutionStartToCloseTimeout field's value.

func (*StartWorkflowExecutionInput) SetInput added in v1.5.0

SetInput sets the Input field's value.

func (*StartWorkflowExecutionInput) SetLambdaRole added in v1.5.0

SetLambdaRole sets the LambdaRole field's value.

func (*StartWorkflowExecutionInput) SetTagList added in v1.5.0

SetTagList sets the TagList field's value.

func (*StartWorkflowExecutionInput) SetTaskList added in v1.5.0

SetTaskList sets the TaskList field's value.

func (*StartWorkflowExecutionInput) SetTaskPriority added in v1.5.0

SetTaskPriority sets the TaskPriority field's value.

func (*StartWorkflowExecutionInput) SetTaskStartToCloseTimeout added in v1.5.0

func (s *StartWorkflowExecutionInput) SetTaskStartToCloseTimeout(v string) *StartWorkflowExecutionInput

SetTaskStartToCloseTimeout sets the TaskStartToCloseTimeout field's value.

func (*StartWorkflowExecutionInput) SetWorkflowId added in v1.5.0

SetWorkflowId sets the WorkflowId field's value.

func (*StartWorkflowExecutionInput) SetWorkflowType added in v1.5.0

SetWorkflowType sets the WorkflowType field's value.

func (StartWorkflowExecutionInput) String added in v0.6.5

String returns the string representation

func (*StartWorkflowExecutionInput) Validate added in v1.1.21

func (s *StartWorkflowExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartWorkflowExecutionOutput

type StartWorkflowExecutionOutput struct {

	// The runId of a workflow execution. This ID is generated by the service and
	// can be used to uniquely identify the workflow execution within a domain.
	RunId *string `locationName:"runId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Specifies the runId of a workflow execution.

func (StartWorkflowExecutionOutput) GoString added in v0.6.5

func (s StartWorkflowExecutionOutput) GoString() string

GoString returns the string representation

func (*StartWorkflowExecutionOutput) SetRunId added in v1.5.0

SetRunId sets the RunId field's value.

func (StartWorkflowExecutionOutput) String added in v0.6.5

String returns the string representation

type TagFilter

type TagFilter struct {

	// Specifies the tag that must be associated with the execution for it to meet
	// the filter criteria.
	//
	// Tag is a required field
	Tag *string `locationName:"tag" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Used to filter the workflow executions in visibility APIs based on a tag.

func (TagFilter) GoString added in v0.6.5

func (s TagFilter) GoString() string

GoString returns the string representation

func (*TagFilter) SetTag added in v1.5.0

func (s *TagFilter) SetTag(v string) *TagFilter

SetTag sets the Tag field's value.

func (TagFilter) String added in v0.6.5

func (s TagFilter) String() string

String returns the string representation

func (*TagFilter) Validate added in v1.1.21

func (s *TagFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TaskList

type TaskList struct {

	// The name of the task list.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a task list.

func (TaskList) GoString added in v0.6.5

func (s TaskList) GoString() string

GoString returns the string representation

func (*TaskList) SetName added in v1.5.0

func (s *TaskList) SetName(v string) *TaskList

SetName sets the Name field's value.

func (TaskList) String added in v0.6.5

func (s TaskList) String() string

String returns the string representation

func (*TaskList) Validate added in v1.1.21

func (s *TaskList) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TerminateWorkflowExecutionInput

type TerminateWorkflowExecutionInput struct {

	// If set, specifies the policy to use for the child workflow executions of
	// the workflow execution being terminated. This policy overrides the child
	// policy specified for the workflow execution at registration time or when
	// starting the execution.
	//
	// The supported child policies are:
	//
	//    * TERMINATE – The child executions are terminated.
	//
	//    * REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.
	//
	// A child policy for this workflow execution must be specified either as a
	// default for the workflow type or through this parameter. If neither this
	// parameter is set nor a default child policy was specified at registration
	// time then a fault is returned.
	ChildPolicy *string `locationName:"childPolicy" type:"string" enum:"ChildPolicy"`

	// Details for terminating the workflow execution.
	Details *string `locationName:"details" type:"string"`

	// The domain of the workflow execution to terminate.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// A descriptive reason for terminating the workflow execution.
	Reason *string `locationName:"reason" type:"string"`

	// The runId of the workflow execution to terminate.
	RunId *string `locationName:"runId" type:"string"`

	// The workflowId of the workflow execution to terminate.
	//
	// WorkflowId is a required field
	WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (TerminateWorkflowExecutionInput) GoString added in v0.6.5

GoString returns the string representation

func (*TerminateWorkflowExecutionInput) SetChildPolicy added in v1.5.0

SetChildPolicy sets the ChildPolicy field's value.

func (*TerminateWorkflowExecutionInput) SetDetails added in v1.5.0

SetDetails sets the Details field's value.

func (*TerminateWorkflowExecutionInput) SetDomain added in v1.5.0

SetDomain sets the Domain field's value.

func (*TerminateWorkflowExecutionInput) SetReason added in v1.5.0

SetReason sets the Reason field's value.

func (*TerminateWorkflowExecutionInput) SetRunId added in v1.5.0

SetRunId sets the RunId field's value.

func (*TerminateWorkflowExecutionInput) SetWorkflowId added in v1.5.0

SetWorkflowId sets the WorkflowId field's value.

func (TerminateWorkflowExecutionInput) String added in v0.6.5

String returns the string representation

func (*TerminateWorkflowExecutionInput) Validate added in v1.1.21

func (s *TerminateWorkflowExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TerminateWorkflowExecutionOutput

type TerminateWorkflowExecutionOutput struct {
	// contains filtered or unexported fields
}

func (TerminateWorkflowExecutionOutput) GoString added in v0.6.5

GoString returns the string representation

func (TerminateWorkflowExecutionOutput) String added in v0.6.5

String returns the string representation

type TimerCanceledEventAttributes

type TimerCanceledEventAttributes struct {

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// 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.
	//
	// StartedEventId is a required field
	StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`

	// The unique ID of the timer that was canceled.
	//
	// TimerId is a required field
	TimerId *string `locationName:"timerId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the TimerCanceled event.

func (TimerCanceledEventAttributes) GoString added in v0.6.5

func (s TimerCanceledEventAttributes) GoString() string

GoString returns the string representation

func (*TimerCanceledEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

func (s *TimerCanceledEventAttributes) SetDecisionTaskCompletedEventId(v int64) *TimerCanceledEventAttributes

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*TimerCanceledEventAttributes) SetStartedEventId added in v1.5.0

SetStartedEventId sets the StartedEventId field's value.

func (*TimerCanceledEventAttributes) SetTimerId added in v1.5.0

SetTimerId sets the TimerId field's value.

func (TimerCanceledEventAttributes) String added in v0.6.5

String returns the string representation

type TimerFiredEventAttributes

type TimerFiredEventAttributes struct {

	// 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.
	//
	// StartedEventId is a required field
	StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`

	// The unique ID of the timer that fired.
	//
	// TimerId is a required field
	TimerId *string `locationName:"timerId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the TimerFired event.

func (TimerFiredEventAttributes) GoString added in v0.6.5

func (s TimerFiredEventAttributes) GoString() string

GoString returns the string representation

func (*TimerFiredEventAttributes) SetStartedEventId added in v1.5.0

SetStartedEventId sets the StartedEventId field's value.

func (*TimerFiredEventAttributes) SetTimerId added in v1.5.0

SetTimerId sets the TimerId field's value.

func (TimerFiredEventAttributes) String added in v0.6.5

func (s TimerFiredEventAttributes) String() string

String returns the string representation

type TimerStartedEventAttributes

type TimerStartedEventAttributes struct {

	// Data attached to the event that can be used by the decider in subsequent
	// workflow tasks.
	Control *string `locationName:"control" type:"string"`

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// The duration of time after which the timer fires.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0.
	//
	// StartToFireTimeout is a required field
	StartToFireTimeout *string `locationName:"startToFireTimeout" min:"1" type:"string" required:"true"`

	// The unique ID of the timer that was started.
	//
	// TimerId is a required field
	TimerId *string `locationName:"timerId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the TimerStarted event.

func (TimerStartedEventAttributes) GoString added in v0.6.5

func (s TimerStartedEventAttributes) GoString() string

GoString returns the string representation

func (*TimerStartedEventAttributes) SetControl added in v1.5.0

SetControl sets the Control field's value.

func (*TimerStartedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

func (s *TimerStartedEventAttributes) SetDecisionTaskCompletedEventId(v int64) *TimerStartedEventAttributes

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*TimerStartedEventAttributes) SetStartToFireTimeout added in v1.5.0

func (s *TimerStartedEventAttributes) SetStartToFireTimeout(v string) *TimerStartedEventAttributes

SetStartToFireTimeout sets the StartToFireTimeout field's value.

func (*TimerStartedEventAttributes) SetTimerId added in v1.5.0

SetTimerId sets the TimerId field's value.

func (TimerStartedEventAttributes) String added in v0.6.5

String returns the string representation

type WorkflowExecution

type WorkflowExecution struct {

	// A system-generated unique identifier for the workflow execution.
	//
	// RunId is a required field
	RunId *string `locationName:"runId" min:"1" type:"string" required:"true"`

	// The user defined identifier associated with the workflow execution.
	//
	// WorkflowId is a required field
	WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a workflow execution.

func (WorkflowExecution) GoString added in v0.6.5

func (s WorkflowExecution) GoString() string

GoString returns the string representation

func (*WorkflowExecution) SetRunId added in v1.5.0

func (s *WorkflowExecution) SetRunId(v string) *WorkflowExecution

SetRunId sets the RunId field's value.

func (*WorkflowExecution) SetWorkflowId added in v1.5.0

func (s *WorkflowExecution) SetWorkflowId(v string) *WorkflowExecution

SetWorkflowId sets the WorkflowId field's value.

func (WorkflowExecution) String added in v0.6.5

func (s WorkflowExecution) String() string

String returns the string representation

func (*WorkflowExecution) Validate added in v1.1.21

func (s *WorkflowExecution) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WorkflowExecutionCancelRequestedEventAttributes

type WorkflowExecutionCancelRequestedEventAttributes struct {

	// 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.
	Cause *string `locationName:"cause" type:"string" enum:"WorkflowExecutionCancelRequestedCause"`

	// 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.
	ExternalInitiatedEventId *int64 `locationName:"externalInitiatedEventId" type:"long"`

	// The external workflow execution for which the cancellation was requested.
	ExternalWorkflowExecution *WorkflowExecution `locationName:"externalWorkflowExecution" type:"structure"`
	// contains filtered or unexported fields
}

Provides the details of the WorkflowExecutionCancelRequested event.

func (WorkflowExecutionCancelRequestedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*WorkflowExecutionCancelRequestedEventAttributes) SetCause added in v1.5.0

SetCause sets the Cause field's value.

func (*WorkflowExecutionCancelRequestedEventAttributes) SetExternalInitiatedEventId added in v1.5.0

SetExternalInitiatedEventId sets the ExternalInitiatedEventId field's value.

func (*WorkflowExecutionCancelRequestedEventAttributes) SetExternalWorkflowExecution added in v1.5.0

SetExternalWorkflowExecution sets the ExternalWorkflowExecution field's value.

func (WorkflowExecutionCancelRequestedEventAttributes) String added in v0.6.5

String returns the string representation

type WorkflowExecutionCanceledEventAttributes

type WorkflowExecutionCanceledEventAttributes struct {

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// The details of the cancellation.
	Details *string `locationName:"details" type:"string"`
	// contains filtered or unexported fields
}

Provides the details of the WorkflowExecutionCanceled event.

func (WorkflowExecutionCanceledEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*WorkflowExecutionCanceledEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*WorkflowExecutionCanceledEventAttributes) SetDetails added in v1.5.0

SetDetails sets the Details field's value.

func (WorkflowExecutionCanceledEventAttributes) String added in v0.6.5

String returns the string representation

type WorkflowExecutionCompletedEventAttributes

type WorkflowExecutionCompletedEventAttributes struct {

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// The result produced by the workflow execution upon successful completion.
	Result *string `locationName:"result" type:"string"`
	// contains filtered or unexported fields
}

Provides the details of the WorkflowExecutionCompleted event.

func (WorkflowExecutionCompletedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*WorkflowExecutionCompletedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*WorkflowExecutionCompletedEventAttributes) SetResult added in v1.5.0

SetResult sets the Result field's value.

func (WorkflowExecutionCompletedEventAttributes) String added in v0.6.5

String returns the string representation

type WorkflowExecutionConfiguration

type WorkflowExecutionConfiguration struct {

	// The policy to use for the child workflow executions if this workflow execution
	// is terminated, by calling the TerminateWorkflowExecution action explicitly
	// or due to an expired timeout.
	//
	// The supported child policies are:
	//
	//    * TERMINATE – The child executions are terminated.
	//
	//    * REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.
	//
	// ChildPolicy is a required field
	ChildPolicy *string `locationName:"childPolicy" type:"string" required:"true" enum:"ChildPolicy"`

	// The total duration for this workflow execution.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	//
	// ExecutionStartToCloseTimeout is a required field
	ExecutionStartToCloseTimeout *string `locationName:"executionStartToCloseTimeout" min:"1" type:"string" required:"true"`

	// The IAM role attached to the child workflow execution.
	LambdaRole *string `locationName:"lambdaRole" min:"1" type:"string"`

	// The task list used for the decision tasks generated for this workflow execution.
	//
	// TaskList is a required field
	TaskList *TaskList `locationName:"taskList" type:"structure" required:"true"`

	// The priority assigned to decision tasks for this workflow execution. Valid
	// values are integers that range from Java's Integer.MIN_VALUE (-2147483648)
	// to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
	//
	// For more information about setting task priority, see Setting Task Priority
	// (http://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html)
	// in the Amazon SWF Developer Guide.
	TaskPriority *string `locationName:"taskPriority" type:"string"`

	// The maximum duration allowed for decision tasks for this workflow execution.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	//
	// TaskStartToCloseTimeout is a required field
	TaskStartToCloseTimeout *string `locationName:"taskStartToCloseTimeout" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The configuration settings for a workflow execution including timeout values, tasklist etc. These configuration settings are determined from the defaults specified when registering the workflow type and those specified when starting the workflow execution.

func (WorkflowExecutionConfiguration) GoString added in v0.6.5

GoString returns the string representation

func (*WorkflowExecutionConfiguration) SetChildPolicy added in v1.5.0

SetChildPolicy sets the ChildPolicy field's value.

func (*WorkflowExecutionConfiguration) SetExecutionStartToCloseTimeout added in v1.5.0

func (s *WorkflowExecutionConfiguration) SetExecutionStartToCloseTimeout(v string) *WorkflowExecutionConfiguration

SetExecutionStartToCloseTimeout sets the ExecutionStartToCloseTimeout field's value.

func (*WorkflowExecutionConfiguration) SetLambdaRole added in v1.5.0

SetLambdaRole sets the LambdaRole field's value.

func (*WorkflowExecutionConfiguration) SetTaskList added in v1.5.0

SetTaskList sets the TaskList field's value.

func (*WorkflowExecutionConfiguration) SetTaskPriority added in v1.5.0

SetTaskPriority sets the TaskPriority field's value.

func (*WorkflowExecutionConfiguration) SetTaskStartToCloseTimeout added in v1.5.0

func (s *WorkflowExecutionConfiguration) SetTaskStartToCloseTimeout(v string) *WorkflowExecutionConfiguration

SetTaskStartToCloseTimeout sets the TaskStartToCloseTimeout field's value.

func (WorkflowExecutionConfiguration) String added in v0.6.5

String returns the string representation

type WorkflowExecutionContinuedAsNewEventAttributes

type WorkflowExecutionContinuedAsNewEventAttributes struct {

	// The policy to use for the child workflow executions of the new execution
	// if it is terminated by calling the TerminateWorkflowExecution action explicitly
	// or due to an expired timeout.
	//
	// The supported child policies are:
	//
	//    * TERMINATE – The child executions are terminated.
	//
	//    * REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.
	//
	// ChildPolicy is a required field
	ChildPolicy *string `locationName:"childPolicy" type:"string" required:"true" enum:"ChildPolicy"`

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// The total duration allowed for the new workflow execution.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	ExecutionStartToCloseTimeout *string `locationName:"executionStartToCloseTimeout" type:"string"`

	// The input provided to the new workflow execution.
	Input *string `locationName:"input" type:"string"`

	// The IAM role to attach to the new (continued) workflow execution.
	LambdaRole *string `locationName:"lambdaRole" min:"1" type:"string"`

	// The runId of the new workflow execution.
	//
	// NewExecutionRunId is a required field
	NewExecutionRunId *string `locationName:"newExecutionRunId" min:"1" type:"string" required:"true"`

	// The list of tags associated with the new workflow execution.
	TagList []*string `locationName:"tagList" type:"list"`

	// The task list to use for the decisions of the new (continued) workflow execution.
	//
	// TaskList is a required field
	TaskList *TaskList `locationName:"taskList" type:"structure" required:"true"`

	// The priority of the task to use for the decisions of the new (continued)
	// workflow execution.
	TaskPriority *string `locationName:"taskPriority" type:"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. You can use NONE to specify unlimited duration.
	TaskStartToCloseTimeout *string `locationName:"taskStartToCloseTimeout" type:"string"`

	// The workflow type of this execution.
	//
	// WorkflowType is a required field
	WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the WorkflowExecutionContinuedAsNew event.

func (WorkflowExecutionContinuedAsNewEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*WorkflowExecutionContinuedAsNewEventAttributes) SetChildPolicy added in v1.5.0

SetChildPolicy sets the ChildPolicy field's value.

func (*WorkflowExecutionContinuedAsNewEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*WorkflowExecutionContinuedAsNewEventAttributes) SetExecutionStartToCloseTimeout added in v1.5.0

SetExecutionStartToCloseTimeout sets the ExecutionStartToCloseTimeout field's value.

func (*WorkflowExecutionContinuedAsNewEventAttributes) SetInput added in v1.5.0

SetInput sets the Input field's value.

func (*WorkflowExecutionContinuedAsNewEventAttributes) SetLambdaRole added in v1.5.0

SetLambdaRole sets the LambdaRole field's value.

func (*WorkflowExecutionContinuedAsNewEventAttributes) SetNewExecutionRunId added in v1.5.0

SetNewExecutionRunId sets the NewExecutionRunId field's value.

func (*WorkflowExecutionContinuedAsNewEventAttributes) SetTagList added in v1.5.0

SetTagList sets the TagList field's value.

func (*WorkflowExecutionContinuedAsNewEventAttributes) SetTaskList added in v1.5.0

SetTaskList sets the TaskList field's value.

func (*WorkflowExecutionContinuedAsNewEventAttributes) SetTaskPriority added in v1.5.0

SetTaskPriority sets the TaskPriority field's value.

func (*WorkflowExecutionContinuedAsNewEventAttributes) SetTaskStartToCloseTimeout added in v1.5.0

SetTaskStartToCloseTimeout sets the TaskStartToCloseTimeout field's value.

func (*WorkflowExecutionContinuedAsNewEventAttributes) SetWorkflowType added in v1.5.0

SetWorkflowType sets the WorkflowType field's value.

func (WorkflowExecutionContinuedAsNewEventAttributes) String added in v0.6.5

String returns the string representation

type WorkflowExecutionCount

type WorkflowExecutionCount struct {

	// The number of workflow executions.
	//
	// Count is a required field
	Count *int64 `locationName:"count" type:"integer" required:"true"`

	// If set to true, indicates that the actual count was more than the maximum
	// supported by this API and the count returned is the truncated value.
	Truncated *bool `locationName:"truncated" type:"boolean"`
	// contains filtered or unexported fields
}

Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions

func (WorkflowExecutionCount) GoString added in v0.6.5

func (s WorkflowExecutionCount) GoString() string

GoString returns the string representation

func (*WorkflowExecutionCount) SetCount added in v1.5.0

SetCount sets the Count field's value.

func (*WorkflowExecutionCount) SetTruncated added in v1.5.0

SetTruncated sets the Truncated field's value.

func (WorkflowExecutionCount) String added in v0.6.5

func (s WorkflowExecutionCount) String() string

String returns the string representation

type WorkflowExecutionFailedEventAttributes

type WorkflowExecutionFailedEventAttributes struct {

	// 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.
	//
	// DecisionTaskCompletedEventId is a required field
	DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`

	// The details of the failure.
	Details *string `locationName:"details" type:"string"`

	// The descriptive reason provided for the failure.
	Reason *string `locationName:"reason" type:"string"`
	// contains filtered or unexported fields
}

Provides the details of the WorkflowExecutionFailed event.

func (WorkflowExecutionFailedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*WorkflowExecutionFailedEventAttributes) SetDecisionTaskCompletedEventId added in v1.5.0

SetDecisionTaskCompletedEventId sets the DecisionTaskCompletedEventId field's value.

func (*WorkflowExecutionFailedEventAttributes) SetDetails added in v1.5.0

SetDetails sets the Details field's value.

func (*WorkflowExecutionFailedEventAttributes) SetReason added in v1.5.0

SetReason sets the Reason field's value.

func (WorkflowExecutionFailedEventAttributes) String added in v0.6.5

String returns the string representation

type WorkflowExecutionFilter

type WorkflowExecutionFilter struct {

	// The workflowId to pass of match the criteria of this filter.
	//
	// WorkflowId is a required field
	WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Used to filter the workflow executions in visibility APIs by their workflowId.

func (WorkflowExecutionFilter) GoString added in v0.6.5

func (s WorkflowExecutionFilter) GoString() string

GoString returns the string representation

func (*WorkflowExecutionFilter) SetWorkflowId added in v1.5.0

SetWorkflowId sets the WorkflowId field's value.

func (WorkflowExecutionFilter) String added in v0.6.5

func (s WorkflowExecutionFilter) String() string

String returns the string representation

func (*WorkflowExecutionFilter) Validate added in v1.1.21

func (s *WorkflowExecutionFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WorkflowExecutionInfo

type WorkflowExecutionInfo struct {

	// Set to true if a cancellation is requested for this workflow execution.
	CancelRequested *bool `locationName:"cancelRequested" type:"boolean"`

	// If the execution status is closed then this specifies how the execution was
	// closed:
	//
	//    * COMPLETED – the execution was successfully completed.
	//
	//    * CANCELED – the execution was canceled.Cancellation allows the implementation
	//    to gracefully clean up before the execution is closed.
	//
	//    * TERMINATED – the execution was force terminated.
	//
	//    * FAILED – the execution failed to complete.
	//
	//    * TIMED_OUT – the execution did not complete in the alloted time and was
	//    automatically timed out.
	//
	//    * CONTINUED_AS_NEW – the execution is logically continued. This means
	//    the current execution was completed and a new execution was started to
	//    carry on the workflow.
	CloseStatus *string `locationName:"closeStatus" type:"string" enum:"CloseStatus"`

	// The time when the workflow execution was closed. Set only if the execution
	// status is CLOSED.
	CloseTimestamp *time.Time `locationName:"closeTimestamp" type:"timestamp" timestampFormat:"unix"`

	// The workflow execution this information is about.
	//
	// Execution is a required field
	Execution *WorkflowExecution `locationName:"execution" type:"structure" required:"true"`

	// The current status of the execution.
	//
	// ExecutionStatus is a required field
	ExecutionStatus *string `locationName:"executionStatus" type:"string" required:"true" enum:"ExecutionStatus"`

	// If this workflow execution is a child of another execution then contains
	// the workflow execution that started this execution.
	Parent *WorkflowExecution `locationName:"parent" type:"structure"`

	// The time when the execution was started.
	//
	// StartTimestamp is a required field
	StartTimestamp *time.Time `locationName:"startTimestamp" type:"timestamp" timestampFormat:"unix" required:"true"`

	// The list of tags associated with the workflow execution. Tags can be used
	// to identify and list workflow executions of interest through the visibility
	// APIs. A workflow execution can have a maximum of 5 tags.
	TagList []*string `locationName:"tagList" type:"list"`

	// The type of the workflow execution.
	//
	// WorkflowType is a required field
	WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains information about a workflow execution.

func (WorkflowExecutionInfo) GoString added in v0.6.5

func (s WorkflowExecutionInfo) GoString() string

GoString returns the string representation

func (*WorkflowExecutionInfo) SetCancelRequested added in v1.5.0

func (s *WorkflowExecutionInfo) SetCancelRequested(v bool) *WorkflowExecutionInfo

SetCancelRequested sets the CancelRequested field's value.

func (*WorkflowExecutionInfo) SetCloseStatus added in v1.5.0

func (s *WorkflowExecutionInfo) SetCloseStatus(v string) *WorkflowExecutionInfo

SetCloseStatus sets the CloseStatus field's value.

func (*WorkflowExecutionInfo) SetCloseTimestamp added in v1.5.0

func (s *WorkflowExecutionInfo) SetCloseTimestamp(v time.Time) *WorkflowExecutionInfo

SetCloseTimestamp sets the CloseTimestamp field's value.

func (*WorkflowExecutionInfo) SetExecution added in v1.5.0

SetExecution sets the Execution field's value.

func (*WorkflowExecutionInfo) SetExecutionStatus added in v1.5.0

func (s *WorkflowExecutionInfo) SetExecutionStatus(v string) *WorkflowExecutionInfo

SetExecutionStatus sets the ExecutionStatus field's value.

func (*WorkflowExecutionInfo) SetParent added in v1.5.0

SetParent sets the Parent field's value.

func (*WorkflowExecutionInfo) SetStartTimestamp added in v1.5.0

func (s *WorkflowExecutionInfo) SetStartTimestamp(v time.Time) *WorkflowExecutionInfo

SetStartTimestamp sets the StartTimestamp field's value.

func (*WorkflowExecutionInfo) SetTagList added in v1.5.0

func (s *WorkflowExecutionInfo) SetTagList(v []*string) *WorkflowExecutionInfo

SetTagList sets the TagList field's value.

func (*WorkflowExecutionInfo) SetWorkflowType added in v1.5.0

SetWorkflowType sets the WorkflowType field's value.

func (WorkflowExecutionInfo) String added in v0.6.5

func (s WorkflowExecutionInfo) String() string

String returns the string representation

type WorkflowExecutionInfos

type WorkflowExecutionInfos struct {

	// The list of workflow information structures.
	//
	// ExecutionInfos is a required field
	ExecutionInfos []*WorkflowExecutionInfo `locationName:"executionInfos" type:"list" required:"true"`

	// 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.
	NextPageToken *string `locationName:"nextPageToken" type:"string"`
	// contains filtered or unexported fields
}

Contains a paginated list of information about workflow executions.

func (WorkflowExecutionInfos) GoString added in v0.6.5

func (s WorkflowExecutionInfos) GoString() string

GoString returns the string representation

func (*WorkflowExecutionInfos) SetExecutionInfos added in v1.5.0

SetExecutionInfos sets the ExecutionInfos field's value.

func (*WorkflowExecutionInfos) SetNextPageToken added in v1.5.0

func (s *WorkflowExecutionInfos) SetNextPageToken(v string) *WorkflowExecutionInfos

SetNextPageToken sets the NextPageToken field's value.

func (WorkflowExecutionInfos) String added in v0.6.5

func (s WorkflowExecutionInfos) String() string

String returns the string representation

type WorkflowExecutionOpenCounts

type WorkflowExecutionOpenCounts struct {

	// The count of activity tasks whose status is OPEN.
	//
	// OpenActivityTasks is a required field
	OpenActivityTasks *int64 `locationName:"openActivityTasks" type:"integer" required:"true"`

	// The count of child workflow executions whose status is OPEN.
	//
	// OpenChildWorkflowExecutions is a required field
	OpenChildWorkflowExecutions *int64 `locationName:"openChildWorkflowExecutions" type:"integer" required:"true"`

	// The count of decision tasks whose status is OPEN. A workflow execution can
	// have at most one open decision task.
	//
	// OpenDecisionTasks is a required field
	OpenDecisionTasks *int64 `locationName:"openDecisionTasks" type:"integer" required:"true"`

	// The count of Lambda tasks whose status is OPEN.
	OpenLambdaFunctions *int64 `locationName:"openLambdaFunctions" type:"integer"`

	// The count of timers started by this workflow execution that have not fired
	// yet.
	//
	// OpenTimers is a required field
	OpenTimers *int64 `locationName:"openTimers" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Contains the counts of open tasks, child workflow executions and timers for a workflow execution.

func (WorkflowExecutionOpenCounts) GoString added in v0.6.5

func (s WorkflowExecutionOpenCounts) GoString() string

GoString returns the string representation

func (*WorkflowExecutionOpenCounts) SetOpenActivityTasks added in v1.5.0

SetOpenActivityTasks sets the OpenActivityTasks field's value.

func (*WorkflowExecutionOpenCounts) SetOpenChildWorkflowExecutions added in v1.5.0

func (s *WorkflowExecutionOpenCounts) SetOpenChildWorkflowExecutions(v int64) *WorkflowExecutionOpenCounts

SetOpenChildWorkflowExecutions sets the OpenChildWorkflowExecutions field's value.

func (*WorkflowExecutionOpenCounts) SetOpenDecisionTasks added in v1.5.0

SetOpenDecisionTasks sets the OpenDecisionTasks field's value.

func (*WorkflowExecutionOpenCounts) SetOpenLambdaFunctions added in v1.5.0

func (s *WorkflowExecutionOpenCounts) SetOpenLambdaFunctions(v int64) *WorkflowExecutionOpenCounts

SetOpenLambdaFunctions sets the OpenLambdaFunctions field's value.

func (*WorkflowExecutionOpenCounts) SetOpenTimers added in v1.5.0

SetOpenTimers sets the OpenTimers field's value.

func (WorkflowExecutionOpenCounts) String added in v0.6.5

String returns the string representation

type WorkflowExecutionSignaledEventAttributes

type WorkflowExecutionSignaledEventAttributes struct {

	// 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.
	ExternalInitiatedEventId *int64 `locationName:"externalInitiatedEventId" type:"long"`

	// The workflow execution that sent the signal. This is set only of the signal
	// was sent by another workflow execution.
	ExternalWorkflowExecution *WorkflowExecution `locationName:"externalWorkflowExecution" type:"structure"`

	// The inputs provided with the signal. The decider can use the signal name
	// and inputs to determine how to process the signal.
	Input *string `locationName:"input" type:"string"`

	// The name of the signal received. The decider can use the signal name and
	// inputs to determine how to the process the signal.
	//
	// SignalName is a required field
	SignalName *string `locationName:"signalName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the details of the WorkflowExecutionSignaled event.

func (WorkflowExecutionSignaledEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*WorkflowExecutionSignaledEventAttributes) SetExternalInitiatedEventId added in v1.5.0

SetExternalInitiatedEventId sets the ExternalInitiatedEventId field's value.

func (*WorkflowExecutionSignaledEventAttributes) SetExternalWorkflowExecution added in v1.5.0

SetExternalWorkflowExecution sets the ExternalWorkflowExecution field's value.

func (*WorkflowExecutionSignaledEventAttributes) SetInput added in v1.5.0

SetInput sets the Input field's value.

func (*WorkflowExecutionSignaledEventAttributes) SetSignalName added in v1.5.0

SetSignalName sets the SignalName field's value.

func (WorkflowExecutionSignaledEventAttributes) String added in v0.6.5

String returns the string representation

type WorkflowExecutionStartedEventAttributes

type WorkflowExecutionStartedEventAttributes struct {

	// The policy to use for the child workflow executions if this workflow execution
	// is terminated, by calling the TerminateWorkflowExecution action explicitly
	// or due to an expired timeout.
	//
	// The supported child policies are:
	//
	//    * TERMINATE – The child executions are terminated.
	//
	//    * REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.
	//
	// ChildPolicy is a required field
	ChildPolicy *string `locationName:"childPolicy" type:"string" required:"true" enum:"ChildPolicy"`

	// 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.
	ContinuedExecutionRunId *string `locationName:"continuedExecutionRunId" type:"string"`

	// The maximum duration for this workflow execution.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	ExecutionStartToCloseTimeout *string `locationName:"executionStartToCloseTimeout" type:"string"`

	// The input provided to the workflow execution.
	Input *string `locationName:"input" type:"string"`

	// The IAM role attached to the workflow execution.
	LambdaRole *string `locationName:"lambdaRole" min:"1" type:"string"`

	// The ID of the StartChildWorkflowExecutionInitiated event corresponding to
	// the StartChildWorkflowExecutionDecision 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.
	ParentInitiatedEventId *int64 `locationName:"parentInitiatedEventId" type:"long"`

	// The source workflow execution that started this workflow execution. The member
	// isn't set if the workflow execution was not started by a workflow.
	ParentWorkflowExecution *WorkflowExecution `locationName:"parentWorkflowExecution" type:"structure"`

	// The list of tags associated with this workflow execution. An execution can
	// have up to 5 tags.
	TagList []*string `locationName:"tagList" type:"list"`

	// The name of the task list for scheduling the decision tasks for this workflow
	// execution.
	//
	// TaskList is a required field
	TaskList *TaskList `locationName:"taskList" type:"structure" required:"true"`

	// The priority of the decision tasks in the workflow execution.
	TaskPriority *string `locationName:"taskPriority" type:"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. You can use NONE to specify unlimited duration.
	TaskStartToCloseTimeout *string `locationName:"taskStartToCloseTimeout" type:"string"`

	// The workflow type of this execution.
	//
	// WorkflowType is a required field
	WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides details of WorkflowExecutionStarted event.

func (WorkflowExecutionStartedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*WorkflowExecutionStartedEventAttributes) SetChildPolicy added in v1.5.0

SetChildPolicy sets the ChildPolicy field's value.

func (*WorkflowExecutionStartedEventAttributes) SetContinuedExecutionRunId added in v1.5.0

SetContinuedExecutionRunId sets the ContinuedExecutionRunId field's value.

func (*WorkflowExecutionStartedEventAttributes) SetExecutionStartToCloseTimeout added in v1.5.0

SetExecutionStartToCloseTimeout sets the ExecutionStartToCloseTimeout field's value.

func (*WorkflowExecutionStartedEventAttributes) SetInput added in v1.5.0

SetInput sets the Input field's value.

func (*WorkflowExecutionStartedEventAttributes) SetLambdaRole added in v1.5.0

SetLambdaRole sets the LambdaRole field's value.

func (*WorkflowExecutionStartedEventAttributes) SetParentInitiatedEventId added in v1.5.0

SetParentInitiatedEventId sets the ParentInitiatedEventId field's value.

func (*WorkflowExecutionStartedEventAttributes) SetParentWorkflowExecution added in v1.5.0

SetParentWorkflowExecution sets the ParentWorkflowExecution field's value.

func (*WorkflowExecutionStartedEventAttributes) SetTagList added in v1.5.0

SetTagList sets the TagList field's value.

func (*WorkflowExecutionStartedEventAttributes) SetTaskList added in v1.5.0

SetTaskList sets the TaskList field's value.

func (*WorkflowExecutionStartedEventAttributes) SetTaskPriority added in v1.5.0

SetTaskPriority sets the TaskPriority field's value.

func (*WorkflowExecutionStartedEventAttributes) SetTaskStartToCloseTimeout added in v1.5.0

SetTaskStartToCloseTimeout sets the TaskStartToCloseTimeout field's value.

func (*WorkflowExecutionStartedEventAttributes) SetWorkflowType added in v1.5.0

SetWorkflowType sets the WorkflowType field's value.

func (WorkflowExecutionStartedEventAttributes) String added in v0.6.5

String returns the string representation

type WorkflowExecutionTerminatedEventAttributes

type WorkflowExecutionTerminatedEventAttributes struct {

	// 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.
	Cause *string `locationName:"cause" type:"string" enum:"WorkflowExecutionTerminatedCause"`

	// The policy used for the child workflow executions of this workflow execution.
	//
	// The supported child policies are:
	//
	//    * TERMINATE – The child executions are terminated.
	//
	//    * REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.
	//
	// ChildPolicy is a required field
	ChildPolicy *string `locationName:"childPolicy" type:"string" required:"true" enum:"ChildPolicy"`

	// The details provided for the termination.
	Details *string `locationName:"details" type:"string"`

	// The reason provided for the termination.
	Reason *string `locationName:"reason" type:"string"`
	// contains filtered or unexported fields
}

Provides the details of the WorkflowExecutionTerminated event.

func (WorkflowExecutionTerminatedEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*WorkflowExecutionTerminatedEventAttributes) SetCause added in v1.5.0

SetCause sets the Cause field's value.

func (*WorkflowExecutionTerminatedEventAttributes) SetChildPolicy added in v1.5.0

SetChildPolicy sets the ChildPolicy field's value.

func (*WorkflowExecutionTerminatedEventAttributes) SetDetails added in v1.5.0

SetDetails sets the Details field's value.

func (*WorkflowExecutionTerminatedEventAttributes) SetReason added in v1.5.0

SetReason sets the Reason field's value.

func (WorkflowExecutionTerminatedEventAttributes) String added in v0.6.5

String returns the string representation

type WorkflowExecutionTimedOutEventAttributes

type WorkflowExecutionTimedOutEventAttributes struct {

	// The policy used for the child workflow executions of this workflow execution.
	//
	// The supported child policies are:
	//
	//    * TERMINATE – The child executions are terminated.
	//
	//    * REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.
	//
	// ChildPolicy is a required field
	ChildPolicy *string `locationName:"childPolicy" type:"string" required:"true" enum:"ChildPolicy"`

	// The type of timeout that caused this event.
	//
	// TimeoutType is a required field
	TimeoutType *string `locationName:"timeoutType" type:"string" required:"true" enum:"WorkflowExecutionTimeoutType"`
	// contains filtered or unexported fields
}

Provides the details of the WorkflowExecutionTimedOut event.

func (WorkflowExecutionTimedOutEventAttributes) GoString added in v0.6.5

GoString returns the string representation

func (*WorkflowExecutionTimedOutEventAttributes) SetChildPolicy added in v1.5.0

SetChildPolicy sets the ChildPolicy field's value.

func (*WorkflowExecutionTimedOutEventAttributes) SetTimeoutType added in v1.5.0

SetTimeoutType sets the TimeoutType field's value.

func (WorkflowExecutionTimedOutEventAttributes) String added in v0.6.5

String returns the string representation

type WorkflowType

type WorkflowType struct {

	// The name of the workflow type.
	//
	// The combination of workflow type name and version must be unique with in
	// a domain.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The version of the workflow type.
	//
	// The combination of workflow type name and version must be unique with in
	// a domain.
	//
	// Version is a required field
	Version *string `locationName:"version" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a workflow type.

func (WorkflowType) GoString added in v0.6.5

func (s WorkflowType) GoString() string

GoString returns the string representation

func (*WorkflowType) SetName added in v1.5.0

func (s *WorkflowType) SetName(v string) *WorkflowType

SetName sets the Name field's value.

func (*WorkflowType) SetVersion added in v1.5.0

func (s *WorkflowType) SetVersion(v string) *WorkflowType

SetVersion sets the Version field's value.

func (WorkflowType) String added in v0.6.5

func (s WorkflowType) String() string

String returns the string representation

func (*WorkflowType) Validate added in v1.1.21

func (s *WorkflowType) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WorkflowTypeConfiguration

type WorkflowTypeConfiguration struct {

	// The default policy to use for the child workflow executions when a workflow
	// execution of this type is terminated, by calling the TerminateWorkflowExecution
	// action explicitly or due to an expired timeout. This default can be overridden
	// when starting a workflow execution using the StartWorkflowExecution action
	// or the StartChildWorkflowExecutionDecision.
	//
	// The supported child policies are:
	//
	//    * TERMINATE – The child executions are terminated.
	//
	//    * REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.
	DefaultChildPolicy *string `locationName:"defaultChildPolicy" type:"string" enum:"ChildPolicy"`

	// The default maximum duration, specified when registering the workflow type,
	// for executions of this workflow type. This default can be overridden when
	// starting a workflow execution using the StartWorkflowExecution action or
	// the StartChildWorkflowExecutionDecision.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	DefaultExecutionStartToCloseTimeout *string `locationName:"defaultExecutionStartToCloseTimeout" type:"string"`

	// The default IAM role attached to this workflow type.
	//
	// Executions of this workflow type need IAM roles to invoke Lambda functions.
	// If you don't specify an IAM role when starting this workflow type, the default
	// Lambda role is attached to the execution. For more information, see http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html
	// (http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html)
	// in the Amazon SWF Developer Guide.
	DefaultLambdaRole *string `locationName:"defaultLambdaRole" min:"1" type:"string"`

	// The default task list, specified when registering the workflow type, for
	// decisions tasks scheduled for workflow executions of this type. This default
	// can be overridden when starting a workflow execution using the StartWorkflowExecution
	// action or the StartChildWorkflowExecutionDecision.
	DefaultTaskList *TaskList `locationName:"defaultTaskList" type:"structure"`

	// The default task priority, specified when registering the workflow type,
	// for all decision tasks of this workflow type. This default can be overridden
	// when starting a workflow execution using the StartWorkflowExecution action
	// or the StartChildWorkflowExecution decision.
	//
	// Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648)
	// to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
	//
	// For more information about setting task priority, see Setting Task Priority
	// (http://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html)
	// in the Amazon SWF Developer Guide.
	DefaultTaskPriority *string `locationName:"defaultTaskPriority" type:"string"`

	// The default maximum duration, specified when registering the workflow type,
	// that a decision task for executions of this workflow type might take before
	// returning completion or failure. If the task doesn'tdo close in the specified
	// time then the task is automatically timed out and rescheduled. If the decider
	// eventually reports a completion or failure, it is ignored. This default can
	// be overridden when starting a workflow execution using the StartWorkflowExecution
	// action or the StartChildWorkflowExecutionDecision.
	//
	// The duration is specified in seconds, an integer greater than or equal to
	// 0. You can use NONE to specify unlimited duration.
	DefaultTaskStartToCloseTimeout *string `locationName:"defaultTaskStartToCloseTimeout" type:"string"`
	// contains filtered or unexported fields
}

The configuration settings of a workflow type.

func (WorkflowTypeConfiguration) GoString added in v0.6.5

func (s WorkflowTypeConfiguration) GoString() string

GoString returns the string representation

func (*WorkflowTypeConfiguration) SetDefaultChildPolicy added in v1.5.0

func (s *WorkflowTypeConfiguration) SetDefaultChildPolicy(v string) *WorkflowTypeConfiguration

SetDefaultChildPolicy sets the DefaultChildPolicy field's value.

func (*WorkflowTypeConfiguration) SetDefaultExecutionStartToCloseTimeout added in v1.5.0

func (s *WorkflowTypeConfiguration) SetDefaultExecutionStartToCloseTimeout(v string) *WorkflowTypeConfiguration

SetDefaultExecutionStartToCloseTimeout sets the DefaultExecutionStartToCloseTimeout field's value.

func (*WorkflowTypeConfiguration) SetDefaultLambdaRole added in v1.5.0

func (s *WorkflowTypeConfiguration) SetDefaultLambdaRole(v string) *WorkflowTypeConfiguration

SetDefaultLambdaRole sets the DefaultLambdaRole field's value.

func (*WorkflowTypeConfiguration) SetDefaultTaskList added in v1.5.0

SetDefaultTaskList sets the DefaultTaskList field's value.

func (*WorkflowTypeConfiguration) SetDefaultTaskPriority added in v1.5.0

func (s *WorkflowTypeConfiguration) SetDefaultTaskPriority(v string) *WorkflowTypeConfiguration

SetDefaultTaskPriority sets the DefaultTaskPriority field's value.

func (*WorkflowTypeConfiguration) SetDefaultTaskStartToCloseTimeout added in v1.5.0

func (s *WorkflowTypeConfiguration) SetDefaultTaskStartToCloseTimeout(v string) *WorkflowTypeConfiguration

SetDefaultTaskStartToCloseTimeout sets the DefaultTaskStartToCloseTimeout field's value.

func (WorkflowTypeConfiguration) String added in v0.6.5

func (s WorkflowTypeConfiguration) String() string

String returns the string representation

type WorkflowTypeFilter

type WorkflowTypeFilter struct {

	// Name of the workflow type.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// Version of the workflow type.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

Used to filter workflow execution query results by type. Each parameter, if specified, defines a rule that must be satisfied by each returned result.

func (WorkflowTypeFilter) GoString added in v0.6.5

func (s WorkflowTypeFilter) GoString() string

GoString returns the string representation

func (*WorkflowTypeFilter) SetName added in v1.5.0

SetName sets the Name field's value.

func (*WorkflowTypeFilter) SetVersion added in v1.5.0

func (s *WorkflowTypeFilter) SetVersion(v string) *WorkflowTypeFilter

SetVersion sets the Version field's value.

func (WorkflowTypeFilter) String added in v0.6.5

func (s WorkflowTypeFilter) String() string

String returns the string representation

func (*WorkflowTypeFilter) Validate added in v1.1.21

func (s *WorkflowTypeFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WorkflowTypeInfo

type WorkflowTypeInfo struct {

	// The date when this type was registered.
	//
	// CreationDate is a required field
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix" required:"true"`

	// If the type is in deprecated state, then it is set to the date when the type
	// was deprecated.
	DeprecationDate *time.Time `locationName:"deprecationDate" type:"timestamp" timestampFormat:"unix"`

	// The description of the type registered through RegisterWorkflowType.
	Description *string `locationName:"description" type:"string"`

	// The current status of the workflow type.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"RegistrationStatus"`

	// The workflow type this information is about.
	//
	// WorkflowType is a required field
	WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains information about a workflow type.

func (WorkflowTypeInfo) GoString added in v0.6.5

func (s WorkflowTypeInfo) GoString() string

GoString returns the string representation

func (*WorkflowTypeInfo) SetCreationDate added in v1.5.0

func (s *WorkflowTypeInfo) SetCreationDate(v time.Time) *WorkflowTypeInfo

SetCreationDate sets the CreationDate field's value.

func (*WorkflowTypeInfo) SetDeprecationDate added in v1.5.0

func (s *WorkflowTypeInfo) SetDeprecationDate(v time.Time) *WorkflowTypeInfo

SetDeprecationDate sets the DeprecationDate field's value.

func (*WorkflowTypeInfo) SetDescription added in v1.5.0

func (s *WorkflowTypeInfo) SetDescription(v string) *WorkflowTypeInfo

SetDescription sets the Description field's value.

func (*WorkflowTypeInfo) SetStatus added in v1.5.0

func (s *WorkflowTypeInfo) SetStatus(v string) *WorkflowTypeInfo

SetStatus sets the Status field's value.

func (*WorkflowTypeInfo) SetWorkflowType added in v1.5.0

func (s *WorkflowTypeInfo) SetWorkflowType(v *WorkflowType) *WorkflowTypeInfo

SetWorkflowType sets the WorkflowType field's value.

func (WorkflowTypeInfo) String added in v0.6.5

func (s WorkflowTypeInfo) String() string

String returns the string representation

Directories

Path Synopsis
Package swfiface provides an interface to enable mocking the Amazon Simple Workflow Service service client for testing your code.
Package swfiface provides an interface to enable mocking the Amazon Simple Workflow Service service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL