AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::SWF::Model::StartWorkflowExecutionRequest Class Reference

#include <StartWorkflowExecutionRequest.h>

+ Inheritance diagram for Aws::SWF::Model::StartWorkflowExecutionRequest:

Public Member Functions

 StartWorkflowExecutionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetDomain () const
 
bool DomainHasBeenSet () const
 
void SetDomain (const Aws::String &value)
 
void SetDomain (Aws::String &&value)
 
void SetDomain (const char *value)
 
StartWorkflowExecutionRequestWithDomain (const Aws::String &value)
 
StartWorkflowExecutionRequestWithDomain (Aws::String &&value)
 
StartWorkflowExecutionRequestWithDomain (const char *value)
 
const Aws::StringGetWorkflowId () const
 
bool WorkflowIdHasBeenSet () const
 
void SetWorkflowId (const Aws::String &value)
 
void SetWorkflowId (Aws::String &&value)
 
void SetWorkflowId (const char *value)
 
StartWorkflowExecutionRequestWithWorkflowId (const Aws::String &value)
 
StartWorkflowExecutionRequestWithWorkflowId (Aws::String &&value)
 
StartWorkflowExecutionRequestWithWorkflowId (const char *value)
 
const WorkflowTypeGetWorkflowType () const
 
bool WorkflowTypeHasBeenSet () const
 
void SetWorkflowType (const WorkflowType &value)
 
void SetWorkflowType (WorkflowType &&value)
 
StartWorkflowExecutionRequestWithWorkflowType (const WorkflowType &value)
 
StartWorkflowExecutionRequestWithWorkflowType (WorkflowType &&value)
 
const TaskListGetTaskList () const
 
bool TaskListHasBeenSet () const
 
void SetTaskList (const TaskList &value)
 
void SetTaskList (TaskList &&value)
 
StartWorkflowExecutionRequestWithTaskList (const TaskList &value)
 
StartWorkflowExecutionRequestWithTaskList (TaskList &&value)
 
const Aws::StringGetTaskPriority () const
 
bool TaskPriorityHasBeenSet () const
 
void SetTaskPriority (const Aws::String &value)
 
void SetTaskPriority (Aws::String &&value)
 
void SetTaskPriority (const char *value)
 
StartWorkflowExecutionRequestWithTaskPriority (const Aws::String &value)
 
StartWorkflowExecutionRequestWithTaskPriority (Aws::String &&value)
 
StartWorkflowExecutionRequestWithTaskPriority (const char *value)
 
const Aws::StringGetInput () const
 
bool InputHasBeenSet () const
 
void SetInput (const Aws::String &value)
 
void SetInput (Aws::String &&value)
 
void SetInput (const char *value)
 
StartWorkflowExecutionRequestWithInput (const Aws::String &value)
 
StartWorkflowExecutionRequestWithInput (Aws::String &&value)
 
StartWorkflowExecutionRequestWithInput (const char *value)
 
const Aws::StringGetExecutionStartToCloseTimeout () const
 
bool ExecutionStartToCloseTimeoutHasBeenSet () const
 
void SetExecutionStartToCloseTimeout (const Aws::String &value)
 
void SetExecutionStartToCloseTimeout (Aws::String &&value)
 
void SetExecutionStartToCloseTimeout (const char *value)
 
StartWorkflowExecutionRequestWithExecutionStartToCloseTimeout (const Aws::String &value)
 
StartWorkflowExecutionRequestWithExecutionStartToCloseTimeout (Aws::String &&value)
 
StartWorkflowExecutionRequestWithExecutionStartToCloseTimeout (const char *value)
 
const Aws::Vector< Aws::String > & GetTagList () const
 
bool TagListHasBeenSet () const
 
void SetTagList (const Aws::Vector< Aws::String > &value)
 
void SetTagList (Aws::Vector< Aws::String > &&value)
 
StartWorkflowExecutionRequestWithTagList (const Aws::Vector< Aws::String > &value)
 
