swf/aws.sdk.kotlin.services.swf

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

countClosedWorkflowExecutions

inline suspend fun SwfClient.countClosedWorkflowExecutions(crossinline block: CountClosedWorkflowExecutionsRequest.Builder.() -> Unit): CountClosedWorkflowExecutionsResponse

Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.

countOpenWorkflowExecutions

inline suspend fun SwfClient.countOpenWorkflowExecutions(crossinline block: CountOpenWorkflowExecutionsRequest.Builder.() -> Unit): CountOpenWorkflowExecutionsResponse

Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.

countPendingActivityTasks

inline suspend fun SwfClient.countPendingActivityTasks(crossinline block: CountPendingActivityTasksRequest.Builder.() -> Unit): CountPendingActivityTasksResponse

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.

countPendingDecisionTasks

inline suspend fun SwfClient.countPendingDecisionTasks(crossinline block: CountPendingDecisionTasksRequest.Builder.() -> Unit): CountPendingDecisionTasksResponse

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.

deleteActivityType

inline suspend fun SwfClient.deleteActivityType(crossinline block: DeleteActivityTypeRequest.Builder.() -> Unit): DeleteActivityTypeResponse

Deletes the specified activity type.

deleteWorkflowType

inline suspend fun SwfClient.deleteWorkflowType(crossinline block: DeleteWorkflowTypeRequest.Builder.() -> Unit): DeleteWorkflowTypeResponse

Deletes the specified workflow type.

deprecateActivityType

inline suspend fun SwfClient.deprecateActivityType(crossinline block: DeprecateActivityTypeRequest.Builder.() -> Unit): DeprecateActivityTypeResponse

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.

deprecateDomain

inline suspend fun SwfClient.deprecateDomain(crossinline block: DeprecateDomainRequest.Builder.() -> Unit): DeprecateDomainResponse

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.

deprecateWorkflowType

inline suspend fun SwfClient.deprecateWorkflowType(crossinline block: DeprecateWorkflowTypeRequest.Builder.() -> Unit): DeprecateWorkflowTypeResponse

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.

describeActivityType

inline suspend fun SwfClient.describeActivityType(crossinline block: DescribeActivityTypeRequest.Builder.() -> Unit): DescribeActivityTypeResponse

Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.

describeDomain

inline suspend fun SwfClient.describeDomain(crossinline block: DescribeDomainRequest.Builder.() -> Unit): DescribeDomainResponse

Returns information about the specified domain, including description and status.

describeWorkflowExecution

inline suspend fun SwfClient.describeWorkflowExecution(crossinline block: DescribeWorkflowExecutionRequest.Builder.() -> Unit): DescribeWorkflowExecutionResponse

Returns information about the specified workflow execution including its type and some statistics.

describeWorkflowType

inline suspend fun SwfClient.describeWorkflowType(crossinline block: DescribeWorkflowTypeRequest.Builder.() -> Unit): DescribeWorkflowTypeResponse

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.

getWorkflowExecutionHistory

inline suspend fun SwfClient.getWorkflowExecutionHistory(crossinline block: GetWorkflowExecutionHistoryRequest.Builder.() -> Unit): GetWorkflowExecutionHistoryResponse

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.

listActivityTypes

inline suspend fun SwfClient.listActivityTypes(crossinline block: ListActivityTypesRequest.Builder.() -> Unit): ListActivityTypesResponse

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.

listClosedWorkflowExecutions

inline suspend fun SwfClient.listClosedWorkflowExecutions(crossinline block: ListClosedWorkflowExecutionsRequest.Builder.() -> Unit): ListClosedWorkflowExecutionsResponse

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.

listDomains

inline suspend fun SwfClient.listDomains(crossinline block: ListDomainsRequest.Builder.() -> Unit): ListDomainsResponse

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.

listOpenWorkflowExecutions

inline suspend fun SwfClient.listOpenWorkflowExecutions(crossinline block: ListOpenWorkflowExecutionsRequest.Builder.() -> Unit): ListOpenWorkflowExecutionsResponse

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.

listTagsForResource

inline suspend fun SwfClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

List tags for a given domain.

listWorkflowTypes

inline suspend fun SwfClient.listWorkflowTypes(crossinline block: ListWorkflowTypesRequest.Builder.() -> Unit): ListWorkflowTypesResponse

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.

pollForActivityTask

