@Generated(value="software.amazon.awssdk:codegen") public interface SwfAsyncClient extends SdkClient
builder()
method.
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 .
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static SwfAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
SwfAsyncClient . |
default CompletableFuture<CountClosedWorkflowExecutionsResponse> |
countClosedWorkflowExecutions(Consumer<CountClosedWorkflowExecutionsRequest.Builder> countClosedWorkflowExecutionsRequest)
Returns the number of closed workflow executions within the given domain that meet the specified filtering
criteria.
|
default CompletableFuture<CountClosedWorkflowExecutionsResponse> |
countClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest)
Returns the number of closed workflow executions within the given domain that meet the specified filtering
criteria.
|
default CompletableFuture<CountOpenWorkflowExecutionsResponse> |
countOpenWorkflowExecutions(Consumer<CountOpenWorkflowExecutionsRequest.Builder> countOpenWorkflowExecutionsRequest)
Returns the number of open workflow executions within the given domain that meet the specified filtering
criteria.
|
default CompletableFuture<CountOpenWorkflowExecutionsResponse> |
countOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest)
Returns the number of open workflow executions within the given domain that meet the specified filtering
criteria.
|
default CompletableFuture<CountPendingActivityTasksResponse> |
countPendingActivityTasks(Consumer<CountPendingActivityTasksRequest.Builder> countPendingActivityTasksRequest)
Returns the estimated number of activity tasks in the specified task list.
|
default CompletableFuture<CountPendingActivityTasksResponse> |
countPendingActivityTasks(CountPendingActivityTasksRequest countPendingActivityTasksRequest)
Returns the estimated number of activity tasks in the specified task list.
|
default CompletableFuture<CountPendingDecisionTasksResponse> |
countPendingDecisionTasks(Consumer<CountPendingDecisionTasksRequest.Builder> countPendingDecisionTasksRequest)
Returns the estimated number of decision tasks in the specified task list.
|
default CompletableFuture<CountPendingDecisionTasksResponse> |
countPendingDecisionTasks(CountPendingDecisionTasksRequest countPendingDecisionTasksRequest)
Returns the estimated number of decision tasks in the specified task list.
|
static SwfAsyncClient |
create()
Create a
SwfAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<DeprecateActivityTypeResponse> |
deprecateActivityType(Consumer<DeprecateActivityTypeRequest.Builder> deprecateActivityTypeRequest)
Deprecates the specified activity type.
|
default CompletableFuture<DeprecateActivityTypeResponse> |
deprecateActivityType(DeprecateActivityTypeRequest deprecateActivityTypeRequest)
Deprecates the specified activity type.
|
default CompletableFuture<DeprecateDomainResponse> |
deprecateDomain(Consumer<DeprecateDomainRequest.Builder> deprecateDomainRequest)
Deprecates the specified domain.
|
default CompletableFuture<DeprecateDomainResponse> |
deprecateDomain(DeprecateDomainRequest deprecateDomainRequest)
Deprecates the specified domain.
|
default CompletableFuture<DeprecateWorkflowTypeResponse> |
deprecateWorkflowType(Consumer<DeprecateWorkflowTypeRequest.Builder> deprecateWorkflowTypeRequest)
Deprecates the specified workflow type.
|
default CompletableFuture<DeprecateWorkflowTypeResponse> |
deprecateWorkflowType(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest)
Deprecates the specified workflow type.
|
default CompletableFuture<DescribeActivityTypeResponse> |
describeActivityType(Consumer<DescribeActivityTypeRequest.Builder> describeActivityTypeRequest)
Returns information about the specified activity type.
|
default CompletableFuture<DescribeActivityTypeResponse> |
describeActivityType(DescribeActivityTypeRequest describeActivityTypeRequest)
Returns information about the specified activity type.
|
default CompletableFuture<DescribeDomainResponse> |
describeDomain(Consumer<DescribeDomainRequest.Builder> describeDomainRequest)
Returns information about the specified domain, including description and status.
|
default CompletableFuture<DescribeDomainResponse> |
describeDomain(DescribeDomainRequest describeDomainRequest)
Returns information about the specified domain, including description and status.
|
default CompletableFuture<DescribeWorkflowExecutionResponse> |
describeWorkflowExecution(Consumer<DescribeWorkflowExecutionRequest.Builder> describeWorkflowExecutionRequest)
Returns information about the specified workflow execution including its type and some statistics.
|
default CompletableFuture<DescribeWorkflowExecutionResponse> |
describeWorkflowExecution(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest)
Returns information about the specified workflow execution including its type and some statistics.
|
default CompletableFuture<DescribeWorkflowTypeResponse> |
describeWorkflowType(Consumer<DescribeWorkflowTypeRequest.Builder> describeWorkflowTypeRequest)
Returns information about the specified workflow type.
|
default CompletableFuture<DescribeWorkflowTypeResponse> |
describeWorkflowType(DescribeWorkflowTypeRequest describeWorkflowTypeRequest)
Returns information about the specified workflow type.
|
default CompletableFuture<GetWorkflowExecutionHistoryResponse> |
getWorkflowExecutionHistory(Consumer<GetWorkflowExecutionHistoryRequest.Builder> getWorkflowExecutionHistoryRequest)
Returns the history of the specified workflow execution.
|
default CompletableFuture<GetWorkflowExecutionHistoryResponse> |
getWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest)
Returns the history of the specified workflow execution.
|
default GetWorkflowExecutionHistoryPublisher |
getWorkflowExecutionHistoryPaginator(Consumer<GetWorkflowExecutionHistoryRequest.Builder> getWorkflowExecutionHistoryRequest)
Returns the history of the specified workflow execution.
|
default GetWorkflowExecutionHistoryPublisher |
getWorkflowExecutionHistoryPaginator(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest)
Returns the history of the specified workflow execution.
|
default CompletableFuture<ListActivityTypesResponse> |
listActivityTypes(Consumer<ListActivityTypesRequest.Builder> listActivityTypesRequest)
Returns information about all activities registered in the specified domain that match the specified name and
registration status.
|
default CompletableFuture<ListActivityTypesResponse> |
listActivityTypes(ListActivityTypesRequest listActivityTypesRequest)
Returns information about all activities registered in the specified domain that match the specified name and
registration status.
|
default ListActivityTypesPublisher |
listActivityTypesPaginator(Consumer<ListActivityTypesRequest.Builder> listActivityTypesRequest)
Returns information about all activities registered in the specified domain that match the specified name and
registration status.
|
default ListActivityTypesPublisher |
listActivityTypesPaginator(ListActivityTypesRequest listActivityTypesRequest)
Returns information about all activities registered in the specified domain that match the specified name and
registration status.
|
default CompletableFuture<ListClosedWorkflowExecutionsResponse> |
listClosedWorkflowExecutions(Consumer<ListClosedWorkflowExecutionsRequest.Builder> listClosedWorkflowExecutionsRequest)
Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.
|
default CompletableFuture<ListClosedWorkflowExecutionsResponse> |
listClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest)
Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.
|
default ListClosedWorkflowExecutionsPublisher |
listClosedWorkflowExecutionsPaginator(Consumer<ListClosedWorkflowExecutionsRequest.Builder> listClosedWorkflowExecutionsRequest)
Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.
|
default ListClosedWorkflowExecutionsPublisher |
listClosedWorkflowExecutionsPaginator(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest)
Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.
|
default CompletableFuture<ListDomainsResponse> |
listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)
Returns the list of domains registered in the account.
|
default CompletableFuture<ListDomainsResponse> |
listDomains(ListDomainsRequest listDomainsRequest)
Returns the list of domains registered in the account.
|
default ListDomainsPublisher |
listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest)
Returns the list of domains registered in the account.
|
default ListDomainsPublisher |
listDomainsPaginator(ListDomainsRequest listDomainsRequest)
Returns the list of domains registered in the account.
|
default CompletableFuture<ListOpenWorkflowExecutionsResponse> |
listOpenWorkflowExecutions(Consumer<ListOpenWorkflowExecutionsRequest.Builder> listOpenWorkflowExecutionsRequest)
Returns a list of open workflow executions in the specified domain that meet the filtering criteria.
|
default CompletableFuture<ListOpenWorkflowExecutionsResponse> |
listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest)
Returns a list of open workflow executions in the specified domain that meet the filtering criteria.
|
default ListOpenWorkflowExecutionsPublisher |
listOpenWorkflowExecutionsPaginator(Consumer<ListOpenWorkflowExecutionsRequest.Builder> listOpenWorkflowExecutionsRequest)
Returns a list of open workflow executions in the specified domain that meet the filtering criteria.
|
default ListOpenWorkflowExecutionsPublisher |
listOpenWorkflowExecutionsPaginator(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest)
Returns a list of open workflow executions in the specified domain that meet the filtering criteria.
|
default CompletableFuture<ListWorkflowTypesResponse> |
listWorkflowTypes(Consumer<ListWorkflowTypesRequest.Builder> listWorkflowTypesRequest)
Returns information about workflow types in the specified domain.
|
default CompletableFuture<ListWorkflowTypesResponse> |
listWorkflowTypes(ListWorkflowTypesRequest listWorkflowTypesRequest)
Returns information about workflow types in the specified domain.
|
default ListWorkflowTypesPublisher |
listWorkflowTypesPaginator(Consumer<ListWorkflowTypesRequest.Builder> listWorkflowTypesRequest)
Returns information about workflow types in the specified domain.
|
default ListWorkflowTypesPublisher |
listWorkflowTypesPaginator(ListWorkflowTypesRequest listWorkflowTypesRequest)
Returns information about workflow types in the specified domain.
|
default CompletableFuture<PollForActivityTaskResponse> |
pollForActivityTask(Consumer<PollForActivityTaskRequest.Builder> pollForActivityTaskRequest)
Used by workers to get an ActivityTask from the specified activity
taskList . |
default CompletableFuture<PollForActivityTaskResponse> |
pollForActivityTask(PollForActivityTaskRequest pollForActivityTaskRequest)
Used by workers to get an ActivityTask from the specified activity
taskList . |
default CompletableFuture<PollForDecisionTaskResponse> |
pollForDecisionTask(Consumer<PollForDecisionTaskRequest.Builder> pollForDecisionTaskRequest)
Used by deciders to get a DecisionTask from the specified decision
taskList . |
default CompletableFuture<PollForDecisionTaskResponse> |
pollForDecisionTask(PollForDecisionTaskRequest pollForDecisionTaskRequest)
Used by deciders to get a DecisionTask from the specified decision
taskList . |
default PollForDecisionTaskPublisher |
pollForDecisionTaskPaginator(Consumer<PollForDecisionTaskRequest.Builder> pollForDecisionTaskRequest)
Used by deciders to get a DecisionTask from the specified decision
taskList . |
default PollForDecisionTaskPublisher |
pollForDecisionTaskPaginator(PollForDecisionTaskRequest pollForDecisionTaskRequest)
Used by deciders to get a DecisionTask from the specified decision
taskList . |
default CompletableFuture<RecordActivityTaskHeartbeatResponse> |
recordActivityTaskHeartbeat(Consumer<RecordActivityTaskHeartbeatRequest.Builder> recordActivityTaskHeartbeatRequest)
Used by activity workers to report to the service that the ActivityTask represented by the specified
taskToken is still making progress. |
default CompletableFuture<RecordActivityTaskHeartbeatResponse> |
recordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest recordActivityTaskHeartbeatRequest)
Used by activity workers to report to the service that the ActivityTask represented by the specified
taskToken is still making progress. |
default CompletableFuture<RegisterActivityTypeResponse> |
registerActivityType(Consumer<RegisterActivityTypeRequest.Builder> registerActivityTypeRequest)
Registers a new activity type along with its configuration settings in the specified domain.
|
default CompletableFuture<RegisterActivityTypeResponse> |
registerActivityType(RegisterActivityTypeRequest registerActivityTypeRequest)
Registers a new activity type along with its configuration settings in the specified domain.
|
default CompletableFuture<RegisterDomainResponse> |
registerDomain(Consumer<RegisterDomainRequest.Builder> registerDomainRequest)
Registers a new domain.
|
default CompletableFuture<RegisterDomainResponse> |
registerDomain(RegisterDomainRequest registerDomainRequest)
Registers a new domain.
|
default CompletableFuture<RegisterWorkflowTypeResponse> |
registerWorkflowType(Consumer<RegisterWorkflowTypeRequest.Builder> registerWorkflowTypeRequest)
Registers a new workflow type and its configuration settings in the specified domain.
|
default CompletableFuture<RegisterWorkflowTypeResponse> |
registerWorkflowType(RegisterWorkflowTypeRequest registerWorkflowTypeRequest)
Registers a new workflow type and its configuration settings in the specified domain.
|
default CompletableFuture<RequestCancelWorkflowExecutionResponse> |
requestCancelWorkflowExecution(Consumer<RequestCancelWorkflowExecutionRequest.Builder> requestCancelWorkflowExecutionRequest)
Records a
WorkflowExecutionCancelRequested event in the currently running workflow execution
identified by the given domain, workflowId, and runId. |
default CompletableFuture<RequestCancelWorkflowExecutionResponse> |
requestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest)
Records a
WorkflowExecutionCancelRequested event in the currently running workflow execution
identified by the given domain, workflowId, and runId. |
default CompletableFuture<RespondActivityTaskCanceledResponse> |
respondActivityTaskCanceled(Consumer<RespondActivityTaskCanceledRequest.Builder> respondActivityTaskCanceledRequest)
Used by workers to tell the service that the ActivityTask identified by the
taskToken was
successfully canceled. |
default CompletableFuture<RespondActivityTaskCanceledResponse> |
respondActivityTaskCanceled(RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest)
Used by workers to tell the service that the ActivityTask identified by the
taskToken was
successfully canceled. |
default CompletableFuture<RespondActivityTaskCompletedResponse> |
respondActivityTaskCompleted(Consumer<RespondActivityTaskCompletedRequest.Builder> respondActivityTaskCompletedRequest)
Used by workers to tell the service that the ActivityTask identified by the
taskToken
completed successfully with a result (if provided). |
default CompletableFuture<RespondActivityTaskCompletedResponse> |
respondActivityTaskCompleted(RespondActivityTaskCompletedRequest respondActivityTaskCompletedRequest)
Used by workers to tell the service that the ActivityTask identified by the
taskToken
completed successfully with a result (if provided). |
default CompletableFuture<RespondActivityTaskFailedResponse> |
respondActivityTaskFailed(Consumer<RespondActivityTaskFailedRequest.Builder> respondActivityTaskFailedRequest)
Used by workers to tell the service that the ActivityTask identified by the
taskToken has
failed with reason (if specified). |
default CompletableFuture<RespondActivityTaskFailedResponse> |
respondActivityTaskFailed(RespondActivityTaskFailedRequest respondActivityTaskFailedRequest)
Used by workers to tell the service that the ActivityTask identified by the
taskToken has
failed with reason (if specified). |
default CompletableFuture<RespondDecisionTaskCompletedResponse> |
respondDecisionTaskCompleted(Consumer<RespondDecisionTaskCompletedRequest.Builder> respondDecisionTaskCompletedRequest)
Used by deciders to tell the service that the DecisionTask identified by the
taskToken has
successfully completed. |
default CompletableFuture<RespondDecisionTaskCompletedResponse> |
respondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest)
Used by deciders to tell the service that the DecisionTask identified by the
taskToken has
successfully completed. |
default CompletableFuture<SignalWorkflowExecutionResponse> |
signalWorkflowExecution(Consumer<SignalWorkflowExecutionRequest.Builder> signalWorkflowExecutionRequest)
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. |
default CompletableFuture<SignalWorkflowExecutionResponse> |
signalWorkflowExecution(SignalWorkflowExecutionRequest signalWorkflowExecutionRequest)
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. |
default CompletableFuture<StartWorkflowExecutionResponse> |
startWorkflowExecution(Consumer<StartWorkflowExecutionRequest.Builder> startWorkflowExecutionRequest)
Starts an execution of the workflow type in the specified domain using the provided
workflowId and
input data. |
default CompletableFuture<StartWorkflowExecutionResponse> |
startWorkflowExecution(StartWorkflowExecutionRequest startWorkflowExecutionRequest)
Starts an execution of the workflow type in the specified domain using the provided
workflowId and
input data. |
default CompletableFuture<TerminateWorkflowExecutionResponse> |
terminateWorkflowExecution(Consumer<TerminateWorkflowExecutionRequest.Builder> terminateWorkflowExecutionRequest)
Records a
WorkflowExecutionTerminated event and forces closure of the workflow execution identified
by the given domain, runId, and workflowId. |
default CompletableFuture<TerminateWorkflowExecutionResponse> |
terminateWorkflowExecution(TerminateWorkflowExecutionRequest terminateWorkflowExecutionRequest)
Records a
WorkflowExecutionTerminated event and forces closure of the workflow execution identified
by the given domain, runId, and workflowId. |
serviceName
close
static final String SERVICE_NAME
static SwfAsyncClient create()
SwfAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static SwfAsyncClientBuilder builder()
SwfAsyncClient
.default CompletableFuture<CountClosedWorkflowExecutionsResponse> countClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest)
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 in the Amazon SWF Developer Guide.
countClosedWorkflowExecutionsRequest
- default CompletableFuture<CountClosedWorkflowExecutionsResponse> countClosedWorkflowExecutions(Consumer<CountClosedWorkflowExecutionsRequest.Builder> countClosedWorkflowExecutionsRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the CountClosedWorkflowExecutionsRequest.Builder
avoiding the need to create one manually via CountClosedWorkflowExecutionsRequest.builder()
countClosedWorkflowExecutionsRequest
- A Consumer
that will call methods on CountClosedWorkflowExecutionsInput.Builder
to create
a request.default CompletableFuture<CountOpenWorkflowExecutionsResponse> countOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest)
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 in the Amazon SWF Developer Guide.
countOpenWorkflowExecutionsRequest
- default CompletableFuture<CountOpenWorkflowExecutionsResponse> countOpenWorkflowExecutions(Consumer<CountOpenWorkflowExecutionsRequest.Builder> countOpenWorkflowExecutionsRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the CountOpenWorkflowExecutionsRequest.Builder
avoiding the need to create one manually via CountOpenWorkflowExecutionsRequest.builder()
countOpenWorkflowExecutionsRequest
- A Consumer
that will call methods on CountOpenWorkflowExecutionsInput.Builder
to create a
request.default CompletableFuture<CountPendingActivityTasksResponse> countPendingActivityTasks(CountPendingActivityTasksRequest countPendingActivityTasksRequest)
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 in the Amazon SWF Developer Guide.
countPendingActivityTasksRequest
- default CompletableFuture<CountPendingActivityTasksResponse> countPendingActivityTasks(Consumer<CountPendingActivityTasksRequest.Builder> countPendingActivityTasksRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the CountPendingActivityTasksRequest.Builder
avoiding
the need to create one manually via CountPendingActivityTasksRequest.builder()
countPendingActivityTasksRequest
- A Consumer
that will call methods on CountPendingActivityTasksInput.Builder
to create a
request.default CompletableFuture<CountPendingDecisionTasksResponse> countPendingDecisionTasks(CountPendingDecisionTasksRequest countPendingDecisionTasksRequest)
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 in the Amazon SWF Developer Guide.
countPendingDecisionTasksRequest
- default CompletableFuture<CountPendingDecisionTasksResponse> countPendingDecisionTasks(Consumer<CountPendingDecisionTasksRequest.Builder> countPendingDecisionTasksRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the CountPendingDecisionTasksRequest.Builder
avoiding
the need to create one manually via CountPendingDecisionTasksRequest.builder()
countPendingDecisionTasksRequest
- A Consumer
that will call methods on CountPendingDecisionTasksInput.Builder
to create a
request.default CompletableFuture<DeprecateActivityTypeResponse> deprecateActivityType(DeprecateActivityTypeRequest deprecateActivityTypeRequest)
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 in the Amazon SWF Developer Guide.
deprecateActivityTypeRequest
- default CompletableFuture<DeprecateActivityTypeResponse> deprecateActivityType(Consumer<DeprecateActivityTypeRequest.Builder> deprecateActivityTypeRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the DeprecateActivityTypeRequest.Builder
avoiding the
need to create one manually via DeprecateActivityTypeRequest.builder()
deprecateActivityTypeRequest
- A Consumer
that will call methods on DeprecateActivityTypeInput.Builder
to create a
request.default CompletableFuture<DeprecateDomainResponse> deprecateDomain(DeprecateDomainRequest deprecateDomainRequest)
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 in the Amazon SWF Developer Guide.
deprecateDomainRequest
- default CompletableFuture<DeprecateDomainResponse> deprecateDomain(Consumer<DeprecateDomainRequest.Builder> deprecateDomainRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the DeprecateDomainRequest.Builder
avoiding the need
to create one manually via DeprecateDomainRequest.builder()
deprecateDomainRequest
- A Consumer
that will call methods on DeprecateDomainInput.Builder
to create a request.default CompletableFuture<DeprecateWorkflowTypeResponse> deprecateWorkflowType(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest)
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 in the Amazon SWF Developer Guide.
deprecateWorkflowTypeRequest
- default CompletableFuture<DeprecateWorkflowTypeResponse> deprecateWorkflowType(Consumer<DeprecateWorkflowTypeRequest.Builder> deprecateWorkflowTypeRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the DeprecateWorkflowTypeRequest.Builder
avoiding the
need to create one manually via DeprecateWorkflowTypeRequest.builder()
deprecateWorkflowTypeRequest
- A Consumer
that will call methods on DeprecateWorkflowTypeInput.Builder
to create a
request.default CompletableFuture<DescribeActivityTypeResponse> describeActivityType(DescribeActivityTypeRequest describeActivityTypeRequest)
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 in the Amazon SWF Developer Guide.
describeActivityTypeRequest
- default CompletableFuture<DescribeActivityTypeResponse> describeActivityType(Consumer<DescribeActivityTypeRequest.Builder> describeActivityTypeRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the DescribeActivityTypeRequest.Builder
avoiding the
need to create one manually via DescribeActivityTypeRequest.builder()
describeActivityTypeRequest
- A Consumer
that will call methods on DescribeActivityTypeInput.Builder
to create a
request.default CompletableFuture<DescribeDomainResponse> describeDomain(DescribeDomainRequest describeDomainRequest)
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 in the Amazon SWF Developer Guide.
describeDomainRequest
- default CompletableFuture<DescribeDomainResponse> describeDomain(Consumer<DescribeDomainRequest.Builder> describeDomainRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the DescribeDomainRequest.Builder
avoiding the need to
create one manually via DescribeDomainRequest.builder()
describeDomainRequest
- A Consumer
that will call methods on DescribeDomainInput.Builder
to create a request.default CompletableFuture<DescribeWorkflowExecutionResponse> describeWorkflowExecution(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest)
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 in the Amazon SWF Developer Guide.
describeWorkflowExecutionRequest
- default CompletableFuture<DescribeWorkflowExecutionResponse> describeWorkflowExecution(Consumer<DescribeWorkflowExecutionRequest.Builder> describeWorkflowExecutionRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the DescribeWorkflowExecutionRequest.Builder
avoiding
the need to create one manually via DescribeWorkflowExecutionRequest.builder()
describeWorkflowExecutionRequest
- A Consumer
that will call methods on DescribeWorkflowExecutionInput.Builder
to create a
request.default CompletableFuture<DescribeWorkflowTypeResponse> describeWorkflowType(DescribeWorkflowTypeRequest describeWorkflowTypeRequest)
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 in the Amazon SWF Developer Guide.
describeWorkflowTypeRequest
- default CompletableFuture<DescribeWorkflowTypeResponse> describeWorkflowType(Consumer<DescribeWorkflowTypeRequest.Builder> describeWorkflowTypeRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the DescribeWorkflowTypeRequest.Builder
avoiding the
need to create one manually via DescribeWorkflowTypeRequest.builder()
describeWorkflowTypeRequest
- A Consumer
that will call methods on DescribeWorkflowTypeInput.Builder
to create a
request.default CompletableFuture<GetWorkflowExecutionHistoryResponse> getWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest)
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 in the Amazon SWF Developer Guide.
getWorkflowExecutionHistoryRequest
- default CompletableFuture<GetWorkflowExecutionHistoryResponse> getWorkflowExecutionHistory(Consumer<GetWorkflowExecutionHistoryRequest.Builder> getWorkflowExecutionHistoryRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the GetWorkflowExecutionHistoryRequest.Builder
avoiding the need to create one manually via GetWorkflowExecutionHistoryRequest.builder()
getWorkflowExecutionHistoryRequest
- A Consumer
that will call methods on GetWorkflowExecutionHistoryInput.Builder
to create a
request.default GetWorkflowExecutionHistoryPublisher getWorkflowExecutionHistoryPaginator(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest)
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 in the Amazon SWF Developer Guide.
This is a variant of
getWorkflowExecutionHistory(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryPublisher publisher = client.getWorkflowExecutionHistoryPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryPublisher publisher = client.getWorkflowExecutionHistoryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getWorkflowExecutionHistory(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest)
operation.
getWorkflowExecutionHistoryRequest
- default GetWorkflowExecutionHistoryPublisher getWorkflowExecutionHistoryPaginator(Consumer<GetWorkflowExecutionHistoryRequest.Builder> getWorkflowExecutionHistoryRequest)
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 in the Amazon SWF Developer Guide.
This is a variant of
getWorkflowExecutionHistory(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryPublisher publisher = client.getWorkflowExecutionHistoryPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryPublisher publisher = client.getWorkflowExecutionHistoryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getWorkflowExecutionHistory(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest)
operation.
This is a convenience which creates an instance of the GetWorkflowExecutionHistoryRequest.Builder
avoiding the need to create one manually via GetWorkflowExecutionHistoryRequest.builder()
getWorkflowExecutionHistoryRequest
- A Consumer
that will call methods on GetWorkflowExecutionHistoryInput.Builder
to create a
request.default CompletableFuture<ListActivityTypesResponse> listActivityTypes(ListActivityTypesRequest listActivityTypesRequest)
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 in the Amazon SWF Developer Guide.
listActivityTypesRequest
- default CompletableFuture<ListActivityTypesResponse> listActivityTypes(Consumer<ListActivityTypesRequest.Builder> listActivityTypesRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the ListActivityTypesRequest.Builder
avoiding the need
to create one manually via ListActivityTypesRequest.builder()
listActivityTypesRequest
- A Consumer
that will call methods on ListActivityTypesInput.Builder
to create a request.default ListActivityTypesPublisher listActivityTypesPaginator(ListActivityTypesRequest listActivityTypesRequest)
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 in the Amazon SWF Developer Guide.
This is a variant of
listActivityTypes(software.amazon.awssdk.services.swf.model.ListActivityTypesRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.swf.paginators.ListActivityTypesPublisher publisher = client.listActivityTypesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.swf.paginators.ListActivityTypesPublisher publisher = client.listActivityTypesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListActivityTypesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.swf.model.ListActivityTypesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listActivityTypes(software.amazon.awssdk.services.swf.model.ListActivityTypesRequest)
operation.
listActivityTypesRequest
- default ListActivityTypesPublisher listActivityTypesPaginator(Consumer<ListActivityTypesRequest.Builder> listActivityTypesRequest)
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 in the Amazon SWF Developer Guide.
This is a variant of
listActivityTypes(software.amazon.awssdk.services.swf.model.ListActivityTypesRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.swf.paginators.ListActivityTypesPublisher publisher = client.listActivityTypesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.swf.paginators.ListActivityTypesPublisher publisher = client.listActivityTypesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListActivityTypesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.swf.model.ListActivityTypesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listActivityTypes(software.amazon.awssdk.services.swf.model.ListActivityTypesRequest)
operation.
This is a convenience which creates an instance of the ListActivityTypesRequest.Builder
avoiding the need
to create one manually via ListActivityTypesRequest.builder()
listActivityTypesRequest
- A Consumer
that will call methods on ListActivityTypesInput.Builder
to create a request.default CompletableFuture<ListClosedWorkflowExecutionsResponse> listClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest)
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 in the Amazon SWF Developer Guide.
listClosedWorkflowExecutionsRequest
- default CompletableFuture<ListClosedWorkflowExecutionsResponse> listClosedWorkflowExecutions(Consumer<ListClosedWorkflowExecutionsRequest.Builder> listClosedWorkflowExecutionsRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the ListClosedWorkflowExecutionsRequest.Builder
avoiding the need to create one manually via ListClosedWorkflowExecutionsRequest.builder()
listClosedWorkflowExecutionsRequest
- A Consumer
that will call methods on ListClosedWorkflowExecutionsInput.Builder
to create a
request.default ListClosedWorkflowExecutionsPublisher listClosedWorkflowExecutionsPaginator(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest)
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 in the Amazon SWF Developer Guide.
This is a variant of
listClosedWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsPublisher publisher = client.listClosedWorkflowExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsPublisher publisher = client.listClosedWorkflowExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listClosedWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest)
operation.
listClosedWorkflowExecutionsRequest
- default ListClosedWorkflowExecutionsPublisher listClosedWorkflowExecutionsPaginator(Consumer<ListClosedWorkflowExecutionsRequest.Builder> listClosedWorkflowExecutionsRequest)
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 in the Amazon SWF Developer Guide.
This is a variant of
listClosedWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsPublisher publisher = client.listClosedWorkflowExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsPublisher publisher = client.listClosedWorkflowExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listClosedWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest)
operation.
This is a convenience which creates an instance of the ListClosedWorkflowExecutionsRequest.Builder
avoiding the need to create one manually via ListClosedWorkflowExecutionsRequest.builder()
listClosedWorkflowExecutionsRequest
- A Consumer
that will call methods on ListClosedWorkflowExecutionsInput.Builder
to create a
request.default CompletableFuture<ListDomainsResponse> listDomains(ListDomainsRequest listDomainsRequest)
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 in the Amazon SWF Developer Guide.
listDomainsRequest
- default CompletableFuture<ListDomainsResponse> listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the ListDomainsRequest.Builder
avoiding the need to
create one manually via ListDomainsRequest.builder()
listDomainsRequest
- A Consumer
that will call methods on ListDomainsInput.Builder
to create a request.default ListDomainsPublisher listDomainsPaginator(ListDomainsRequest listDomainsRequest)
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 in the Amazon SWF Developer Guide.
This is a variant of listDomains(software.amazon.awssdk.services.swf.model.ListDomainsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.swf.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.swf.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListDomainsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.swf.model.ListDomainsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listDomains(software.amazon.awssdk.services.swf.model.ListDomainsRequest)
operation.
listDomainsRequest
- default ListDomainsPublisher listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest)
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 in the Amazon SWF Developer Guide.
This is a variant of listDomains(software.amazon.awssdk.services.swf.model.ListDomainsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.swf.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.swf.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListDomainsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.swf.model.ListDomainsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listDomains(software.amazon.awssdk.services.swf.model.ListDomainsRequest)
operation.
This is a convenience which creates an instance of the ListDomainsRequest.Builder
avoiding the need to
create one manually via ListDomainsRequest.builder()
listDomainsRequest
- A Consumer
that will call methods on ListDomainsInput.Builder
to create a request.default CompletableFuture<ListOpenWorkflowExecutionsResponse> listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest)
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 in the Amazon SWF Developer Guide.
listOpenWorkflowExecutionsRequest
- default CompletableFuture<ListOpenWorkflowExecutionsResponse> listOpenWorkflowExecutions(Consumer<ListOpenWorkflowExecutionsRequest.Builder> listOpenWorkflowExecutionsRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the ListOpenWorkflowExecutionsRequest.Builder
avoiding
the need to create one manually via ListOpenWorkflowExecutionsRequest.builder()
listOpenWorkflowExecutionsRequest
- A Consumer
that will call methods on ListOpenWorkflowExecutionsInput.Builder
to create a
request.default ListOpenWorkflowExecutionsPublisher listOpenWorkflowExecutionsPaginator(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest)
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 in the Amazon SWF Developer Guide.
This is a variant of
listOpenWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsPublisher publisher = client.listOpenWorkflowExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsPublisher publisher = client.listOpenWorkflowExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listOpenWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest)
operation.
listOpenWorkflowExecutionsRequest
- default ListOpenWorkflowExecutionsPublisher listOpenWorkflowExecutionsPaginator(Consumer<ListOpenWorkflowExecutionsRequest.Builder> listOpenWorkflowExecutionsRequest)
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 in the Amazon SWF Developer Guide.
This is a variant of
listOpenWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsPublisher publisher = client.listOpenWorkflowExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsPublisher publisher = client.listOpenWorkflowExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listOpenWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest)
operation.
This is a convenience which creates an instance of the ListOpenWorkflowExecutionsRequest.Builder
avoiding
the need to create one manually via ListOpenWorkflowExecutionsRequest.builder()
listOpenWorkflowExecutionsRequest
- A Consumer
that will call methods on ListOpenWorkflowExecutionsInput.Builder
to create a
request.default CompletableFuture<ListWorkflowTypesResponse> listWorkflowTypes(ListWorkflowTypesRequest listWorkflowTypesRequest)
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 in the Amazon SWF Developer Guide.
listWorkflowTypesRequest
- default CompletableFuture<ListWorkflowTypesResponse> listWorkflowTypes(Consumer<ListWorkflowTypesRequest.Builder> listWorkflowTypesRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the ListWorkflowTypesRequest.Builder
avoiding the need
to create one manually via ListWorkflowTypesRequest.builder()
listWorkflowTypesRequest
- A Consumer
that will call methods on ListWorkflowTypesInput.Builder
to create a request.default ListWorkflowTypesPublisher listWorkflowTypesPaginator(ListWorkflowTypesRequest listWorkflowTypesRequest)
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 in the Amazon SWF Developer Guide.
This is a variant of
listWorkflowTypes(software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesPublisher publisher = client.listWorkflowTypesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesPublisher publisher = client.listWorkflowTypesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListWorkflowTypesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.swf.model.ListWorkflowTypesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listWorkflowTypes(software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest)
operation.
listWorkflowTypesRequest
- default ListWorkflowTypesPublisher listWorkflowTypesPaginator(Consumer<ListWorkflowTypesRequest.Builder> listWorkflowTypesRequest)
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 in the Amazon SWF Developer Guide.
This is a variant of
listWorkflowTypes(software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesPublisher publisher = client.listWorkflowTypesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesPublisher publisher = client.listWorkflowTypesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListWorkflowTypesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.swf.model.ListWorkflowTypesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listWorkflowTypes(software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest)
operation.
This is a convenience which creates an instance of the ListWorkflowTypesRequest.Builder
avoiding the need
to create one manually via ListWorkflowTypesRequest.builder()
listWorkflowTypesRequest
- A Consumer
that will call methods on ListWorkflowTypesInput.Builder
to create a request.default CompletableFuture<PollForActivityTaskResponse> pollForActivityTask(PollForActivityTaskRequest pollForActivityTaskRequest)
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 in the Amazon SWF Developer Guide.
pollForActivityTaskRequest
- default CompletableFuture<PollForActivityTaskResponse> pollForActivityTask(Consumer<PollForActivityTaskRequest.Builder> pollForActivityTaskRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the PollForActivityTaskRequest.Builder
avoiding the
need to create one manually via PollForActivityTaskRequest.builder()
pollForActivityTaskRequest
- A Consumer
that will call methods on PollForActivityTaskInput.Builder
to create a request.default CompletableFuture<PollForDecisionTaskResponse> pollForDecisionTask(PollForDecisionTaskRequest pollForDecisionTaskRequest)
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 in the Amazon SWF Developer Guide.
pollForDecisionTaskRequest
- default CompletableFuture<PollForDecisionTaskResponse> pollForDecisionTask(Consumer<PollForDecisionTaskRequest.Builder> pollForDecisionTaskRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the PollForDecisionTaskRequest.Builder
avoiding the
need to create one manually via PollForDecisionTaskRequest.builder()
pollForDecisionTaskRequest
- A Consumer
that will call methods on PollForDecisionTaskInput.Builder
to create a request.default PollForDecisionTaskPublisher pollForDecisionTaskPaginator(PollForDecisionTaskRequest pollForDecisionTaskRequest)
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 in the Amazon SWF Developer Guide.
This is a variant of
pollForDecisionTask(software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskPublisher publisher = client.pollForDecisionTaskPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskPublisher publisher = client.pollForDecisionTaskPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.PollForDecisionTaskResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.swf.model.PollForDecisionTaskResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
pollForDecisionTask(software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest)
operation.
pollForDecisionTaskRequest
- default PollForDecisionTaskPublisher pollForDecisionTaskPaginator(Consumer<PollForDecisionTaskRequest.Builder> pollForDecisionTaskRequest)
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 in the Amazon SWF Developer Guide.
This is a variant of
pollForDecisionTask(software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskPublisher publisher = client.pollForDecisionTaskPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskPublisher publisher = client.pollForDecisionTaskPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.PollForDecisionTaskResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.swf.model.PollForDecisionTaskResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
pollForDecisionTask(software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest)
operation.
This is a convenience which creates an instance of the PollForDecisionTaskRequest.Builder
avoiding the
need to create one manually via PollForDecisionTaskRequest.builder()
pollForDecisionTaskRequest
- A Consumer
that will call methods on PollForDecisionTaskInput.Builder
to create a request.default CompletableFuture<RecordActivityTaskHeartbeatResponse> recordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest recordActivityTaskHeartbeatRequest)
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 in the Amazon SWF Developer Guide.
recordActivityTaskHeartbeatRequest
- default CompletableFuture<RecordActivityTaskHeartbeatResponse> recordActivityTaskHeartbeat(Consumer<RecordActivityTaskHeartbeatRequest.Builder> recordActivityTaskHeartbeatRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the RecordActivityTaskHeartbeatRequest.Builder
avoiding the need to create one manually via RecordActivityTaskHeartbeatRequest.builder()
recordActivityTaskHeartbeatRequest
- A Consumer
that will call methods on RecordActivityTaskHeartbeatInput.Builder
to create a
request.default CompletableFuture<RegisterActivityTypeResponse> registerActivityType(RegisterActivityTypeRequest registerActivityTypeRequest)
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 in the Amazon SWF Developer Guide.
registerActivityTypeRequest
- default CompletableFuture<RegisterActivityTypeResponse> registerActivityType(Consumer<RegisterActivityTypeRequest.Builder> registerActivityTypeRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the RegisterActivityTypeRequest.Builder
avoiding the
need to create one manually via RegisterActivityTypeRequest.builder()
registerActivityTypeRequest
- A Consumer
that will call methods on RegisterActivityTypeInput.Builder
to create a
request.default CompletableFuture<RegisterDomainResponse> registerDomain(RegisterDomainRequest registerDomainRequest)
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 in the Amazon SWF Developer Guide.
registerDomainRequest
- default CompletableFuture<RegisterDomainResponse> registerDomain(Consumer<RegisterDomainRequest.Builder> registerDomainRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the RegisterDomainRequest.Builder
avoiding the need to
create one manually via RegisterDomainRequest.builder()
registerDomainRequest
- A Consumer
that will call methods on RegisterDomainInput.Builder
to create a request.default CompletableFuture<RegisterWorkflowTypeResponse> registerWorkflowType(RegisterWorkflowTypeRequest registerWorkflowTypeRequest)
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 in the Amazon SWF Developer Guide.
registerWorkflowTypeRequest
- default CompletableFuture<RegisterWorkflowTypeResponse> registerWorkflowType(Consumer<RegisterWorkflowTypeRequest.Builder> registerWorkflowTypeRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the RegisterWorkflowTypeRequest.Builder
avoiding the
need to create one manually via RegisterWorkflowTypeRequest.builder()
registerWorkflowTypeRequest
- A Consumer
that will call methods on RegisterWorkflowTypeInput.Builder
to create a
request.default CompletableFuture<RequestCancelWorkflowExecutionResponse> requestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest)
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 in the Amazon SWF Developer Guide.
requestCancelWorkflowExecutionRequest
- default CompletableFuture<RequestCancelWorkflowExecutionResponse> requestCancelWorkflowExecution(Consumer<RequestCancelWorkflowExecutionRequest.Builder> requestCancelWorkflowExecutionRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the RequestCancelWorkflowExecutionRequest.Builder
avoiding the need to create one manually via RequestCancelWorkflowExecutionRequest.builder()
requestCancelWorkflowExecutionRequest
- A Consumer
that will call methods on RequestCancelWorkflowExecutionInput.Builder
to create
a request.default CompletableFuture<RespondActivityTaskCanceledResponse> respondActivityTaskCanceled(RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest)
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.
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 in the Amazon SWF Developer Guide.
respondActivityTaskCanceledRequest
- default CompletableFuture<RespondActivityTaskCanceledResponse> respondActivityTaskCanceled(Consumer<RespondActivityTaskCanceledRequest.Builder> respondActivityTaskCanceledRequest)
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.
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the RespondActivityTaskCanceledRequest.Builder
avoiding the need to create one manually via RespondActivityTaskCanceledRequest.builder()
respondActivityTaskCanceledRequest
- A Consumer
that will call methods on RespondActivityTaskCanceledInput.Builder
to create a
request.default CompletableFuture<RespondActivityTaskCompletedResponse> respondActivityTaskCompleted(RespondActivityTaskCompletedRequest respondActivityTaskCompletedRequest)
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.
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 in the Amazon SWF Developer Guide.
respondActivityTaskCompletedRequest
- default CompletableFuture<RespondActivityTaskCompletedResponse> respondActivityTaskCompleted(Consumer<RespondActivityTaskCompletedRequest.Builder> respondActivityTaskCompletedRequest)
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.
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the RespondActivityTaskCompletedRequest.Builder
avoiding the need to create one manually via RespondActivityTaskCompletedRequest.builder()
respondActivityTaskCompletedRequest
- A Consumer
that will call methods on RespondActivityTaskCompletedInput.Builder
to create a
request.default CompletableFuture<RespondActivityTaskFailedResponse> respondActivityTaskFailed(RespondActivityTaskFailedRequest respondActivityTaskFailedRequest)
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.
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 in the Amazon SWF Developer Guide.
respondActivityTaskFailedRequest
- default CompletableFuture<RespondActivityTaskFailedResponse> respondActivityTaskFailed(Consumer<RespondActivityTaskFailedRequest.Builder> respondActivityTaskFailedRequest)
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.
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the RespondActivityTaskFailedRequest.Builder
avoiding
the need to create one manually via RespondActivityTaskFailedRequest.builder()
respondActivityTaskFailedRequest
- A Consumer
that will call methods on RespondActivityTaskFailedInput.Builder
to create a
request.default CompletableFuture<RespondDecisionTaskCompletedResponse> respondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest)
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 in the Amazon SWF Developer Guide.
respondDecisionTaskCompletedRequest
- Input data for a TaskCompleted response to a decision task.default CompletableFuture<RespondDecisionTaskCompletedResponse> respondDecisionTaskCompleted(Consumer<RespondDecisionTaskCompletedRequest.Builder> respondDecisionTaskCompletedRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the RespondDecisionTaskCompletedRequest.Builder
avoiding the need to create one manually via RespondDecisionTaskCompletedRequest.builder()
respondDecisionTaskCompletedRequest
- A Consumer
that will call methods on RespondDecisionTaskCompletedInput.Builder
to create a
request. Input data for a TaskCompleted response to a decision task.default CompletableFuture<SignalWorkflowExecutionResponse> signalWorkflowExecution(SignalWorkflowExecutionRequest signalWorkflowExecutionRequest)
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 in the Amazon SWF Developer Guide.
signalWorkflowExecutionRequest
- default CompletableFuture<SignalWorkflowExecutionResponse> signalWorkflowExecution(Consumer<SignalWorkflowExecutionRequest.Builder> signalWorkflowExecutionRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the SignalWorkflowExecutionRequest.Builder
avoiding
the need to create one manually via SignalWorkflowExecutionRequest.builder()
signalWorkflowExecutionRequest
- A Consumer
that will call methods on SignalWorkflowExecutionInput.Builder
to create a
request.default CompletableFuture<StartWorkflowExecutionResponse> startWorkflowExecution(StartWorkflowExecutionRequest startWorkflowExecutionRequest)
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 in the Amazon SWF Developer Guide.
startWorkflowExecutionRequest
- 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.
default CompletableFuture<StartWorkflowExecutionResponse> startWorkflowExecution(Consumer<StartWorkflowExecutionRequest.Builder> startWorkflowExecutionRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the StartWorkflowExecutionRequest.Builder
avoiding the
need to create one manually via StartWorkflowExecutionRequest.builder()
startWorkflowExecutionRequest
- A Consumer
that will call methods on StartWorkflowExecutionInput.Builder
to create a
request.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.
default CompletableFuture<TerminateWorkflowExecutionResponse> terminateWorkflowExecution(TerminateWorkflowExecutionRequest terminateWorkflowExecutionRequest)
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 in the Amazon SWF Developer Guide.
terminateWorkflowExecutionRequest
- default CompletableFuture<TerminateWorkflowExecutionResponse> terminateWorkflowExecution(Consumer<TerminateWorkflowExecutionRequest.Builder> terminateWorkflowExecutionRequest)
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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the TerminateWorkflowExecutionRequest.Builder
avoiding
the need to create one manually via TerminateWorkflowExecutionRequest.builder()
terminateWorkflowExecutionRequest
- A Consumer
that will call methods on TerminateWorkflowExecutionInput.Builder
to create a
request.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.