StartWorkflowExecutionRequestWithTagList (Aws::Vector< Aws::String > &&value)
 
StartWorkflowExecutionRequestAddTagList (const Aws::String &value)
 
StartWorkflowExecutionRequestAddTagList (Aws::String &&value)
 
StartWorkflowExecutionRequestAddTagList (const char *value)
 
const Aws::StringGetTaskStartToCloseTimeout () const
 
bool TaskStartToCloseTimeoutHasBeenSet () const
 
void SetTaskStartToCloseTimeout (const Aws::String &value)
 
void SetTaskStartToCloseTimeout (Aws::String &&value)
 
void SetTaskStartToCloseTimeout (const char *value)
 
StartWorkflowExecutionRequestWithTaskStartToCloseTimeout (const Aws::String &value)
 
StartWorkflowExecutionRequestWithTaskStartToCloseTimeout (Aws::String &&value)
 
StartWorkflowExecutionRequestWithTaskStartToCloseTimeout (const char *value)
 
const ChildPolicyGetChildPolicy () const
 
bool ChildPolicyHasBeenSet () const
 
void SetChildPolicy (const ChildPolicy &value)
 
void SetChildPolicy (ChildPolicy &&value)
 
StartWorkflowExecutionRequestWithChildPolicy (const ChildPolicy &value)
 
StartWorkflowExecutionRequestWithChildPolicy (ChildPolicy &&value)
 
const Aws::StringGetLambdaRole () const
 
bool LambdaRoleHasBeenSet () const
 
void SetLambdaRole (const Aws::String &value)
 
void SetLambdaRole (Aws::String &&value)
 
void SetLambdaRole (const char *value)
 
StartWorkflowExecutionRequestWithLambdaRole (const Aws::String &value)
 
StartWorkflowExecutionRequestWithLambdaRole (Aws::String &&value)
 
StartWorkflowExecutionRequestWithLambdaRole (const char *value)
 
- Public Member Functions inherited from Aws::SWF::SWFRequest
virtual ~SWFRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 25 of file StartWorkflowExecutionRequest.h.

Constructor & Destructor Documentation

◆ StartWorkflowExecutionRequest()

Aws::SWF::Model::StartWorkflowExecutionRequest::StartWorkflowExecutionRequest ( )

Member Function Documentation

