@Generated(value="software.amazon.awssdk:codegen") public interface SwfClient 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 SwfClientBuilder |
builder()
Create a builder that can be used to configure and create a
SwfClient . |
default CountClosedWorkflowExecutionsResponse |
countClosedWorkflowExecutions(Consumer<CountClosedWorkflowExecutionsRequest.Builder> countClosedWorkflowExecutionsRequest)
Returns the number of closed workflow executions within the given domain that meet the specified filtering
criteria.
|
default CountClosedWorkflowExecutionsResponse |
countClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest)
Returns the number of closed workflow executions within the given domain that meet the specified filtering
criteria.
|
default CountOpenWorkflowExecutionsResponse |
countOpenWorkflowExecutions(Consumer<CountOpenWorkflowExecutionsRequest.Builder> countOpenWorkflowExecutionsRequest)
Returns the number of open workflow executions within the given domain that meet the specified filtering
criteria.
|
default CountOpenWorkflowExecutionsResponse |
countOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest)
Returns the number of open workflow executions within the given domain that meet the specified filtering
criteria.
|
default CountPendingActivityTasksResponse |
countPendingActivityTasks(Consumer<CountPendingActivityTasksRequest.Builder> countPendingActivityTasksRequest)
Returns the estimated number of activity tasks in the specified task list.
|
default CountPendingActivityTasksResponse |
countPendingActivityTasks(CountPendingActivityTasksRequest countPendingActivityTasksRequest)
Returns the estimated number of activity tasks in the specified task list.
|
default CountPendingDecisionTasksResponse |
countPendingDecisionTasks(Consumer<CountPendingDecisionTasksRequest.Builder> countPendingDecisionTasksRequest)
Returns the estimated number of decision tasks in the specified task list.
|
default CountPendingDecisionTasksResponse |
countPendingDecisionTasks(CountPendingDecisionTasksRequest countPendingDecisionTasksRequest)
Returns the estimated number of decision tasks in the specified task list.
|
static SwfClient |
create()
Create a
SwfClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default DeprecateActivityTypeResponse |
deprecateActivityType(Consumer<DeprecateActivityTypeRequest.Builder> deprecateActivityTypeRequest)
Deprecates the specified activity type.
|
default DeprecateActivityTypeResponse |
deprecateActivityType(DeprecateActivityTypeRequest deprecateActivityTypeRequest)
Deprecates the specified activity type.
|
default DeprecateDomainResponse |
deprecateDomain(Consumer<DeprecateDomainRequest.Builder> deprecateDomainRequest)
Deprecates the specified domain.
|
default DeprecateDomainResponse |
deprecateDomain(DeprecateDomainRequest deprecateDomainRequest)
Deprecates the specified domain.
|
default DeprecateWorkflowTypeResponse |
deprecateWorkflowType(Consumer<DeprecateWorkflowTypeRequest.Builder> deprecateWorkflowTypeRequest)
Deprecates the specified workflow type.
|
default DeprecateWorkflowTypeResponse |
deprecateWorkflowType(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest)
Deprecates the specified workflow type.
|
default DescribeActivityTypeResponse |
describeActivityType(Consumer<DescribeActivityTypeRequest.Builder> describeActivityTypeRequest)
Returns information about the specified activity type.
|
default DescribeActivityTypeResponse |
describeActivityType(DescribeActivityTypeRequest describeActivityTypeRequest)
Returns information about the specified activity type.
|
default DescribeDomainResponse |
describeDomain(Consumer<DescribeDomainRequest.Builder> describeDomainRequest)
Returns information about the specified domain, including description and status.
|
default DescribeDomainResponse |
describeDomain(DescribeDomainRequest describeDomainRequest)
Returns information about the specified domain, including description and status.
|
default DescribeWorkflowExecutionResponse |
describeWorkflowExecution(Consumer<DescribeWorkflowExecutionRequest.Builder> describeWorkflowExecutionRequest)
Returns information about the specified workflow execution including its type and some statistics.
|
default DescribeWorkflowExecutionResponse |
describeWorkflowExecution(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest)
Returns information about the specified workflow execution including its type and some statistics.
|
default DescribeWorkflowTypeResponse |
describeWorkflowType(Consumer<DescribeWorkflowTypeRequest.Builder> describeWorkflowTypeRequest)
Returns information about the specified workflow type.
|
default DescribeWorkflowTypeResponse |
describeWorkflowType(DescribeWorkflowTypeRequest describeWorkflowTypeRequest)
Returns information about the specified workflow type.
|
default GetWorkflowExecutionHistoryResponse |
getWorkflowExecutionHistory(Consumer<GetWorkflowExecutionHistoryRequest.Builder> getWorkflowExecutionHistoryRequest)
Returns the history of the specified workflow execution.
|
default GetWorkflowExecutionHistoryResponse |
getWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest)
Returns the history of the specified workflow execution.
|
default GetWorkflowExecutionHistoryIterable |
getWorkflowExecutionHistoryPaginator(Consumer<GetWorkflowExecutionHistoryRequest.Builder> getWorkflowExecutionHistoryRequest)
Returns the history of the specified workflow execution.
|
default GetWorkflowExecutionHistoryIterable |
getWorkflowExecutionHistoryPaginator(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest)
Returns the history of the specified workflow execution.
|
default 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 ListActivityTypesResponse |
listActivityTypes(ListActivityTypesRequest listActivityTypesRequest)
Returns information about all activities registered in the specified domain that match the specified name and
registration status.
|
default ListActivityTypesIterable |
listActivityTypesPaginator(Consumer<ListActivityTypesRequest.Builder> listActivityTypesRequest)
Returns information about all activities registered in the specified domain that match the specified name and
registration status.
|
default ListActivityTypesIterable |
listActivityTypesPaginator(ListActivityTypesRequest listActivityTypesRequest)
Returns information about all activities registered in the specified domain that match the specified name and
registration status.
|
default ListClosedWorkflowExecutionsResponse |
listClosedWorkflowExecutions(Consumer<ListClosedWorkflowExecutionsRequest.Builder> listClosedWorkflowExecutionsRequest)
Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.
|
default ListClosedWorkflowExecutionsResponse |
listClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest)
Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.
|
default ListClosedWorkflowExecutionsIterable |
listClosedWorkflowExecutionsPaginator(Consumer<ListClosedWorkflowExecutionsRequest.Builder> listClosedWorkflowExecutionsRequest)
Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.
|
default ListClosedWorkflowExecutionsIterable |
listClosedWorkflowExecutionsPaginator(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest)
Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.
|
default ListDomainsResponse |
listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)
Returns the list of domains registered in the account.
|
default ListDomainsResponse |
listDomains(ListDomainsRequest listDomainsRequest)
Returns the list of domains registered in the account.
|
default ListDomainsIterable |
listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest)
Returns the list of domains registered in the account.
|
default ListDomainsIterable |
listDomainsPaginator(ListDomainsRequest listDomainsRequest)
Returns the list of domains registered in the account.
|
default ListOpenWorkflowExecutionsResponse |
listOpenWorkflowExecutions(Consumer<ListOpenWorkflowExecutionsRequest.Builder> listOpenWorkflowExecutionsRequest)
Returns a list of open workflow executions in the specified domain that meet the filtering criteria.
|
default ListOpenWorkflowExecutionsResponse |
listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest)
Returns a list of open workflow executions in the specified domain that meet the filtering criteria.
|
default ListOpenWorkflowExecutionsIterable |
listOpenWorkflowExecutionsPaginator(Consumer<ListOpenWorkflowExecutionsRequest.Builder> listOpenWorkflowExecutionsRequest)
Returns a list of open workflow executions in the specified domain that meet the filtering criteria.
|
default ListOpenWorkflowExecutionsIterable |
listOpenWorkflowExecutionsPaginator(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest)
Returns a list of open workflow executions in the specified domain that meet the filtering criteria.
|
default ListWorkflowTypesResponse |
listWorkflowTypes(Consumer<ListWorkflowTypesRequest.Builder> listWorkflowTypesRequest)
Returns information about workflow types in the specified domain.
|
default ListWorkflowTypesResponse |
listWorkflowTypes(ListWorkflowTypesRequest listWorkflowTypesRequest)
Returns information about workflow types in the specified domain.
|
default ListWorkflowTypesIterable |
listWorkflowTypesPaginator(Consumer<ListWorkflowTypesRequest.Builder> listWorkflowTypesRequest)
Returns information about workflow types in the specified domain.
|
default ListWorkflowTypesIterable |
listWorkflowTypesPaginator(ListWorkflowTypesRequest listWorkflowTypesRequest)
Returns information about workflow types in the specified domain.
|
default PollForActivityTaskResponse |
pollForActivityTask(Consumer<PollForActivityTaskRequest.Builder> pollForActivityTaskRequest)
Used by workers to get an ActivityTask from the specified activity
taskList . |
default PollForActivityTaskResponse |
pollForActivityTask(PollForActivityTaskRequest pollForActivityTaskRequest)
Used by workers to get an ActivityTask from the specified activity
taskList . |
default PollForDecisionTaskResponse |
pollForDecisionTask(Consumer<PollForDecisionTaskRequest.Builder> pollForDecisionTaskRequest)
Used by deciders to get a DecisionTask from the specified decision
taskList . |
default PollForDecisionTaskResponse |
pollForDecisionTask(PollForDecisionTaskRequest pollForDecisionTaskRequest)
Used by deciders to get a DecisionTask from the specified decision
taskList . |
default PollForDecisionTaskIterable |
pollForDecisionTaskPaginator(Consumer<PollForDecisionTaskRequest.Builder> pollForDecisionTaskRequest)
Used by deciders to get a DecisionTask from the specified decision
taskList . |
default PollForDecisionTaskIterable |
pollForDecisionTaskPaginator(PollForDecisionTaskRequest pollForDecisionTaskRequest)
Used by deciders to get a DecisionTask from the specified decision
taskList . |
default 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 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 RegisterActivityTypeResponse |
registerActivityType(Consumer<RegisterActivityTypeRequest.Builder> registerActivityTypeRequest)
Registers a new activity type along with its configuration settings in the specified domain.
|
default RegisterActivityTypeResponse |
registerActivityType(RegisterActivityTypeRequest registerActivityTypeRequest)
Registers a new activity type along with its configuration settings in the specified domain.
|
default RegisterDomainResponse |
registerDomain(Consumer<RegisterDomainRequest.Builder> registerDomainRequest)
Registers a new domain.
|
default RegisterDomainResponse |
registerDomain(RegisterDomainRequest registerDomainRequest)
Registers a new domain.
|
default RegisterWorkflowTypeResponse |
registerWorkflowType(Consumer<RegisterWorkflowTypeRequest.Builder> registerWorkflowTypeRequest)
Registers a new workflow type and its configuration settings in the specified domain.
|
default RegisterWorkflowTypeResponse |
registerWorkflowType(RegisterWorkflowTypeRequest registerWorkflowTypeRequest)
Registers a new workflow type and its configuration settings in the specified domain.
|
default 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 RequestCancelWorkflowExecutionResponse |
requestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest)
Records a
WorkflowExecutionCancelRequested event in the currently running workflow execution
identified by the given domain, workflowId, and runId. |
default RespondActivityTaskCanceledResponse |
respondActivityTaskCanceled(Consumer<RespondActivityTaskCanceledRequest.Builder> respondActivityTaskCanceledRequest)
Used by workers to tell the service that the ActivityTask identified by the
taskToken was
successfully canceled. |
default RespondActivityTaskCanceledResponse |
respondActivityTaskCanceled(RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest)
Used by workers to tell the service that the ActivityTask identified by the
taskToken was
successfully canceled. |
default 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 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 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 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 RespondDecisionTaskCompletedResponse |
respondDecisionTaskCompleted(Consumer<RespondDecisionTaskCompletedRequest.Builder> respondDecisionTaskCompletedRequest)
Used by deciders to tell the service that the DecisionTask identified by the
taskToken has
successfully completed. |
default RespondDecisionTaskCompletedResponse |
respondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest)
Used by deciders to tell the service that the DecisionTask identified by the
taskToken has
successfully completed. |
static ServiceMetadata |
serviceMetadata() |
default 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 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 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 StartWorkflowExecutionResponse |
startWorkflowExecution(StartWorkflowExecutionRequest startWorkflowExecutionRequest)
Starts an execution of the workflow type in the specified domain using the provided
workflowId and
input data. |
default 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 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 SwfClient create()
SwfClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static SwfClientBuilder builder()
SwfClient
.default CountClosedWorkflowExecutionsResponse countClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CountClosedWorkflowExecutionsResponse countClosedWorkflowExecutions(Consumer<CountClosedWorkflowExecutionsRequest.Builder> countClosedWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CountOpenWorkflowExecutionsResponse countOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CountOpenWorkflowExecutionsResponse countOpenWorkflowExecutions(Consumer<CountOpenWorkflowExecutionsRequest.Builder> countOpenWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CountPendingActivityTasksResponse countPendingActivityTasks(CountPendingActivityTasksRequest countPendingActivityTasksRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CountPendingActivityTasksResponse countPendingActivityTasks(Consumer<CountPendingActivityTasksRequest.Builder> countPendingActivityTasksRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CountPendingDecisionTasksResponse countPendingDecisionTasks(CountPendingDecisionTasksRequest countPendingDecisionTasksRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CountPendingDecisionTasksResponse countPendingDecisionTasks(Consumer<CountPendingDecisionTasksRequest.Builder> countPendingDecisionTasksRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeprecateActivityTypeResponse deprecateActivityType(DeprecateActivityTypeRequest deprecateActivityTypeRequest) throws UnknownResourceException, TypeDeprecatedException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.TypeDeprecatedException
- Returned when the specified activity or workflow type was already deprecated.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeprecateActivityTypeResponse deprecateActivityType(Consumer<DeprecateActivityTypeRequest.Builder> deprecateActivityTypeRequest) throws UnknownResourceException, TypeDeprecatedException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.TypeDeprecatedException
- Returned when the specified activity or workflow type was already deprecated.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeprecateDomainResponse deprecateDomain(DeprecateDomainRequest deprecateDomainRequest) throws UnknownResourceException, DomainDeprecatedException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.DomainDeprecatedException
- Returned when the specified domain has been deprecated.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeprecateDomainResponse deprecateDomain(Consumer<DeprecateDomainRequest.Builder> deprecateDomainRequest) throws UnknownResourceException, DomainDeprecatedException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.DomainDeprecatedException
- Returned when the specified domain has been deprecated.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeprecateWorkflowTypeResponse deprecateWorkflowType(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest) throws UnknownResourceException, TypeDeprecatedException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.TypeDeprecatedException
- Returned when the specified activity or workflow type was already deprecated.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeprecateWorkflowTypeResponse deprecateWorkflowType(Consumer<DeprecateWorkflowTypeRequest.Builder> deprecateWorkflowTypeRequest) throws UnknownResourceException, TypeDeprecatedException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.TypeDeprecatedException
- Returned when the specified activity or workflow type was already deprecated.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeActivityTypeResponse describeActivityType(DescribeActivityTypeRequest describeActivityTypeRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeActivityTypeResponse describeActivityType(Consumer<DescribeActivityTypeRequest.Builder> describeActivityTypeRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDomainResponse describeDomain(DescribeDomainRequest describeDomainRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDomainResponse describeDomain(Consumer<DescribeDomainRequest.Builder> describeDomainRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeWorkflowExecutionResponse describeWorkflowExecution(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeWorkflowExecutionResponse describeWorkflowExecution(Consumer<DescribeWorkflowExecutionRequest.Builder> describeWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeWorkflowTypeResponse describeWorkflowType(DescribeWorkflowTypeRequest describeWorkflowTypeRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeWorkflowTypeResponse describeWorkflowType(Consumer<DescribeWorkflowTypeRequest.Builder> describeWorkflowTypeRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetWorkflowExecutionHistoryResponse getWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetWorkflowExecutionHistoryResponse getWorkflowExecutionHistory(Consumer<GetWorkflowExecutionHistoryRequest.Builder> getWorkflowExecutionHistoryRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetWorkflowExecutionHistoryIterable getWorkflowExecutionHistoryPaginator(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryIterable responses = client.getWorkflowExecutionHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryIterable responses = client .getWorkflowExecutionHistoryPaginator(request); for (software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryIterable responses = client.getWorkflowExecutionHistoryPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getWorkflowExecutionHistory(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest)
operation.
getWorkflowExecutionHistoryRequest
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetWorkflowExecutionHistoryIterable getWorkflowExecutionHistoryPaginator(Consumer<GetWorkflowExecutionHistoryRequest.Builder> getWorkflowExecutionHistoryRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryIterable responses = client.getWorkflowExecutionHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryIterable responses = client .getWorkflowExecutionHistoryPaginator(request); for (software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryIterable responses = client.getWorkflowExecutionHistoryPaginator(request);
responses.iterator().forEachRemaining(....);
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListActivityTypesResponse listActivityTypes(ListActivityTypesRequest listActivityTypesRequest) throws OperationNotPermittedException, UnknownResourceException, AwsServiceException, SdkClientException, SwfException
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
- OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListActivityTypesResponse listActivityTypes(Consumer<ListActivityTypesRequest.Builder> listActivityTypesRequest) throws OperationNotPermittedException, UnknownResourceException, AwsServiceException, SdkClientException, SwfException
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.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListActivityTypesIterable listActivityTypesPaginator(ListActivityTypesRequest listActivityTypesRequest) throws OperationNotPermittedException, UnknownResourceException, AwsServiceException, SdkClientException, SwfException
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 iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.swf.paginators.ListActivityTypesIterable responses = client.listActivityTypesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.swf.paginators.ListActivityTypesIterable responses = client .listActivityTypesPaginator(request); for (software.amazon.awssdk.services.swf.model.ListActivityTypesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.swf.paginators.ListActivityTypesIterable responses = client.listActivityTypesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listActivityTypes(software.amazon.awssdk.services.swf.model.ListActivityTypesRequest)
operation.
listActivityTypesRequest
- OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListActivityTypesIterable listActivityTypesPaginator(Consumer<ListActivityTypesRequest.Builder> listActivityTypesRequest) throws OperationNotPermittedException, UnknownResourceException, AwsServiceException, SdkClientException, SwfException
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 iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.swf.paginators.ListActivityTypesIterable responses = client.listActivityTypesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.swf.paginators.ListActivityTypesIterable responses = client .listActivityTypesPaginator(request); for (software.amazon.awssdk.services.swf.model.ListActivityTypesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.swf.paginators.ListActivityTypesIterable responses = client.listActivityTypesPaginator(request);
responses.iterator().forEachRemaining(....);
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.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListClosedWorkflowExecutionsResponse listClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListClosedWorkflowExecutionsResponse listClosedWorkflowExecutions(Consumer<ListClosedWorkflowExecutionsRequest.Builder> listClosedWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListClosedWorkflowExecutionsIterable listClosedWorkflowExecutionsPaginator(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsIterable responses = client.listClosedWorkflowExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsIterable responses = client .listClosedWorkflowExecutionsPaginator(request); for (software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsIterable responses = client.listClosedWorkflowExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listClosedWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest)
operation.
listClosedWorkflowExecutionsRequest
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListClosedWorkflowExecutionsIterable listClosedWorkflowExecutionsPaginator(Consumer<ListClosedWorkflowExecutionsRequest.Builder> listClosedWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsIterable responses = client.listClosedWorkflowExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsIterable responses = client .listClosedWorkflowExecutionsPaginator(request); for (software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsIterable responses = client.listClosedWorkflowExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDomainsResponse listDomains(ListDomainsRequest listDomainsRequest) throws OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDomainsResponse listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest) throws OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDomainsIterable listDomainsPaginator(ListDomainsRequest listDomainsRequest) throws OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.swf.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.swf.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); for (software.amazon.awssdk.services.swf.model.ListDomainsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.swf.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listDomains(software.amazon.awssdk.services.swf.model.ListDomainsRequest)
operation.
listDomainsRequest
- OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDomainsIterable listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest) throws OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.swf.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.swf.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); for (software.amazon.awssdk.services.swf.model.ListDomainsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.swf.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
responses.iterator().forEachRemaining(....);
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.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListOpenWorkflowExecutionsResponse listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListOpenWorkflowExecutionsResponse listOpenWorkflowExecutions(Consumer<ListOpenWorkflowExecutionsRequest.Builder> listOpenWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListOpenWorkflowExecutionsIterable listOpenWorkflowExecutionsPaginator(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsIterable responses = client.listOpenWorkflowExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsIterable responses = client .listOpenWorkflowExecutionsPaginator(request); for (software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsIterable responses = client.listOpenWorkflowExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listOpenWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest)
operation.
listOpenWorkflowExecutionsRequest
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListOpenWorkflowExecutionsIterable listOpenWorkflowExecutionsPaginator(Consumer<ListOpenWorkflowExecutionsRequest.Builder> listOpenWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsIterable responses = client.listOpenWorkflowExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsIterable responses = client .listOpenWorkflowExecutionsPaginator(request); for (software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsIterable responses = client.listOpenWorkflowExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListWorkflowTypesResponse listWorkflowTypes(ListWorkflowTypesRequest listWorkflowTypesRequest) throws OperationNotPermittedException, UnknownResourceException, AwsServiceException, SdkClientException, SwfException
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
- OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListWorkflowTypesResponse listWorkflowTypes(Consumer<ListWorkflowTypesRequest.Builder> listWorkflowTypesRequest) throws OperationNotPermittedException, UnknownResourceException, AwsServiceException, SdkClientException, SwfException
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.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListWorkflowTypesIterable listWorkflowTypesPaginator(ListWorkflowTypesRequest listWorkflowTypesRequest) throws OperationNotPermittedException, UnknownResourceException, AwsServiceException, SdkClientException, SwfException
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 iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesIterable responses = client.listWorkflowTypesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesIterable responses = client .listWorkflowTypesPaginator(request); for (software.amazon.awssdk.services.swf.model.ListWorkflowTypesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesIterable responses = client.listWorkflowTypesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listWorkflowTypes(software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest)
operation.
listWorkflowTypesRequest
- OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListWorkflowTypesIterable listWorkflowTypesPaginator(Consumer<ListWorkflowTypesRequest.Builder> listWorkflowTypesRequest) throws OperationNotPermittedException, UnknownResourceException, AwsServiceException, SdkClientException, SwfException
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 iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesIterable responses = client.listWorkflowTypesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesIterable responses = client .listWorkflowTypesPaginator(request); for (software.amazon.awssdk.services.swf.model.ListWorkflowTypesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesIterable responses = client.listWorkflowTypesPaginator(request);
responses.iterator().forEachRemaining(....);
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.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PollForActivityTaskResponse pollForActivityTask(PollForActivityTaskRequest pollForActivityTaskRequest) throws UnknownResourceException, OperationNotPermittedException, LimitExceededException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.LimitExceededException
- Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PollForActivityTaskResponse pollForActivityTask(Consumer<PollForActivityTaskRequest.Builder> pollForActivityTaskRequest) throws UnknownResourceException, OperationNotPermittedException, LimitExceededException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.LimitExceededException
- Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PollForDecisionTaskResponse pollForDecisionTask(PollForDecisionTaskRequest pollForDecisionTaskRequest) throws UnknownResourceException, OperationNotPermittedException, LimitExceededException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.LimitExceededException
- Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PollForDecisionTaskResponse pollForDecisionTask(Consumer<PollForDecisionTaskRequest.Builder> pollForDecisionTaskRequest) throws UnknownResourceException, OperationNotPermittedException, LimitExceededException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.LimitExceededException
- Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PollForDecisionTaskIterable pollForDecisionTaskPaginator(PollForDecisionTaskRequest pollForDecisionTaskRequest) throws UnknownResourceException, OperationNotPermittedException, LimitExceededException, AwsServiceException, SdkClientException, SwfException
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 iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskIterable responses = client.pollForDecisionTaskPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskIterable responses = client .pollForDecisionTaskPaginator(request); for (software.amazon.awssdk.services.swf.model.PollForDecisionTaskResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskIterable responses = client.pollForDecisionTaskPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
pollForDecisionTask(software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest)
operation.
pollForDecisionTaskRequest
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.LimitExceededException
- Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PollForDecisionTaskIterable pollForDecisionTaskPaginator(Consumer<PollForDecisionTaskRequest.Builder> pollForDecisionTaskRequest) throws UnknownResourceException, OperationNotPermittedException, LimitExceededException, AwsServiceException, SdkClientException, SwfException
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 iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskIterable responses = client.pollForDecisionTaskPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskIterable responses = client .pollForDecisionTaskPaginator(request); for (software.amazon.awssdk.services.swf.model.PollForDecisionTaskResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskIterable responses = client.pollForDecisionTaskPaginator(request);
responses.iterator().forEachRemaining(....);
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.LimitExceededException
- Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RecordActivityTaskHeartbeatResponse recordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest recordActivityTaskHeartbeatRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RecordActivityTaskHeartbeatResponse recordActivityTaskHeartbeat(Consumer<RecordActivityTaskHeartbeatRequest.Builder> recordActivityTaskHeartbeatRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RegisterActivityTypeResponse registerActivityType(RegisterActivityTypeRequest registerActivityTypeRequest) throws TypeAlreadyExistsException, LimitExceededException, UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- TypeAlreadyExistsException
- Returned if the type already exists in the specified domain. You get this fault even if the existing type
is in deprecated status. You can specify another version if the intent is to create a new distinct
version of the type.LimitExceededException
- Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RegisterActivityTypeResponse registerActivityType(Consumer<RegisterActivityTypeRequest.Builder> registerActivityTypeRequest) throws TypeAlreadyExistsException, LimitExceededException, UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.TypeAlreadyExistsException
- Returned if the type already exists in the specified domain. You get this fault even if the existing type
is in deprecated status. You can specify another version if the intent is to create a new distinct
version of the type.LimitExceededException
- Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RegisterDomainResponse registerDomain(RegisterDomainRequest registerDomainRequest) throws DomainAlreadyExistsException, LimitExceededException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- DomainAlreadyExistsException
- Returned if the specified domain already exists. You get this fault even if the existing domain is in
deprecated status.LimitExceededException
- Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RegisterDomainResponse registerDomain(Consumer<RegisterDomainRequest.Builder> registerDomainRequest) throws DomainAlreadyExistsException, LimitExceededException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.DomainAlreadyExistsException
- Returned if the specified domain already exists. You get this fault even if the existing domain is in
deprecated status.LimitExceededException
- Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RegisterWorkflowTypeResponse registerWorkflowType(RegisterWorkflowTypeRequest registerWorkflowTypeRequest) throws TypeAlreadyExistsException, LimitExceededException, UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- TypeAlreadyExistsException
- Returned if the type already exists in the specified domain. You get this fault even if the existing type
is in deprecated status. You can specify another version if the intent is to create a new distinct
version of the type.LimitExceededException
- Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RegisterWorkflowTypeResponse registerWorkflowType(Consumer<RegisterWorkflowTypeRequest.Builder> registerWorkflowTypeRequest) throws TypeAlreadyExistsException, LimitExceededException, UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.TypeAlreadyExistsException
- Returned if the type already exists in the specified domain. You get this fault even if the existing type
is in deprecated status. You can specify another version if the intent is to create a new distinct
version of the type.LimitExceededException
- Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RequestCancelWorkflowExecutionResponse requestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RequestCancelWorkflowExecutionResponse requestCancelWorkflowExecution(Consumer<RequestCancelWorkflowExecutionRequest.Builder> requestCancelWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RespondActivityTaskCanceledResponse respondActivityTaskCanceled(RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RespondActivityTaskCanceledResponse respondActivityTaskCanceled(Consumer<RespondActivityTaskCanceledRequest.Builder> respondActivityTaskCanceledRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RespondActivityTaskCompletedResponse respondActivityTaskCompleted(RespondActivityTaskCompletedRequest respondActivityTaskCompletedRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RespondActivityTaskCompletedResponse respondActivityTaskCompleted(Consumer<RespondActivityTaskCompletedRequest.Builder> respondActivityTaskCompletedRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RespondActivityTaskFailedResponse respondActivityTaskFailed(RespondActivityTaskFailedRequest respondActivityTaskFailedRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RespondActivityTaskFailedResponse respondActivityTaskFailed(Consumer<RespondActivityTaskFailedRequest.Builder> respondActivityTaskFailedRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RespondDecisionTaskCompletedResponse respondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RespondDecisionTaskCompletedResponse respondDecisionTaskCompleted(Consumer<RespondDecisionTaskCompletedRequest.Builder> respondDecisionTaskCompletedRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SignalWorkflowExecutionResponse signalWorkflowExecution(SignalWorkflowExecutionRequest signalWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SignalWorkflowExecutionResponse signalWorkflowExecution(Consumer<SignalWorkflowExecutionRequest.Builder> signalWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartWorkflowExecutionResponse startWorkflowExecution(StartWorkflowExecutionRequest startWorkflowExecutionRequest) throws UnknownResourceException, TypeDeprecatedException, WorkflowExecutionAlreadyStartedException, LimitExceededException, OperationNotPermittedException, DefaultUndefinedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.TypeDeprecatedException
- Returned when the specified activity or workflow type was already deprecated.WorkflowExecutionAlreadyStartedException
- Returned by StartWorkflowExecution when an open execution with the same workflowId is already
running in the specified domain.LimitExceededException
- Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.DefaultUndefinedException
- The StartWorkflowExecution
API action was called without the required parameters set.
Some workflow execution parameters, such as the decision taskList
, must be set to start the
execution. However, these parameters might have been set as defaults when the workflow type was
registered. In this case, you can omit these parameters from the StartWorkflowExecution
call
and Amazon SWF uses the values defined in the workflow type.
If these parameters aren't set and no default parameters were defined in the workflow type, this error is displayed.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartWorkflowExecutionResponse startWorkflowExecution(Consumer<StartWorkflowExecutionRequest.Builder> startWorkflowExecutionRequest) throws UnknownResourceException, TypeDeprecatedException, WorkflowExecutionAlreadyStartedException, LimitExceededException, OperationNotPermittedException, DefaultUndefinedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.TypeDeprecatedException
- Returned when the specified activity or workflow type was already deprecated.WorkflowExecutionAlreadyStartedException
- Returned by StartWorkflowExecution when an open execution with the same workflowId is already
running in the specified domain.LimitExceededException
- Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.DefaultUndefinedException
- The StartWorkflowExecution
API action was called without the required parameters set.
Some workflow execution parameters, such as the decision taskList
, must be set to start the
execution. However, these parameters might have been set as defaults when the workflow type was
registered. In this case, you can omit these parameters from the StartWorkflowExecution
call
and Amazon SWF uses the values defined in the workflow type.
If these parameters aren't set and no default parameters were defined in the workflow type, this error is displayed.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TerminateWorkflowExecutionResponse terminateWorkflowExecution(TerminateWorkflowExecutionRequest terminateWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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
- UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TerminateWorkflowExecutionResponse terminateWorkflowExecution(Consumer<TerminateWorkflowExecutionRequest.Builder> terminateWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
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.UnknownResourceException
- Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException
- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SwfException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.