inline suspend fun SwfClient.pollForActivityTask(crossinline block: PollForActivityTaskRequest.Builder.() -> Unit): PollForActivityTaskResponse

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.

pollForDecisionTask

inline suspend fun SwfClient.pollForDecisionTask(crossinline block: PollForDecisionTaskRequest.Builder.() -> Unit): PollForDecisionTaskResponse

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.

recordActivityTaskHeartbeat

inline suspend fun SwfClient.recordActivityTaskHeartbeat(crossinline block: RecordActivityTaskHeartbeatRequest.Builder.() -> Unit): RecordActivityTaskHeartbeatResponse

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.

registerActivityType

inline suspend fun SwfClient.registerActivityType(crossinline block: RegisterActivityTypeRequest.Builder.() -> Unit): RegisterActivityTypeResponse

Registers a new activity type along with its configuration settings in the specified domain.

registerDomain

inline suspend fun SwfClient.registerDomain(crossinline block: RegisterDomainRequest.Builder.() -> Unit): RegisterDomainResponse

Registers a new domain.

registerWorkflowType

inline suspend fun SwfClient.registerWorkflowType(crossinline block: RegisterWorkflowTypeRequest.Builder.() -> Unit): RegisterWorkflowTypeResponse

Registers a new workflow type and its configuration settings in the specified domain.

requestCancelWorkflowExecution

inline suspend fun SwfClient.requestCancelWorkflowExecution(crossinline block: RequestCancelWorkflowExecutionRequest.Builder.() -> Unit): RequestCancelWorkflowExecutionResponse

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.

respondActivityTaskCanceled

inline suspend fun SwfClient.respondActivityTaskCanceled(crossinline block: RespondActivityTaskCanceledRequest.Builder.() -> Unit): RespondActivityTaskCanceledResponse

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.

respondActivityTaskCompleted

inline suspend fun SwfClient.respondActivityTaskCompleted(crossinline block: RespondActivityTaskCompletedRequest.Builder.() -> Unit): RespondActivityTaskCompletedResponse

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.

respondActivityTaskFailed

inline suspend fun SwfClient.respondActivityTaskFailed(crossinline block: RespondActivityTaskFailedRequest.Builder.() -> Unit): RespondActivityTaskFailedResponse

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.

respondDecisionTaskCompleted

inline suspend fun SwfClient.respondDecisionTaskCompleted(crossinline block: RespondDecisionTaskCompletedRequest.Builder.() -> Unit): RespondDecisionTaskCompletedResponse

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.

signalWorkflowExecution

inline suspend fun SwfClient.signalWorkflowExecution(crossinline block: SignalWorkflowExecutionRequest.Builder.() -> Unit): SignalWorkflowExecutionResponse

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

startWorkflowExecution

inline suspend fun SwfClient.startWorkflowExecution(crossinline block: StartWorkflowExecutionRequest.Builder.() -> Unit): StartWorkflowExecutionResponse

Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.

tagResource

inline suspend fun SwfClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Add a tag to a Amazon SWF domain.

terminateWorkflowExecution

inline suspend fun SwfClient.terminateWorkflowExecution(crossinline block: TerminateWorkflowExecutionRequest.Builder.() -> Unit): TerminateWorkflowExecutionResponse

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.

undeprecateActivityType

inline suspend fun SwfClient.undeprecateActivityType(crossinline block: UndeprecateActivityTypeRequest.Builder.() -> Unit): UndeprecateActivityTypeResponse

Undeprecates a previously deprecated activity type. After an activity type has been undeprecated, you can create new tasks of that activity type.

undeprecateDomain

inline suspend fun SwfClient.undeprecateDomain(crossinline block: UndeprecateDomainRequest.Builder.() -> Unit): UndeprecateDomainResponse

Undeprecates a previously deprecated domain. After a domain has been undeprecated it can be used to create new workflow executions or register new types.

undeprecateWorkflowType

inline suspend fun SwfClient.undeprecateWorkflowType(crossinline block: UndeprecateWorkflowTypeRequest.Builder.() -> Unit): UndeprecateWorkflowTypeResponse

Undeprecates a previously deprecated workflow type. After a workflow type has been undeprecated, you can create new executions of that type.

untagResource

inline suspend fun SwfClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Remove a tag from a Amazon SWF domain.

withConfig

fun SwfClient.withConfig(block: SwfClient.Config.Builder.() -> Unit): SwfClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.