◆ AddTagList() [1/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::AddTagList ( const Aws::String value)
inline

The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

Definition at line 654 of file StartWorkflowExecutionRequest.h.

◆ AddTagList() [2/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::AddTagList ( Aws::String &&  value)
inline

The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

Definition at line 662 of file StartWorkflowExecutionRequest.h.

◆ AddTagList() [3/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::AddTagList ( const char *  value)
inline

The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

Definition at line 670 of file StartWorkflowExecutionRequest.h.

◆ ChildPolicyHasBeenSet()

bool Aws::SWF::Model::StartWorkflowExecutionRequest::ChildPolicyHasBeenSet ( ) const
inline

If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

Definition at line 824 of file StartWorkflowExecutionRequest.h.

◆ DomainHasBeenSet()

bool Aws::SWF::Model::StartWorkflowExecutionRequest::DomainHasBeenSet ( ) const
inline

The name of the domain in which the workflow execution is created.

Definition at line 49 of file StartWorkflowExecutionRequest.h.

◆ ExecutionStartToCloseTimeoutHasBeenSet()

bool Aws::SWF::Model::StartWorkflowExecutionRequest::ExecutionStartToCloseTimeoutHasBeenSet ( ) const
inline

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run.

An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.

Definition at line 507 of file StartWorkflowExecutionRequest.h.

◆ GetChildPolicy()

const ChildPolicy& Aws::SWF::Model::StartWorkflowExecutionRequest::GetChildPolicy ( ) const
inline

If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

Definition at line 804 of file StartWorkflowExecutionRequest.h.

◆ GetDomain()

const Aws::String& Aws::SWF::Model::StartWorkflowExecutionRequest::GetDomain ( ) const
inline

The name of the domain in which the workflow execution is created.

Definition at line 44 of file StartWorkflowExecutionRequest.h.

◆ GetExecutionStartToCloseTimeout()

const Aws::String& Aws::SWF::Model::StartWorkflowExecutionRequest::GetExecutionStartToCloseTimeout ( ) const
inline

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run.

An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.

Definition at line 492 of file StartWorkflowExecutionRequest.h.

◆ GetInput()

const Aws::String& Aws::SWF::Model::StartWorkflowExecutionRequest::GetInput ( ) const
inline

The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.

Definition at line 420 of file StartWorkflowExecutionRequest.h.

◆ GetLambdaRole()

const Aws::String& Aws::SWF::Model::StartWorkflowExecutionRequest::GetLambdaRole ( ) const
inline

The IAM role to attach to this workflow execution.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

Definition at line 916 of file StartWorkflowExecutionRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SWF::Model::StartWorkflowExecutionRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::SWF::SWFRequest.

◆ GetServiceRequestName()

virtual const char* Aws::SWF::Model::StartWorkflowExecutionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file StartWorkflowExecutionRequest.h.

◆ GetTagList()

const Aws::Vector<Aws::String>& Aws::SWF::Model::StartWorkflowExecutionRequest::GetTagList ( ) const
inline

The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

Definition at line 606 of file StartWorkflowExecutionRequest.h.

◆ GetTaskList()

const TaskList& Aws::SWF::Model::StartWorkflowExecutionRequest::GetTaskList ( ) const
inline

The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.

A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 239 of file StartWorkflowExecutionRequest.h.

◆ GetTaskPriority()

const Aws::String& Aws::SWF::Model::StartWorkflowExecutionRequest::GetTaskPriority ( ) const
inline

The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

Definition at line 327 of file StartWorkflowExecutionRequest.h.

◆ GetTaskStartToCloseTimeout()

const Aws::String& Aws::SWF::Model::StartWorkflowExecutionRequest::GetTaskStartToCloseTimeout ( ) const
inline

Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

Definition at line 685 of file StartWorkflowExecutionRequest.h.

◆ GetWorkflowId()

const Aws::String& Aws::SWF::Model::StartWorkflowExecutionRequest::GetWorkflowId ( ) const
inline

The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time within the same domain.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 94 of file StartWorkflowExecutionRequest.h.

◆ GetWorkflowType()

const WorkflowType& Aws::SWF::Model::StartWorkflowExecutionRequest::GetWorkflowType ( ) const
inline

The type of the workflow to start.

Definition at line 198 of file StartWorkflowExecutionRequest.h.

◆ InputHasBeenSet()

bool Aws::SWF::Model::StartWorkflowExecutionRequest::InputHasBeenSet ( ) const
inline

The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.

Definition at line 428 of file StartWorkflowExecutionRequest.h.

◆ LambdaRoleHasBeenSet()

bool Aws::SWF::Model::StartWorkflowExecutionRequest::LambdaRoleHasBeenSet ( ) const
inline

The IAM role to attach to this workflow execution.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

Definition at line 927 of file StartWorkflowExecutionRequest.h.

◆ SerializePayload()

Aws::String Aws::SWF::Model::StartWorkflowExecutionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetChildPolicy() [1/2]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetChildPolicy ( const ChildPolicy value)
inline

If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

Definition at line 844 of file StartWorkflowExecutionRequest.h.

◆ SetChildPolicy() [2/2]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetChildPolicy ( ChildPolicy &&  value)
inline

If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

Definition at line 864 of file StartWorkflowExecutionRequest.h.

◆ SetDomain() [1/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetDomain ( const Aws::String value)
inline

The name of the domain in which the workflow execution is created.

Definition at line 54 of file StartWorkflowExecutionRequest.h.

◆ SetDomain() [2/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetDomain ( Aws::String &&  value)
inline

The name of the domain in which the workflow execution is created.

Definition at line 59 of file StartWorkflowExecutionRequest.h.

◆ SetDomain() [3/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetDomain ( const char *  value)
inline

The name of the domain in which the workflow execution is created.

Definition at line 64 of file StartWorkflowExecutionRequest.h.

◆ SetExecutionStartToCloseTimeout() [1/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetExecutionStartToCloseTimeout ( const Aws::String value)
inline

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run.

An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.

Definition at line 522 of file StartWorkflowExecutionRequest.h.

◆ SetExecutionStartToCloseTimeout() [2/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetExecutionStartToCloseTimeout ( Aws::String &&  value)
inline

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run.

An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.

Definition at line 537 of file StartWorkflowExecutionRequest.h.

◆ SetExecutionStartToCloseTimeout() [3/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetExecutionStartToCloseTimeout ( const char *  value)
inline

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run.

An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.

Definition at line 552 of file StartWorkflowExecutionRequest.h.

◆ SetInput() [1/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetInput ( const Aws::String value)
inline

The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.

Definition at line 436 of file StartWorkflowExecutionRequest.h.

◆ SetInput() [2/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetInput ( Aws::String &&  value)
inline

The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.

Definition at line 444 of file StartWorkflowExecutionRequest.h.

◆ SetInput() [3/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetInput ( const char *  value)
inline

The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.

Definition at line 452 of file StartWorkflowExecutionRequest.h.

◆ SetLambdaRole() [1/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetLambdaRole ( const Aws::String value)
inline

The IAM role to attach to this workflow execution.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

Definition at line 938 of file StartWorkflowExecutionRequest.h.

◆ SetLambdaRole() [2/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetLambdaRole ( Aws::String &&  value)
inline

The IAM role to attach to this workflow execution.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

Definition at line 949 of file StartWorkflowExecutionRequest.h.

◆ SetLambdaRole() [3/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetLambdaRole ( const char *  value)
inline

The IAM role to attach to this workflow execution.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

Definition at line 960 of file StartWorkflowExecutionRequest.h.

◆ SetTagList() [1/2]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetTagList ( const Aws::Vector< Aws::String > &  value)
inline

The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

Definition at line 622 of file StartWorkflowExecutionRequest.h.

◆ SetTagList() [2/2]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetTagList ( Aws::Vector< Aws::String > &&  value)
inline

The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

Definition at line 630 of file StartWorkflowExecutionRequest.h.

◆ SetTaskList() [1/2]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetTaskList ( const TaskList value)
inline

The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.

A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 269 of file StartWorkflowExecutionRequest.h.

◆ SetTaskList() [2/2]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetTaskList ( TaskList &&  value)
inline

The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.

A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 284 of file StartWorkflowExecutionRequest.h.

◆ SetTaskPriority() [1/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetTaskPriority ( const Aws::String value)
inline

The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

Definition at line 351 of file StartWorkflowExecutionRequest.h.

◆ SetTaskPriority() [2/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetTaskPriority ( Aws::String &&  value)
inline

The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

Definition at line 363 of file StartWorkflowExecutionRequest.h.

◆ SetTaskPriority() [3/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetTaskPriority ( const char *  value)
inline

The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

Definition at line 375 of file StartWorkflowExecutionRequest.h.

◆ SetTaskStartToCloseTimeout() [1/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetTaskStartToCloseTimeout ( const Aws::String value)
inline

Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

Definition at line 713 of file StartWorkflowExecutionRequest.h.

◆ SetTaskStartToCloseTimeout() [2/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetTaskStartToCloseTimeout ( Aws::String &&  value)
inline

Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

Definition at line 727 of file StartWorkflowExecutionRequest.h.

◆ SetTaskStartToCloseTimeout() [3/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetTaskStartToCloseTimeout ( const char *  value)
inline

Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

Definition at line 741 of file StartWorkflowExecutionRequest.h.

◆ SetWorkflowId() [1/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetWorkflowId ( const Aws::String value)
inline

The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time within the same domain.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 122 of file StartWorkflowExecutionRequest.h.

◆ SetWorkflowId() [2/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetWorkflowId ( Aws::String &&  value)
inline

The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time within the same domain.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 136 of file StartWorkflowExecutionRequest.h.

◆ SetWorkflowId() [3/3]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetWorkflowId ( const char *  value)
inline

The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time within the same domain.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 150 of file StartWorkflowExecutionRequest.h.

◆ SetWorkflowType() [1/2]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetWorkflowType ( const WorkflowType value)
inline

The type of the workflow to start.

Definition at line 208 of file StartWorkflowExecutionRequest.h.

◆ SetWorkflowType() [2/2]

void Aws::SWF::Model::StartWorkflowExecutionRequest::SetWorkflowType ( WorkflowType &&  value)
inline

The type of the workflow to start.

Definition at line 213 of file StartWorkflowExecutionRequest.h.

◆ TagListHasBeenSet()

bool Aws::SWF::Model::StartWorkflowExecutionRequest::TagListHasBeenSet ( ) const
inline

The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

Definition at line 614 of file StartWorkflowExecutionRequest.h.

◆ TaskListHasBeenSet()

bool Aws::SWF::Model::StartWorkflowExecutionRequest::TaskListHasBeenSet ( ) const
inline

The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.

A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 254 of file StartWorkflowExecutionRequest.h.

◆ TaskPriorityHasBeenSet()

bool Aws::SWF::Model::StartWorkflowExecutionRequest::TaskPriorityHasBeenSet ( ) const
inline

The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

Definition at line 339 of file StartWorkflowExecutionRequest.h.

◆ TaskStartToCloseTimeoutHasBeenSet()

bool Aws::SWF::Model::StartWorkflowExecutionRequest::TaskStartToCloseTimeoutHasBeenSet ( ) const
inline

Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

Definition at line 699 of file StartWorkflowExecutionRequest.h.

◆ WithChildPolicy() [1/2]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithChildPolicy ( const ChildPolicy value)
inline

If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

Definition at line 884 of file StartWorkflowExecutionRequest.h.

◆ WithChildPolicy() [2/2]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithChildPolicy ( ChildPolicy &&  value)
inline

If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

Definition at line 904 of file StartWorkflowExecutionRequest.h.

◆ WithDomain() [1/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithDomain ( const Aws::String value)
inline

The name of the domain in which the workflow execution is created.

Definition at line 69 of file StartWorkflowExecutionRequest.h.

◆ WithDomain() [2/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithDomain ( Aws::String &&  value)
inline

The name of the domain in which the workflow execution is created.

Definition at line 74 of file StartWorkflowExecutionRequest.h.

◆ WithDomain() [3/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithDomain ( const char *  value)
inline

The name of the domain in which the workflow execution is created.

Definition at line 79 of file StartWorkflowExecutionRequest.h.

◆ WithExecutionStartToCloseTimeout() [1/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithExecutionStartToCloseTimeout ( const Aws::String value)
inline

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run.

An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.

Definition at line 567 of file StartWorkflowExecutionRequest.h.

◆ WithExecutionStartToCloseTimeout() [2/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithExecutionStartToCloseTimeout ( Aws::String &&  value)
inline

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run.

An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.

Definition at line 582 of file StartWorkflowExecutionRequest.h.

◆ WithExecutionStartToCloseTimeout() [3/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithExecutionStartToCloseTimeout ( const char *  value)
inline

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run.

An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.

Definition at line 597 of file StartWorkflowExecutionRequest.h.

◆ WithInput() [1/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithInput ( const Aws::String value)
inline

The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.

Definition at line 460 of file StartWorkflowExecutionRequest.h.

◆ WithInput() [2/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithInput ( Aws::String &&  value)
inline

The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.

Definition at line 468 of file StartWorkflowExecutionRequest.h.

◆ WithInput() [3/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithInput ( const char *  value)
inline

The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.

Definition at line 476 of file StartWorkflowExecutionRequest.h.

◆ WithLambdaRole() [1/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithLambdaRole ( const Aws::String value)
inline

The IAM role to attach to this workflow execution.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

Definition at line 971 of file StartWorkflowExecutionRequest.h.

◆ WithLambdaRole() [2/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithLambdaRole ( Aws::String &&  value)
inline

The IAM role to attach to this workflow execution.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

Definition at line 982 of file StartWorkflowExecutionRequest.h.

◆ WithLambdaRole() [3/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithLambdaRole ( const char *  value)
inline

The IAM role to attach to this workflow execution.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

Definition at line 993 of file StartWorkflowExecutionRequest.h.

◆ WithTagList() [1/2]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithTagList ( const Aws::Vector< Aws::String > &  value)
inline

The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

Definition at line 638 of file StartWorkflowExecutionRequest.h.

◆ WithTagList() [2/2]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithTagList ( Aws::Vector< Aws::String > &&  value)
inline

The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

Definition at line 646 of file StartWorkflowExecutionRequest.h.

◆ WithTaskList() [1/2]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithTaskList ( const TaskList value)
inline

The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.

A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 299 of file StartWorkflowExecutionRequest.h.

◆ WithTaskList() [2/2]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithTaskList ( TaskList &&  value)
inline

The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.

A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 314 of file StartWorkflowExecutionRequest.h.

◆ WithTaskPriority() [1/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithTaskPriority ( const Aws::String value)
inline

The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

Definition at line 387 of file StartWorkflowExecutionRequest.h.

◆ WithTaskPriority() [2/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithTaskPriority ( Aws::String &&  value)
inline

The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

Definition at line 399 of file StartWorkflowExecutionRequest.h.

◆ WithTaskPriority() [3/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithTaskPriority ( const char *  value)
inline

The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

Definition at line 411 of file StartWorkflowExecutionRequest.h.

◆ WithTaskStartToCloseTimeout() [1/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithTaskStartToCloseTimeout ( const Aws::String value)
inline

Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

Definition at line 755 of file StartWorkflowExecutionRequest.h.

◆ WithTaskStartToCloseTimeout() [2/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithTaskStartToCloseTimeout ( Aws::String &&  value)
inline

Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

Definition at line 769 of file StartWorkflowExecutionRequest.h.

◆ WithTaskStartToCloseTimeout() [3/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithTaskStartToCloseTimeout ( const char *  value)
inline

Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

Definition at line 783 of file StartWorkflowExecutionRequest.h.

◆ WithWorkflowId() [1/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithWorkflowId ( const Aws::String value)
inline

The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time within the same domain.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 164 of file StartWorkflowExecutionRequest.h.

◆ WithWorkflowId() [2/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithWorkflowId ( Aws::String &&  value)
inline

The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time within the same domain.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 178 of file StartWorkflowExecutionRequest.h.

◆ WithWorkflowId() [3/3]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithWorkflowId ( const char *  value)
inline

The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time within the same domain.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 192 of file StartWorkflowExecutionRequest.h.

◆ WithWorkflowType() [1/2]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithWorkflowType ( const WorkflowType value)
inline

The type of the workflow to start.

Definition at line 218 of file StartWorkflowExecutionRequest.h.

◆ WithWorkflowType() [2/2]

StartWorkflowExecutionRequest& Aws::SWF::Model::StartWorkflowExecutionRequest::WithWorkflowType ( WorkflowType &&  value)
inline

The type of the workflow to start.

Definition at line 223 of file StartWorkflowExecutionRequest.h.

◆ WorkflowIdHasBeenSet()

bool Aws::SWF::Model::StartWorkflowExecutionRequest::WorkflowIdHasBeenSet ( ) const
inline

The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time within the same domain.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 108 of file StartWorkflowExecutionRequest.h.

◆ WorkflowTypeHasBeenSet()

bool Aws::SWF::Model::StartWorkflowExecutionRequest::WorkflowTypeHasBeenSet ( ) const
inline

The type of the workflow to start.

Definition at line 203 of file StartWorkflowExecutionRequest.h.


The documentation for this class was generated from the following file: