{
"api_version": "2012-01-25",
"type": "json",
"json_version": 1.0,
"target_prefix": "SimpleWorkflowService",
"signature_version": "v4",
"timestamp_format": "unixTimestamp",
"service_full_name": "Amazon Simple Workflow Service",
"service_abbreviation": "Amazon SWF",
"endpoint_prefix": "swf",
"documentation": "\n
The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate\n work across distributed components. In Amazon SWF, a
Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about\n underlying complexities such as tracking their progress and maintaining their state.
\n\nThis documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see\n the Amazon SWF Developer Guide.
\n ", "operations": { "CountClosedWorkflowExecutions": { "name": "CountClosedWorkflowExecutions", "input": { "shape_name": "CountClosedWorkflowExecutionsInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\nThe name of the domain containing the workflow executions to count.
\n ", "required": true }, "startTimeFilter": { "shape_name": "ExecutionTimeFilter", "type": "structure", "members": { "oldestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n Specifies the oldest start or close date and time to return.\n
\n ", "required": true }, "latestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n Specifies the latest start or close date and time to return.\n
\n " } }, "documentation": "\n\n If specified, only workflow executions that meet the start time criteria of the filter are counted.\n
\nstartTimeFilter
and closeTimeFilter
are mutually exclusive.\n You must specify one of these in a request but not both.\n Specifies the oldest start or close date and time to return.\n
\n ", "required": true }, "latestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n Specifies the latest start or close date and time to return.\n
\n " } }, "documentation": "\n\n If specified, only workflow executions that meet the close time criteria of the filter are counted.\n
\nstartTimeFilter
and closeTimeFilter
are mutually exclusive.\n You must specify one of these in a request but not both.\n The workflowId to pass of match the criteria of this filter.\n
\n ", "required": true } }, "documentation": "\nIf specified, only workflow executions matching the WorkflowId
in the filter are counted.
closeStatusFilter
, executionFilter
, typeFilter
and\n tagFilter
are mutually exclusive. You can specify at most one of these in a request.\n Name of the workflow type.\n This field is required.\n
\n ", "required": true }, "version": { "shape_name": "VersionOptional", "type": "string", "max_length": 64, "documentation": "\n\n Version of the workflow type.\n
\n " } }, "documentation": "\n\n If specified, indicates the type of the workflow executions to be counted.\n
\ncloseStatusFilter
, executionFilter
, typeFilter
and tagFilter
\n are mutually exclusive. You can specify at most one of these in a request.\n Specifies the tag that must be associated with the execution for it to meet the filter criteria.\n This field is required.\n
\n ", "required": true } }, "documentation": "\n\n If specified, only executions that have a tag that matches the filter are counted.\n
\ncloseStatusFilter
, executionFilter
, typeFilter
and tagFilter
\n are mutually exclusive. You can specify at most one of these in a request.\n The close status that must match the close status of an execution for it to meet the criteria of this filter. This\n field is required.\n
\n ", "required": true } }, "documentation": "\n\n If specified, only workflow executions that match this close status are counted.\n This filter has an affect only if executionStatus
\n is specified as CLOSED
.\n
closeStatusFilter
, executionFilter
, typeFilter
and tagFilter
\n are mutually exclusive. You can specify at most one of these in a request.\n The number of workflow executions.\n
\n ", "required": true }, "truncated": { "shape_name": "Truncated", "type": "boolean", "documentation": "\n\n If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.\n
\n " } }, "documentation": "\n\n Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions\n
\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\nReturns the number of closed workflow executions within the given domain that meet the specified filtering\n criteria.
\n\nAccess Control
\n\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\n\nUse a Resource
element with the domain name to limit the action to only specified\n 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\n 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\n swf:typeFilter.version
.
If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside\n the specified constraints, the action fails by throwing OperationNotPermitted
. For details and\n example IAM policies, see Using IAM to Manage Access to\n Amazon SWF Workflows.
\n The name of the domain containing the workflow executions to count.\n
\n ", "required": true }, "startTimeFilter": { "shape_name": "ExecutionTimeFilter", "type": "structure", "members": { "oldestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n Specifies the oldest start or close date and time to return.\n
\n ", "required": true }, "latestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n Specifies the latest start or close date and time to return.\n
\n " } }, "documentation": "\n\n Specifies the start time criteria that workflow executions must meet in order to be counted.\n
\n ", "required": true }, "typeFilter": { "shape_name": "WorkflowTypeFilter", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n Name of the workflow type.\n This field is required.\n
\n ", "required": true }, "version": { "shape_name": "VersionOptional", "type": "string", "max_length": 64, "documentation": "\n\n Version of the workflow type.\n
\n " } }, "documentation": "\n\n Specifies the type of the workflow executions to be counted.\n
\nexecutionFilter
, typeFilter
and tagFilter
\n are mutually exclusive. You can specify at most one of these in a request.\n Specifies the tag that must be associated with the execution for it to meet the filter criteria.\n This field is required.\n
\n ", "required": true } }, "documentation": "\n\n If specified, only executions that have a tag that matches the filter are counted.\n
\nexecutionFilter
, typeFilter
and tagFilter
\n are mutually exclusive. You can specify at most one of these in a request.\n The workflowId to pass of match the criteria of this filter.\n
\n ", "required": true } }, "documentation": "\n\n If specified, only workflow executions matching the WorkflowId
in the filter are counted.\n
executionFilter
, typeFilter
and tagFilter
\n are mutually exclusive. You can specify at most one of these in a request.\n The number of workflow executions.\n
\n ", "required": true }, "truncated": { "shape_name": "Truncated", "type": "boolean", "documentation": "\n\n If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.\n
\n " } }, "documentation": "\n\n Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions\n
\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Returns the number of open workflow executions within the given domain that meet the specified filtering\n criteria.\n
\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.Condition
element with the appropriate keys.\n 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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain that contains the task list.\n
\n ", "required": true }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n The name of the task list.\n
\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "PendingTaskCount", "type": "structure", "members": { "count": { "shape_name": "Count", "type": "integer", "min_length": 0, "documentation": "\n\n The number of tasks in the task list.\n
\n ", "required": true }, "truncated": { "shape_name": "Truncated", "type": "boolean", "documentation": "\n\n If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.\n
\n " } }, "documentation": "\n\n Contains the count of tasks in a task list.\n
\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact.\n If you specify a task list that no activity task was ever scheduled in then 0 will be returned.\n
\n\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain that contains the task list.\n
\n ", "required": true }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n The name of the task list.\n
\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "PendingTaskCount", "type": "structure", "members": { "count": { "shape_name": "Count", "type": "integer", "min_length": 0, "documentation": "\n\n The number of tasks in the task list.\n
\n ", "required": true }, "truncated": { "shape_name": "Truncated", "type": "boolean", "documentation": "\n\n If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.\n
\n " } }, "documentation": "\n\n Contains the count of tasks in a task list.\n
\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact.\n If you specify a task list that no decision task was ever scheduled in then 0 will be returned.\n
\n\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain in which the activity type is registered.\n
\n ", "required": true }, "activityType": { "shape_name": "ActivityType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of this activity.\n
\n The version of this activity.\n
\n The activity type to deprecate.\n
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "TypeDeprecatedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the specified activity or workflow type was already deprecated.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Deprecates the specified activity type.\n After an activity type has been deprecated, you cannot create new tasks of that activity type.\n Tasks of this type that were scheduled before the type was deprecated will continue to run.\n
\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.Condition
element with the appropriate keys.\n activityType.name
: String constraint. The key is swf:activityType.name
.activityType.version
: String constraint. The key is swf:activityType.version
.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain to deprecate.\n
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "DomainDeprecatedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the specified domain has been deprecated.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions\n or register new types. However, you can still use visibility actions on this domain.\n Deprecating a domain also deprecates all activity and workflow types registered in the domain.\n Executions that were started before the domain was deprecated will continue to run.\n
\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain in which the workflow type is registered.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The workflow type to deprecate.\n
\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "TypeDeprecatedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the specified activity or workflow type was already deprecated.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions\n of that type. Executions that were started before the type was deprecated will continue to run.\n A deprecated workflow type may still be used when calling visibility actions.\n
\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.Condition
element with the appropriate keys.\n workflowType.name
: String constraint. The key is swf:workflowType.name
.workflowType.version
: String constraint. The key is swf:workflowType.version
.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain in which the activity type is registered.\n
\n ", "required": true }, "activityType": { "shape_name": "ActivityType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of this activity.\n
\n The version of this activity.\n
\n The activity type to describe.\n
\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "ActivityTypeDetail", "type": "structure", "members": { "typeInfo": { "shape_name": "ActivityTypeInfo", "type": "structure", "members": { "activityType": { "shape_name": "ActivityType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of this activity.\n
\n The version of this activity.\n
\n The ActivityType type structure representing the activity type.\n
\n ", "required": true }, "status": { "shape_name": "RegistrationStatus", "type": "string", "enum": [ "REGISTERED", "DEPRECATED" ], "documentation": "\n\n The current status of the activity type.\n
\n ", "required": true }, "description": { "shape_name": "Description", "type": "string", "max_length": 1024, "documentation": "\n\n The description of the activity type provided in RegisterActivityType.\n
\n " }, "creationDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n The date and time this activity type was created through RegisterActivityType.\n
\n ", "required": true }, "deprecationDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n If DEPRECATED, the date and time DeprecateActivityType was called.\n
\n " } }, "documentation": "\n\n General information about the activity type.\n
\n\n The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.\n
\n\n The optional default maximum duration for tasks of an activity type specified when\n registering the activity type. You can\n override this default when scheduling a task through the ScheduleActivityTask
Decision.\n
The valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The optional default maximum time, specified when registering the activity type,\n before which a worker processing a task must report progress by\n calling RecordActivityTaskHeartbeat.\n You can override this default when scheduling a task through the ScheduleActivityTask
Decision.\n If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker\n receives an UnknownResource
fault.\n In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.\n
The valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n The optional default task list specified for this activity type at registration. This default task list is used\n if a task list is not provided when a task is scheduled through the ScheduleActivityTask
Decision.\n You can override this default when scheduling a task through the ScheduleActivityTask
Decision.\n
\n The optional default maximum duration, specified when registering the activity type,\n that a task of an activity type can wait before being assigned to a worker.\n You can override this default when scheduling a task through the ScheduleActivityTask
Decision.\n
The valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The optional default maximum duration, specified when registering the activity type,\n for tasks of this activity type.\n You can override this default when scheduling a task through the ScheduleActivityTask
Decision.\n
The valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The configuration settings registered with the activity type.\n
\n ", "required": true } }, "documentation": "\n\n Detailed information about an activity type.\n
\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Returns information about the specified activity type. This includes\n configuration settings provided at registration time as well as other general information about the type.\n
\n\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.Condition
element with the appropriate keys.\n activityType.name
: String constraint. The key is swf:activityType.name
.activityType.version
: String constraint. The key is swf:activityType.version
.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain to describe.\n
\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DomainDetail", "type": "structure", "members": { "domainInfo": { "shape_name": "DomainInfo", "type": "structure", "members": { "name": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the domain. This name is unique within the account.\n
\n ", "required": true }, "status": { "shape_name": "RegistrationStatus", "type": "string", "enum": [ "REGISTERED", "DEPRECATED" ], "documentation": "\n\n The status of the domain:\n
\n\n The description of the domain provided through RegisterDomain.\n
\n " } }, "documentation": "\n\n Contains general information about a domain.\n
\n ", "required": true }, "configuration": { "shape_name": "DomainConfiguration", "type": "structure", "members": { "workflowExecutionRetentionPeriodInDays": { "shape_name": "DurationInDays", "type": "string", "min_length": 1, "max_length": 8, "documentation": "\n\n The retention period for workflow executions in this domain.\n
\n ", "required": true } }, "documentation": "\n\n Contains the configuration settings of a domain.\n
\n ", "required": true } }, "documentation": "\n\n Contains details of a domain.\n
\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Returns information about the specified domain including description and status.\n
\n\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain containing the workflow execution.\n
\n ", "required": true }, "execution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The workflow execution to describe.\n
\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "WorkflowExecutionDetail", "type": "structure", "members": { "executionInfo": { "shape_name": "WorkflowExecutionInfo", "type": "structure", "members": { "execution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The workflow execution this information is about.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the workflow execution.\n
\n ", "required": true }, "startTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n The time when the execution was started.\n
\n ", "required": true }, "closeTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n The time when the workflow execution was closed. Set only if the execution status is CLOSED.\n
\n " }, "executionStatus": { "shape_name": "ExecutionStatus", "enum": [ "OPEN", "CLOSED" ], "type": "string", "documentation": "\n\n The current status of the execution.\n
\n ", "required": true }, "closeStatus": { "shape_name": "CloseStatus", "enum": [ "COMPLETED", "FAILED", "CANCELED", "TERMINATED", "CONTINUED_AS_NEW", "TIMED_OUT" ], "type": "string", "documentation": "\n\n If the execution status is closed then this specifies how the execution was closed:
\n\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n If this workflow execution is a child of another execution then contains\n the workflow execution that started this execution.\n
\n " }, "tagList": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": null }, "max_length": 5, "documentation": "\n\n The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions\n of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.\n
\n " }, "cancelRequested": { "shape_name": "Canceled", "type": "boolean", "documentation": "\n\n Set to true if a cancellation is requested for this workflow execution.\n
\n " } }, "documentation": "\n\n Information about the workflow execution.\n
\n ", "required": true }, "executionConfiguration": { "shape_name": "WorkflowExecutionConfiguration", "type": "structure", "members": { "taskStartToCloseTimeout": { "shape_name": "DurationInSeconds", "type": "string", "min_length": 1, "max_length": 8, "documentation": "\n\n The maximum duration allowed for decision tasks for this workflow execution.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The total duration for this workflow execution.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n The task list used for the decision tasks generated for this workflow execution.\n
\n ", "required": true }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n\n The policy to use for the child workflow executions if this workflow execution is terminated,\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n The supported child policies are:
\nWorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n \n The configuration settings for this workflow execution including timeout values, tasklist etc.\n
\n ", "required": true }, "openCounts": { "shape_name": "WorkflowExecutionOpenCounts", "type": "structure", "members": { "openActivityTasks": { "shape_name": "Count", "type": "integer", "min_length": 0, "documentation": "\n\n The count of activity tasks whose status is OPEN.\n
\n ", "required": true }, "openDecisionTasks": { "shape_name": "OpenDecisionTasksCount", "type": "integer", "min_length": 0, "max_length": 1, "documentation": "\n\n The count of decision tasks whose status is OPEN.\n A workflow execution can have at most one open decision task.\n
\n ", "required": true }, "openTimers": { "shape_name": "Count", "type": "integer", "min_length": 0, "documentation": "\n\n The count of timers started by this workflow execution that have not fired yet.\n
\n ", "required": true }, "openChildWorkflowExecutions": { "shape_name": "Count", "type": "integer", "min_length": 0, "documentation": "\n\n The count of child workflow executions whose status is OPEN.\n
\n ", "required": true } }, "documentation": "\n\n The number of tasks for this workflow execution. This includes open and closed tasks of all types.\n
\n ", "required": true }, "latestActivityTaskTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the\n workflow has not made progress for an unusually long period of time and might require a corrective action.\n
\n " }, "latestExecutionContext": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The latest executionContext provided by the decider for this workflow execution.\n A decider can provide an executionContext, which is a free form string, when closing a decision task\n using RespondDecisionTaskCompleted.\n
\n " } }, "documentation": "\n\n Contains details about a workflow execution.\n
\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Returns information about the specified workflow execution including its type and some statistics.\n
\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain in which this workflow type is registered.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The workflow type to describe.\n
\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "WorkflowTypeDetail", "type": "structure", "members": { "typeInfo": { "shape_name": "WorkflowTypeInfo", "type": "structure", "members": { "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The workflow type this information is about.\n
\n ", "required": true }, "status": { "shape_name": "RegistrationStatus", "type": "string", "enum": [ "REGISTERED", "DEPRECATED" ], "documentation": "\n\n The current status of the workflow type.\n
\n ", "required": true }, "description": { "shape_name": "Description", "type": "string", "max_length": 1024, "documentation": "\n\n The description of the type registered through RegisterWorkflowType.\n
\n " }, "creationDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n The date when this type was registered.\n
\n ", "required": true }, "deprecationDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n If the type is in deprecated state, then it is set to the date when the type was deprecated.\n
\n " } }, "documentation": "\nGeneral information about the workflow type.
\nThe status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.
\n\n The optional default maximum duration, specified when registering the workflow type, that a decision task for executions\n of this workflow type might take before returning completion or\n failure. If the task does not close in the specified time then the task is automatically timed out and rescheduled. If\n the decider eventually reports a completion or failure, it is ignored.\n This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or\n the StartChildWorkflowExecution
Decision.\n
The valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The optional default maximum duration, specified when registering the workflow type, for executions of this workflow type.\n This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or\n the StartChildWorkflowExecution
Decision.\n
The valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n The optional default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type.\n This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or\n the StartChildWorkflowExecution
Decision.\n
\n The optional default policy to use for the child workflow executions when a workflow execution of this type is terminated,\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or\n the StartChildWorkflowExecution
Decision.\n The supported child policies are:
WorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n Configuration settings of the workflow type registered through RegisterWorkflowType
\n ", "required": true } }, "documentation": "\nContains details about a workflow type.
\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Returns information about the specified workflow type. This includes\n configuration settings specified when the type was registered and other information\n such as creation date, current status, etc.\n
\n\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.Condition
element with the appropriate keys.\n workflowType.name
: String constraint. The key is swf:workflowType.name
.workflowType.version
: String constraint. The key is swf:workflowType.version
.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain containing the workflow execution.\n
\n ", "required": true }, "execution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n Specifies the workflow execution for which to return the history.\n
\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n\n If a NextPageToken
is returned, the result has more than one pages. To get the next page,\n repeat the call and specify the nextPageToken with all other arguments unchanged.\n
\n Specifies the maximum number of history events returned in one page.\n The next page in the result is identified by the NextPageToken
returned.\n By default 100 history events are returned in a page but the caller can override this\n value to a page size smaller than the default. You cannot specify a page size\n larger than 100.\n Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n
\n When set to true
, returns the events in reverse order. By default the results are returned in ascending order\n of the eventTimeStamp
of the events.\n
\n The date and time when the event occurred.\n
\n ", "required": true }, "eventType": { "shape_name": "EventType", "type": "string", "enum": [ "WorkflowExecutionStarted", "WorkflowExecutionCancelRequested", "WorkflowExecutionCompleted", "CompleteWorkflowExecutionFailed", "WorkflowExecutionFailed", "FailWorkflowExecutionFailed", "WorkflowExecutionTimedOut", "WorkflowExecutionCanceled", "CancelWorkflowExecutionFailed", "WorkflowExecutionContinuedAsNew", "ContinueAsNewWorkflowExecutionFailed", "WorkflowExecutionTerminated", "DecisionTaskScheduled", "DecisionTaskStarted", "DecisionTaskCompleted", "DecisionTaskTimedOut", "ActivityTaskScheduled", "ScheduleActivityTaskFailed", "ActivityTaskStarted", "ActivityTaskCompleted", "ActivityTaskFailed", "ActivityTaskTimedOut", "ActivityTaskCanceled", "ActivityTaskCancelRequested", "RequestCancelActivityTaskFailed", "WorkflowExecutionSignaled", "MarkerRecorded", "RecordMarkerFailed", "TimerStarted", "StartTimerFailed", "TimerFired", "TimerCanceled", "CancelTimerFailed", "StartChildWorkflowExecutionInitiated", "StartChildWorkflowExecutionFailed", "ChildWorkflowExecutionStarted", "ChildWorkflowExecutionCompleted", "ChildWorkflowExecutionFailed", "ChildWorkflowExecutionTimedOut", "ChildWorkflowExecutionCanceled", "ChildWorkflowExecutionTerminated", "SignalExternalWorkflowExecutionInitiated", "SignalExternalWorkflowExecutionFailed", "ExternalWorkflowExecutionSignaled", "RequestCancelExternalWorkflowExecutionInitiated", "RequestCancelExternalWorkflowExecutionFailed", "ExternalWorkflowExecutionCancelRequested" ], "documentation": "\n\n The type of the history event.\n
\n ", "required": true }, "eventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The system generated id of the event. This id uniquely identifies the event with in the workflow execution history.\n
\n ", "required": true }, "workflowExecutionStartedEventAttributes": { "shape_name": "WorkflowExecutionStartedEventAttributes", "type": "structure", "members": { "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The input provided to the workflow execution (if any).\n
\n " }, "executionStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n The maximum duration for this workflow execution.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The maximum duration of decision tasks for this workflow type.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The policy to use for the child workflow executions if this workflow execution is terminated,\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n\n The supported child policies are:\n
WorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n \n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n The name of the task list for scheduling the decision tasks for this workflow execution.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The workflow type of this execution.\n
\n ", "required": true }, "tagList": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": null }, "max_length": 5, "documentation": "\n\n The list of tags associated with this workflow execution. An execution can have up to 5 tags.\n
\n " }, "continuedExecutionRunId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n\n If this workflow execution was started due to a ContinueAsNewWorkflowExecution
decision, then\n it contains the runId
of the previous workflow execution that was closed and continued as this execution.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The source workflow execution that started this workflow execution. The member is not set if the workflow execution was\n not started by a workflow.\n
\n " }, "parentInitiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the StartChildWorkflowExecutionInitiated
event corresponding to the\n StartChildWorkflowExecution
Decision to start this workflow execution. The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type WorkflowExecutionStarted
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The result produced by the workflow execution upon successful completion.\n
\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the CompleteWorkflowExecution
decision to complete this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type WorkflowExecutionCompleted
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
\n\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the CompleteWorkflowExecution
decision to complete this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type CompleteWorkflowExecutionFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The descriptive reason provided for the failure (if any).\n
\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The details of the failure (if any).\n
\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the FailWorkflowExecution
decision to fail this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type WorkflowExecutionFailed
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
\n\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the FailWorkflowExecution
decision to fail this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type FailWorkflowExecutionFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The type of timeout that caused this event.\n
\n ", "required": true }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n\n The policy used for the child workflow executions of this workflow execution.\n The supported child policies are:\n
WorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n \n If the event is of type WorkflowExecutionTimedOut
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n Details for the cancellation (if any).\n
\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the CancelWorkflowExecution
decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type WorkflowExecutionCanceled
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
\n\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the CancelWorkflowExecution
decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type CancelWorkflowExecutionFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The input provided to the new workflow execution.\n
\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the ContinueAsNewWorkflowExecution
decision that started this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n The runId
of the new workflow execution.\n
\n The total duration allowed for the new workflow execution.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n Represents a task list.\n
\n ", "required": true }, "taskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n The maximum duration of decision tasks for the new workflow execution.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The policy to use for the child workflow executions of the new execution if it is terminated\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
\n\nThe supported child policies are:
\nWorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n \n The list of tags associated with the new workflow execution.\n
\n " }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n Represents a workflow type.\n
\n ", "required": true } }, "documentation": "\n\n If the event is of type WorkflowExecutionContinuedAsNew
then this member is set and\n provides detailed information about the event. It is not set for other event types.\n
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
\n\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the ContinueAsNewWorkflowExecution
decision that started this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type ContinueAsNewWorkflowExecutionFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The reason provided for the termination (if any).\n
\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The details provided for the termination (if any).\n
\n " }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n\n The policy used for the child workflow executions of this workflow execution.\n The supported child policies are:
\nWorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n \n If set, indicates that the workflow execution was automatically terminated, and specifies the cause.\n This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.\n
\n " } }, "documentation": "\n\n If the event is of type WorkflowExecutionTerminated
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The external workflow execution for which the cancellation was requested.\n
\n " }, "externalInitiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the RequestCancelExternalWorkflowExecutionInitiated
event corresponding to the\n RequestCancelExternalWorkflowExecution
decision to cancel this workflow execution.The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause.\n This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.\n
\n " } }, "documentation": "\n\n If the event is of type WorkflowExecutionCancelRequested
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n The name of the task list in which the decision task was scheduled.\n
\n ", "required": true }, "startToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n The maximum duration for this decision task. The task is considered timed out if it does not\n completed within this duration.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n If the event is of type DecisionTaskScheduled
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n Identity of the decider making the request. This enables diagnostic tracing\n when problems arise. The form of this identity is user defined.\n
\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskScheduled
event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type DecisionTaskStarted
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n User defined context for the workflow execution.\n
\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskScheduled
event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the DecisionTaskStarted
event recorded when this decision task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type DecisionTaskCompleted
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The type of timeout that expired before the decision task could be completed.\n
\n ", "required": true }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskScheduled
event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the DecisionTaskStarted
event recorded when this decision task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type DecisionTaskTimedOut
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The name of this activity.\n
\n The version of this activity.\n
\n The type of the activity task.\n
\n ", "required": true }, "activityId": { "shape_name": "ActivityId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The unique id of the activity task.\n
\n ", "required": true }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The input provided to the activity task.\n
\n " }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks. This data is not sent to the activity.\n
\n " }, "scheduleToStartTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n The maximum amount of time the activity task can wait to be assigned to a worker.\n
\n " }, "scheduleToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n The maximum amount of time for this activity task.\n
\n " }, "startToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n The maximum amount of time a worker may take to process the activity task.\n
\n " }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n The task list in which the activity task has been scheduled.\n
\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskCompleted
event corresponding to the decision that\n resulted in the scheduling of this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The maximum time before which the worker processing this task must report progress by\n calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out.\n If the worker subsequently attempts to record a heartbeat or return a result, it will be ignored.\n
\n " } }, "documentation": "\n\n If the event is of type ActivityTaskScheduled
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n Identity of the worker that was assigned this task. This aids diagnostics\n when problems arise. The form of this identity is user defined.\n
\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the ActivityTaskScheduled
event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ActivityTaskStarted
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The results of the activity task (if any).\n
\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the ActivityTaskScheduled
event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the ActivityTaskStarted
event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ActivityTaskCompleted
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The reason provided for the failure (if any).\n
\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The details of the failure (if any).\n
\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the ActivityTaskScheduled
event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the ActivityTaskStarted
event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ActivityTaskFailed
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The type of the timeout that caused this event.\n
\n ", "required": true }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the ActivityTaskScheduled
event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the ActivityTaskStarted
event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n Contains the content of the details
parameter for the last call made by the activity to RecordActivityTaskHeartbeat
.\n
\n If the event is of type ActivityTaskTimedOut
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n Details of the cancellation (if any).\n
\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the ActivityTaskScheduled
event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the ActivityTaskStarted
event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If set, contains the Id of the last ActivityTaskCancelRequested
event recorded for this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ActivityTaskCanceled
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the RequestCancelActivityTask
decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n The unique ID of the task.\n
\n ", "required": true } }, "documentation": "\n\n If the event is of type ActivityTaskcancelRequested
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The name of the signal received. The decider can use the signal name and inputs to determine\n how to the process the signal.\n
\n ", "required": true }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Inputs provided with the signal (if any). The decider can use the signal name and inputs to determine\n how to process the signal.\n
\n " }, "externalWorkflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The workflow execution that sent the signal. This is set only of the signal was sent by another\n workflow execution.\n
\n " }, "externalInitiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the SignalExternalWorkflowExecutionInitiated
event corresponding to the\n SignalExternalWorkflow
decision to signal this workflow execution.The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event. This field is set only if the signal was initiated by another workflow execution.\n\n
\n If the event is of type WorkflowExecutionSignaled
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The name of the marker.\n
\n ", "required": true }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Details of the marker (if any).\n
\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the RecordMarker
decision that requested this marker.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type MarkerRecorded
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
The marker's name.
\n ", "required": true }, "cause": { "shape_name": "RecordMarkerFailedCause", "type": "string", "enum": [ "OPERATION_NOT_PERMITTED" ], "documentation": "\nThe cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.
\n\nThe id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the RecordMarkerFailed
decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.
\n If the event is of type DecisionTaskFailed
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The unique Id of the timer that was started.\n
\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n
\n " }, "startToFireTimeout": { "shape_name": "DurationInSeconds", "type": "string", "min_length": 1, "max_length": 8, "documentation": "\n\n The duration of time after which the timer will fire.\n
\nThe duration is specified in seconds. The valid values are integers greater than or equal to 0.
\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the StartTimer
decision for this activity task.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type TimerStarted
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The unique Id of the timer that fired.\n
\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the TimerStarted
event that was recorded when this timer was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type TimerFired
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The unique Id of the timer that was canceled.\n
\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the TimerStarted
event that was recorded when this timer was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the CancelTimer
decision to cancel this timer.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type TimerCanceled
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The workflowId
of the child workflow execution.\n
\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the child workflow execution.\n
\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Optional data attached to the event that can be used by the decider in subsequent decision\n tasks. This data is not sent to the activity.\n
\n " }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The inputs provided to the child workflow execution (if any).\n
\n " }, "executionStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration,\n it will be timed out and force terminated.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n The name of the task list used for the decision tasks of the child workflow execution.\n
\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the StartChildWorkflowExecution
Decision to request this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n The policy to use for the child workflow executions if this execution gets terminated by explicitly calling\n the TerminateWorkflowExecution action or due to an expired timeout.
\nThe supported child policies are:
\n\nWorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n \n The maximum duration allowed for the decision tasks for this workflow execution.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The list of tags to associated with the child workflow execution.\n
\n " } }, "documentation": "\n\n If the event is of type StartChildWorkflowExecutionInitiated
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The child workflow execution that was started.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the child workflow execution.\n
\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the StartChildWorkflowExecutionInitiated
event corresponding to the\n StartChildWorkflowExecution
Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ChildWorkflowExecutionStarted
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The child workflow execution that was completed.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the child workflow execution.\n
\n ", "required": true }, "result": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The result of the child workflow execution (if any).\n
\n " }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the StartChildWorkflowExecutionInitiated
event corresponding to the\n StartChildWorkflowExecution
Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the ChildWorkflowExecutionStarted
event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ChildWorkflowExecutionCompleted
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The child workflow execution that failed.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the child workflow execution.\n
\n ", "required": true }, "reason": { "shape_name": "FailureReason", "type": "string", "max_length": 256, "documentation": "\n\n The reason for the failure (if provided).\n
\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The details of the failure (if provided).\n
\n " }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the StartChildWorkflowExecutionInitiated
event corresponding to the\n StartChildWorkflowExecution
Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the ChildWorkflowExecutionStarted
event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ChildWorkflowExecutionFailed
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The child workflow execution that timed out.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the child workflow execution.\n
\n ", "required": true }, "timeoutType": { "shape_name": "WorkflowExecutionTimeoutType", "type": "string", "enum": [ "START_TO_CLOSE" ], "documentation": "\n\n The type of the timeout that caused the child workflow execution to time out.\n
\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the StartChildWorkflowExecutionInitiated
event corresponding to the\n StartChildWorkflowExecution
Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the ChildWorkflowExecutionStarted
event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ChildWorkflowExecutionTimedOut
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The child workflow execution that was canceled.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the child workflow execution.\n
\n ", "required": true }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Details of the cancellation (if provided).\n
\n " }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the StartChildWorkflowExecutionInitiated
event corresponding to the\n StartChildWorkflowExecution
Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the ChildWorkflowExecutionStarted
event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ChildWorkflowExecutionCanceled
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The child workflow execution that was terminated.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the child workflow execution.\n
\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the StartChildWorkflowExecutionInitiated
event corresponding to the\n StartChildWorkflowExecution
Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the ChildWorkflowExecutionStarted
event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ChildWorkflowExecutionTerminated
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The workflowId
of the external workflow execution.\n
\n The runId
of the external workflow execution to send the signal to.\n
\n The name of the signal.\n
\n ", "required": true }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Input provided to the signal (if any).\n
\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that resulted in\n the SignalExternalWorkflowExecution
decision for this signal.\n This information can be useful for diagnosing problems by tracing back the cause of events leading up to this event.\n
\n Optional data attached to the event that can be used by the decider in subsequent decision\n tasks.\n
\n " } }, "documentation": "\n\n If the event is of type SignalExternalWorkflowExecutionInitiated
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The external workflow execution that the signal was delivered to.\n
\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the SignalExternalWorkflowExecutionInitiated
event corresponding to the\n SignalExternalWorkflowExecution
decision to request this signal.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ExternalWorkflowExecutionSignaled
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The workflowId
of the external workflow execution that the signal was being delivered to.\n
\n The runId
of the external workflow execution that the signal was being delivered to.\n
The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.
\n\n\n The id of the SignalExternalWorkflowExecutionInitiated
event corresponding to the\n SignalExternalWorkflowExecution
decision to request this signal.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The id of the DecisionTaskCompleted
event corresponding to the decision task that resulted in\n the SignalExternalWorkflowExecution
decision for this signal.\n This information can be useful for diagnosing problems by tracing back the cause of events leading up to this event.\n
If the event is of type SignalExternalWorkflowExecutionFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The external workflow execution to which the cancellation request was delivered.\n
\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the RequestCancelExternalWorkflowExecutionInitiated
event corresponding to the\n RequestCancelExternalWorkflowExecution
decision to cancel this external workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ExternalWorkflowExecutionCancelRequested
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The workflowId
of the external workflow execution to be canceled.\n
\n The runId
of the external workflow execution to be canceled.\n
\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the RequestCancelExternalWorkflowExecution
decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n
\n " } }, "documentation": "\n\n If the event is of type RequestCancelExternalWorkflowExecutionInitiated
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The workflowId
of the external workflow to which the cancel request was to be delivered.\n
\n The runId
of the external workflow execution.\n
The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.
\n\n\n The id of the RequestCancelExternalWorkflowExecutionInitiated
event corresponding to the\n RequestCancelExternalWorkflowExecution
decision to cancel this external workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the RequestCancelExternalWorkflowExecution
decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type RequestCancelExternalWorkflowExecutionFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The name of this activity.\n
\n The version of this activity.\n
\n The activity type provided in the ScheduleActivityTask
decision that failed.\n
\n The activityId provided in the ScheduleActivityTask
decision that failed.\n
The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.
\n\n\n The id of the DecisionTaskCompleted
event corresponding to the decision that\n resulted in the scheduling of this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ScheduleActivityTaskFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The activityId provided in the RequestCancelActivityTask
decision that failed.\n
The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.
\n\nThe id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the RequestCancelActivityTask
decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.
\n If the event is of type RequestCancelActivityTaskFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The timerId provided in the StartTimer
decision that failed.\n
The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.
\n\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the StartTimer
decision for this activity task.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type StartTimerFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The timerId provided in the CancelTimer
decision that failed.\n
\n The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.\n
\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the CancelTimer
decision to cancel this timer.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type CancelTimerFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The workflow type provided in the StartChildWorkflowExecution
Decision that failed.\n
The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.
\n\n\n The workflowId
of the child workflow execution.\n
\n The id of the StartChildWorkflowExecutionInitiated
event corresponding to the\n StartChildWorkflowExecution
Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the StartChildWorkflowExecution
Decision to request this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type StartChildWorkflowExecutionFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
Event within a workflow execution. A history event can be one of these types:
\nRequestCancelActivityTask
decision was\n received by the system.\n RecordMarker
decision.\n StartTimer
decision.\n \n The list of history events.\n
\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n\n The token for the next page. If set, the history consists of more than one page and the next page can be retrieved by repeating the request\n with this token and all other arguments unchanged.\n
\n " } }, "documentation": "\n\n Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of\n the events related to all tasks and events in the life of the workflow execution.\n
\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Returns the history of the specified workflow execution.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the nextPageToken
returned by the initial call.\n
Access Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain in which the activity types have been registered.\n
\n ", "required": true }, "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n If specified, only lists the activity types that have this name.\n
\n " }, "registrationStatus": { "shape_name": "RegistrationStatus", "type": "string", "enum": [ "REGISTERED", "DEPRECATED" ], "documentation": "\n\n Specifies the registration status of the activity types to list.\n
\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n\n If on a previous call to this method a NextResultToken
was returned, the results have\n more than one page. To get the next page of results, repeat the call with the nextPageToken
\n and keep all other arguments unchanged.\n
\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size smaller than the default. You cannot specify\n a page size greater than 100.\n Note that the number of types may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n
\n " }, "reverseOrder": { "shape_name": "ReverseOrder", "type": "boolean", "documentation": "\n\n When set to true
, returns the results in reverse order. By default the results are returned in ascending\n alphabetical order of the name
of the activity types.\n
\n The name of this activity.\n
\n The version of this activity.\n
\n The ActivityType type structure representing the activity type.\n
\n ", "required": true }, "status": { "shape_name": "RegistrationStatus", "type": "string", "enum": [ "REGISTERED", "DEPRECATED" ], "documentation": "\n\n The current status of the activity type.\n
\n ", "required": true }, "description": { "shape_name": "Description", "type": "string", "max_length": 1024, "documentation": "\n\n The description of the activity type provided in RegisterActivityType.\n
\n " }, "creationDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n The date and time this activity type was created through RegisterActivityType.\n
\n ", "required": true }, "deprecationDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n If DEPRECATED, the date and time DeprecateActivityType was called.\n
\n " } }, "documentation": "\n\n Detailed information about an activity type.\n
\n " }, "documentation": "\n\n List of activity type information.\n
\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n\n Returns a value if the results are paginated. To get the next page of results, repeat the request\n specifying this token and all other arguments unchanged.\n
\n " } }, "documentation": "\n\n Contains a paginated list of activity type information structures.\n
\n " }, "errors": [ { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " }, { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " } ], "documentation": "\n\n Returns information about all activities registered in the specified domain that match the\n specified name and registration status. The result includes information like creation date, current status of the activity, etc.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the nextPageToken
returned by the initial call.\n
Access Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain that contains the workflow executions to list.\n
\n ", "required": true }, "startTimeFilter": { "shape_name": "ExecutionTimeFilter", "type": "structure", "members": { "oldestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n Specifies the oldest start or close date and time to return.\n
\n ", "required": true }, "latestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n Specifies the latest start or close date and time to return.\n
\n " } }, "documentation": "\n\n If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.\n Also, if this parameter is specified, the returned results are ordered by their start times.\n
\nstartTimeFilter
and closeTimeFilter
are mutually exclusive.\n You must specify one of these in a request but not both.\n Specifies the oldest start or close date and time to return.\n
\n ", "required": true }, "latestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n Specifies the latest start or close date and time to return.\n
\n " } }, "documentation": "\n\n If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter.\n Also, if this parameter is specified, the returned results are ordered by their close times.\n
\nstartTimeFilter
and closeTimeFilter
are mutually exclusive.\n You must specify one of these in a request but not both.\n The workflowId to pass of match the criteria of this filter.\n
\n ", "required": true } }, "documentation": "\n\n If specified, only workflow executions matching the workflow id specified in the filter are returned.\n
\ncloseStatusFilter
, executionFilter
, typeFilter
and tagFilter
\n are mutually exclusive. You can specify at most one of these in a request.\n The close status that must match the close status of an execution for it to meet the criteria of this filter. This\n field is required.\n
\n ", "required": true } }, "documentation": "\n\n If specified, only workflow executions that match this close status are listed.\n For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.\n
\ncloseStatusFilter
, executionFilter
, typeFilter
and tagFilter
\n are mutually exclusive. You can specify at most one of these in a request.\n Name of the workflow type.\n This field is required.\n
\n ", "required": true }, "version": { "shape_name": "VersionOptional", "type": "string", "max_length": 64, "documentation": "\n\n Version of the workflow type.\n
\n " } }, "documentation": "\n\n If specified, only executions of the type specified in the filter are returned.\n
\ncloseStatusFilter
, executionFilter
, typeFilter
and tagFilter
\n are mutually exclusive. You can specify at most one of these in a request.\n Specifies the tag that must be associated with the execution for it to meet the filter criteria.\n This field is required.\n
\n ", "required": true } }, "documentation": "\n\n If specified, only executions that have the matching tag are listed.\n
\ncloseStatusFilter
, executionFilter
, typeFilter
and tagFilter
\n are mutually exclusive. You can specify at most one of these in a request.\n If on a previous call to this method a NextPageToken
was returned, the results are\n being paginated. To get the next page of results, repeat the call with the returned token and\n all other arguments unchanged.\n
\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size smaller than the default. You cannot specify\n a page size greater than 100.\n Note that the number of executions may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n
\n " }, "reverseOrder": { "shape_name": "ReverseOrder", "type": "boolean", "documentation": "\n\n When set to true
, returns the results in reverse order. By default the results are returned in\n descending order of the start or the close time of the executions.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The workflow execution this information is about.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the workflow execution.\n
\n ", "required": true }, "startTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n The time when the execution was started.\n
\n ", "required": true }, "closeTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n The time when the workflow execution was closed. Set only if the execution status is CLOSED.\n
\n " }, "executionStatus": { "shape_name": "ExecutionStatus", "enum": [ "OPEN", "CLOSED" ], "type": "string", "documentation": "\n\n The current status of the execution.\n
\n ", "required": true }, "closeStatus": { "shape_name": "CloseStatus", "enum": [ "COMPLETED", "FAILED", "CANCELED", "TERMINATED", "CONTINUED_AS_NEW", "TIMED_OUT" ], "type": "string", "documentation": "\n\n If the execution status is closed then this specifies how the execution was closed:
\n\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n If this workflow execution is a child of another execution then contains\n the workflow execution that started this execution.\n
\n " }, "tagList": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": null }, "max_length": 5, "documentation": "\n\n The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions\n of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.\n
\n " }, "cancelRequested": { "shape_name": "Canceled", "type": "boolean", "documentation": "\n\n Set to true if a cancellation is requested for this workflow execution.\n
\n " } }, "documentation": "\n\n Contains information about a workflow execution.\n\n \n
\n " }, "documentation": "\n\n The list of workflow information structures.\n
\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n\n The token of the next page in the result. If set, the results have more than one page. The next\n page can be retrieved by repeating the request with this token and all other arguments unchanged.\n
\n " } }, "documentation": "\n\n Contains a paginated list of information about workflow executions.\n
\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.\n
\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.Condition
element with the appropriate keys.\n 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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n If on a previous call to this method a NextPageToken
was returned, the result has\n more than one page. To get the next page of results, repeat the call with the returned token\n and all other arguments unchanged.\n
\n Specifies the registration status of the domains to list.\n
\n ", "required": true }, "maximumPageSize": { "shape_name": "PageSize", "type": "integer", "min_length": 0, "max_length": 1000, "documentation": "\n\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size smaller than the default. You cannot specify\n a page size greater than 100.\n Note that the number of domains may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n
\n " }, "reverseOrder": { "shape_name": "ReverseOrder", "type": "boolean", "documentation": "\n\n When set to true
, returns the results in reverse order. By default the results are returned in ascending\n alphabetical order of the name
of the domains.\n
\n The name of the domain. This name is unique within the account.\n
\n ", "required": true }, "status": { "shape_name": "RegistrationStatus", "type": "string", "enum": [ "REGISTERED", "DEPRECATED" ], "documentation": "\n\n The status of the domain:\n
\n\n The description of the domain provided through RegisterDomain.\n
\n " } }, "documentation": "\n\n Contains general information about a domain.\n
\n " }, "documentation": "\n\n A list of DomainInfo structures.\n
\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n\n Returns a value if the results are paginated. To get the next page of results, repeat the request\n specifying this token and all other arguments unchanged.\n
\n " } }, "documentation": "\n\n Contains a paginated collection of DomainInfo structures.\n
\n " }, "errors": [ { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Returns the list of domains registered in the account.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.\n
\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains. The element must\n be set to arn:aws:swf::AccountID:domain/*\"
, where \u201cAccountID\" is the account ID, with no dashes.Action
element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain that contains the workflow executions to list.\n
\n ", "required": true }, "startTimeFilter": { "shape_name": "ExecutionTimeFilter", "type": "structure", "members": { "oldestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n Specifies the oldest start or close date and time to return.\n
\n ", "required": true }, "latestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n Specifies the latest start or close date and time to return.\n
\n " } }, "documentation": "\n\n Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.\n
\n ", "required": true }, "typeFilter": { "shape_name": "WorkflowTypeFilter", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n Name of the workflow type.\n This field is required.\n
\n ", "required": true }, "version": { "shape_name": "VersionOptional", "type": "string", "max_length": 64, "documentation": "\n\n Version of the workflow type.\n
\n " } }, "documentation": "\n\n If specified, only executions of the type specified in the filter are returned.\n
\nexecutionFilter
, typeFilter
and tagFilter
\n are mutually exclusive. You can specify at most one of these in a request.\n Specifies the tag that must be associated with the execution for it to meet the filter criteria.\n This field is required.\n
\n ", "required": true } }, "documentation": "\n\n If specified, only executions that have the matching tag are listed.\n
\nexecutionFilter
, typeFilter
and tagFilter
\n are mutually exclusive. You can specify at most one of these in a request.\n If on a previous call to this method a NextPageToken
was returned, the results are\n being paginated. To get the next page of results, repeat the call with the returned token and\n all other arguments unchanged.\n
\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size smaller than the default. You cannot specify\n a page size greater than 100.\n Note that the number of executions may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n
\n " }, "reverseOrder": { "shape_name": "ReverseOrder", "type": "boolean", "documentation": "\n\n When set to true
, returns the results in reverse order. By default the results are returned in\n descending order of the start time of the executions.\n
\n The workflowId to pass of match the criteria of this filter.\n
\n ", "required": true } }, "documentation": "\n\n If specified, only workflow executions matching the workflow id specified in the filter are returned.\n
\nexecutionFilter
, typeFilter
and tagFilter
\n are mutually exclusive. You can specify at most one of these in a request.\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The workflow execution this information is about.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the workflow execution.\n
\n ", "required": true }, "startTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n The time when the execution was started.\n
\n ", "required": true }, "closeTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n The time when the workflow execution was closed. Set only if the execution status is CLOSED.\n
\n " }, "executionStatus": { "shape_name": "ExecutionStatus", "enum": [ "OPEN", "CLOSED" ], "type": "string", "documentation": "\n\n The current status of the execution.\n
\n ", "required": true }, "closeStatus": { "shape_name": "CloseStatus", "enum": [ "COMPLETED", "FAILED", "CANCELED", "TERMINATED", "CONTINUED_AS_NEW", "TIMED_OUT" ], "type": "string", "documentation": "\n\n If the execution status is closed then this specifies how the execution was closed:
\n\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n If this workflow execution is a child of another execution then contains\n the workflow execution that started this execution.\n
\n " }, "tagList": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": null }, "max_length": 5, "documentation": "\n\n The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions\n of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.\n
\n " }, "cancelRequested": { "shape_name": "Canceled", "type": "boolean", "documentation": "\n\n Set to true if a cancellation is requested for this workflow execution.\n
\n " } }, "documentation": "\n\n Contains information about a workflow execution.\n\n \n
\n " }, "documentation": "\n\n The list of workflow information structures.\n
\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n\n The token of the next page in the result. If set, the results have more than one page. The next\n page can be retrieved by repeating the request with this token and all other arguments unchanged.\n
\n " } }, "documentation": "\n\n Contains a paginated list of information about workflow executions.\n
\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Returns a list of open workflow executions in the specified domain that meet the filtering criteria.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.\n
\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.Condition
element with the appropriate keys.\n 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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain in which the workflow types have been registered.\n
\n ", "required": true }, "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n If specified, lists the workflow type with this name.\n
\n " }, "registrationStatus": { "shape_name": "RegistrationStatus", "type": "string", "enum": [ "REGISTERED", "DEPRECATED" ], "documentation": "\n\n Specifies the registration status of the workflow types to list.\n
\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n\n If on a previous call to this method a NextPageToken
was returned, the results are\n being paginated. To get the next page of results, repeat the call with the returned token and all other arguments\n unchanged.\n
\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size smaller than the default. You cannot specify\n a page size greater than 100.\n Note that the number of types may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n
\n " }, "reverseOrder": { "shape_name": "ReverseOrder", "type": "boolean", "documentation": "\n\n When set to true
, returns the results in reverse order. By default the results are returned in ascending\n alphabetical order of the name
of the workflow types.\n
\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The workflow type this information is about.\n
\n ", "required": true }, "status": { "shape_name": "RegistrationStatus", "type": "string", "enum": [ "REGISTERED", "DEPRECATED" ], "documentation": "\n\n The current status of the workflow type.\n
\n ", "required": true }, "description": { "shape_name": "Description", "type": "string", "max_length": 1024, "documentation": "\n\n The description of the type registered through RegisterWorkflowType.\n
\n " }, "creationDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n The date when this type was registered.\n
\n ", "required": true }, "deprecationDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n If the type is in deprecated state, then it is set to the date when the type was deprecated.\n
\n " } }, "documentation": "\n\n Contains information about a workflow type.\n
\n " }, "documentation": "\n\n The list of workflow type information.\n
\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n\n The token for the next page of type information. If set then the list consists of more than one page.\n You can retrieve the next page by repeating the request (that returned the structure) with the this token and all other arguments unchanged.\n
\n " } }, "documentation": "\n\n Contains a paginated list of information structures about workflow types.\n
\n " }, "errors": [ { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " }, { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " } ], "documentation": "\n\n Returns information about workflow types in the specified domain. The results may be split into multiple\n pages that can be retrieved by making the call repeatedly.\n
\n\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain that contains the task lists being polled.\n
\n ", "required": true }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n Specifies the task list to poll for activity tasks.\n
\nThe specified string must not start or end with whitespace. It must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".
\n Identity of the worker making the request, which is recorded in the\n ActivityTaskStarted
event in the workflow history. This enables diagnostic tracing\n when problems arise. The form of this identity is user defined.\n
\n The opaque string used as a handle on the task. This token is used by workers to\n communicate progress and response information back to the system about\n the task.\n
\n ", "required": true }, "activityId": { "shape_name": "ActivityId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The unique ID of the task.\n
\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the ActivityTaskStarted
event recorded in the history.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The workflow execution that started this activity task.\n
\n ", "required": true }, "activityType": { "shape_name": "ActivityType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of this activity.\n
\n The version of this activity.\n
\n The type of this activity task.\n
\n ", "required": true }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The inputs provided when the activity task was scheduled. The form of the input is\n user defined and should be meaningful to the activity implementation.\n
\n " } }, "documentation": "\n\n Unit of work sent to an activity worker.\n
\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " }, { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n
\n " } ], "documentation": "\n\n Used by workers to get an ActivityTask from the specified activity taskList
.\n This initiates a long poll, where the service holds the HTTP\n connection open and responds as soon as a task becomes available.\n The maximum time the service holds on to the request before responding is 60 seconds. If no task is\n available within 60 seconds, the poll will return an empty result.\n An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string.\n If a task is returned, the worker should use its type to identify and process it correctly.\n
Access Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain containing the task lists to poll.\n
\n ", "required": true }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n Specifies the task list to poll for decision tasks.\n
\nThe specified string must not start or end with whitespace. It must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".
\n Identity of the decider making the request, which is recorded in the\n DecisionTaskStarted event in the workflow history. This enables diagnostic tracing\n when problems arise. The form of this identity is user defined.\n
\n " }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n\n If on a previous call to this method a NextPageToken
was returned, the results are\n being paginated. To get the next page of results, repeat the call with the returned token and\n all other arguments unchanged.\n
nextPageToken
returned by this action cannot be used with\n GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again\n (with the nextPageToken
) to retrieve the next page of history records. Calling PollForDecisionTask\n with a nextPageToken
will not return a new decision task.\n The maximum number of history events returned in each page. The default is 100, but the caller\n can override this value to a page size smaller than the default. You cannot specify a\n page size greater than 100.\n Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n
\n " }, "reverseOrder": { "shape_name": "ReverseOrder", "type": "boolean", "documentation": "\n\n When set to true
, returns the events in reverse order. By default the results are returned in ascending order\n of the eventTimestamp
of the events.\n
\n The opaque string used as a handle on the task. This token is used by workers to\n communicate progress and response information back to the system about\n the task.\n
\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskStarted
event recorded in the history.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The workflow execution for which this decision task was created.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the workflow execution for which this decision task was created.\n
\n ", "required": true }, "events": { "shape_name": "HistoryEventList", "type": "list", "members": { "shape_name": "HistoryEvent", "type": "structure", "members": { "eventTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\n The date and time when the event occurred.\n
\n ", "required": true }, "eventType": { "shape_name": "EventType", "type": "string", "enum": [ "WorkflowExecutionStarted", "WorkflowExecutionCancelRequested", "WorkflowExecutionCompleted", "CompleteWorkflowExecutionFailed", "WorkflowExecutionFailed", "FailWorkflowExecutionFailed", "WorkflowExecutionTimedOut", "WorkflowExecutionCanceled", "CancelWorkflowExecutionFailed", "WorkflowExecutionContinuedAsNew", "ContinueAsNewWorkflowExecutionFailed", "WorkflowExecutionTerminated", "DecisionTaskScheduled", "DecisionTaskStarted", "DecisionTaskCompleted", "DecisionTaskTimedOut", "ActivityTaskScheduled", "ScheduleActivityTaskFailed", "ActivityTaskStarted", "ActivityTaskCompleted", "ActivityTaskFailed", "ActivityTaskTimedOut", "ActivityTaskCanceled", "ActivityTaskCancelRequested", "RequestCancelActivityTaskFailed", "WorkflowExecutionSignaled", "MarkerRecorded", "RecordMarkerFailed", "TimerStarted", "StartTimerFailed", "TimerFired", "TimerCanceled", "CancelTimerFailed", "StartChildWorkflowExecutionInitiated", "StartChildWorkflowExecutionFailed", "ChildWorkflowExecutionStarted", "ChildWorkflowExecutionCompleted", "ChildWorkflowExecutionFailed", "ChildWorkflowExecutionTimedOut", "ChildWorkflowExecutionCanceled", "ChildWorkflowExecutionTerminated", "SignalExternalWorkflowExecutionInitiated", "SignalExternalWorkflowExecutionFailed", "ExternalWorkflowExecutionSignaled", "RequestCancelExternalWorkflowExecutionInitiated", "RequestCancelExternalWorkflowExecutionFailed", "ExternalWorkflowExecutionCancelRequested" ], "documentation": "\n\n The type of the history event.\n
\n ", "required": true }, "eventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The system generated id of the event. This id uniquely identifies the event with in the workflow execution history.\n
\n ", "required": true }, "workflowExecutionStartedEventAttributes": { "shape_name": "WorkflowExecutionStartedEventAttributes", "type": "structure", "members": { "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The input provided to the workflow execution (if any).\n
\n " }, "executionStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n The maximum duration for this workflow execution.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The maximum duration of decision tasks for this workflow type.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The policy to use for the child workflow executions if this workflow execution is terminated,\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n\n The supported child policies are:\n
WorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n \n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n The name of the task list for scheduling the decision tasks for this workflow execution.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The workflow type of this execution.\n
\n ", "required": true }, "tagList": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": null }, "max_length": 5, "documentation": "\n\n The list of tags associated with this workflow execution. An execution can have up to 5 tags.\n
\n " }, "continuedExecutionRunId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n\n If this workflow execution was started due to a ContinueAsNewWorkflowExecution
decision, then\n it contains the runId
of the previous workflow execution that was closed and continued as this execution.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The source workflow execution that started this workflow execution. The member is not set if the workflow execution was\n not started by a workflow.\n
\n " }, "parentInitiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the StartChildWorkflowExecutionInitiated
event corresponding to the\n StartChildWorkflowExecution
Decision to start this workflow execution. The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type WorkflowExecutionStarted
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The result produced by the workflow execution upon successful completion.\n
\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the CompleteWorkflowExecution
decision to complete this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type WorkflowExecutionCompleted
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
\n\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the CompleteWorkflowExecution
decision to complete this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type CompleteWorkflowExecutionFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The descriptive reason provided for the failure (if any).\n
\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The details of the failure (if any).\n
\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the FailWorkflowExecution
decision to fail this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type WorkflowExecutionFailed
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
\n\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the FailWorkflowExecution
decision to fail this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type FailWorkflowExecutionFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The type of timeout that caused this event.\n
\n ", "required": true }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n\n The policy used for the child workflow executions of this workflow execution.\n The supported child policies are:\n
WorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n \n If the event is of type WorkflowExecutionTimedOut
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n Details for the cancellation (if any).\n
\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the CancelWorkflowExecution
decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type WorkflowExecutionCanceled
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
\n\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the CancelWorkflowExecution
decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type CancelWorkflowExecutionFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The input provided to the new workflow execution.\n
\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the ContinueAsNewWorkflowExecution
decision that started this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n The runId
of the new workflow execution.\n
\n The total duration allowed for the new workflow execution.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n Represents a task list.\n
\n ", "required": true }, "taskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n The maximum duration of decision tasks for the new workflow execution.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The policy to use for the child workflow executions of the new execution if it is terminated\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
\n\nThe supported child policies are:
\nWorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n \n The list of tags associated with the new workflow execution.\n
\n " }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n Represents a workflow type.\n
\n ", "required": true } }, "documentation": "\n\n If the event is of type WorkflowExecutionContinuedAsNew
then this member is set and\n provides detailed information about the event. It is not set for other event types.\n
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
\n\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the ContinueAsNewWorkflowExecution
decision that started this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type ContinueAsNewWorkflowExecutionFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The reason provided for the termination (if any).\n
\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The details provided for the termination (if any).\n
\n " }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n\n The policy used for the child workflow executions of this workflow execution.\n The supported child policies are:
\nWorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n \n If set, indicates that the workflow execution was automatically terminated, and specifies the cause.\n This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.\n
\n " } }, "documentation": "\n\n If the event is of type WorkflowExecutionTerminated
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The external workflow execution for which the cancellation was requested.\n
\n " }, "externalInitiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the RequestCancelExternalWorkflowExecutionInitiated
event corresponding to the\n RequestCancelExternalWorkflowExecution
decision to cancel this workflow execution.The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause.\n This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.\n
\n " } }, "documentation": "\n\n If the event is of type WorkflowExecutionCancelRequested
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n The name of the task list in which the decision task was scheduled.\n
\n ", "required": true }, "startToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n The maximum duration for this decision task. The task is considered timed out if it does not\n completed within this duration.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n If the event is of type DecisionTaskScheduled
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n Identity of the decider making the request. This enables diagnostic tracing\n when problems arise. The form of this identity is user defined.\n
\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskScheduled
event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type DecisionTaskStarted
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n User defined context for the workflow execution.\n
\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskScheduled
event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the DecisionTaskStarted
event recorded when this decision task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type DecisionTaskCompleted
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The type of timeout that expired before the decision task could be completed.\n
\n ", "required": true }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskScheduled
event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the DecisionTaskStarted
event recorded when this decision task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type DecisionTaskTimedOut
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The name of this activity.\n
\n The version of this activity.\n
\n The type of the activity task.\n
\n ", "required": true }, "activityId": { "shape_name": "ActivityId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The unique id of the activity task.\n
\n ", "required": true }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The input provided to the activity task.\n
\n " }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks. This data is not sent to the activity.\n
\n " }, "scheduleToStartTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n The maximum amount of time the activity task can wait to be assigned to a worker.\n
\n " }, "scheduleToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n The maximum amount of time for this activity task.\n
\n " }, "startToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n The maximum amount of time a worker may take to process the activity task.\n
\n " }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n The task list in which the activity task has been scheduled.\n
\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskCompleted
event corresponding to the decision that\n resulted in the scheduling of this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The maximum time before which the worker processing this task must report progress by\n calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out.\n If the worker subsequently attempts to record a heartbeat or return a result, it will be ignored.\n
\n " } }, "documentation": "\n\n If the event is of type ActivityTaskScheduled
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n Identity of the worker that was assigned this task. This aids diagnostics\n when problems arise. The form of this identity is user defined.\n
\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the ActivityTaskScheduled
event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ActivityTaskStarted
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The results of the activity task (if any).\n
\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the ActivityTaskScheduled
event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the ActivityTaskStarted
event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ActivityTaskCompleted
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The reason provided for the failure (if any).\n
\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The details of the failure (if any).\n
\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the ActivityTaskScheduled
event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the ActivityTaskStarted
event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ActivityTaskFailed
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The type of the timeout that caused this event.\n
\n ", "required": true }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the ActivityTaskScheduled
event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the ActivityTaskStarted
event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n Contains the content of the details
parameter for the last call made by the activity to RecordActivityTaskHeartbeat
.\n
\n If the event is of type ActivityTaskTimedOut
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n Details of the cancellation (if any).\n
\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the ActivityTaskScheduled
event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the ActivityTaskStarted
event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If set, contains the Id of the last ActivityTaskCancelRequested
event recorded for this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ActivityTaskCanceled
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the RequestCancelActivityTask
decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n The unique ID of the task.\n
\n ", "required": true } }, "documentation": "\n\n If the event is of type ActivityTaskcancelRequested
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The name of the signal received. The decider can use the signal name and inputs to determine\n how to the process the signal.\n
\n ", "required": true }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Inputs provided with the signal (if any). The decider can use the signal name and inputs to determine\n how to process the signal.\n
\n " }, "externalWorkflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The workflow execution that sent the signal. This is set only of the signal was sent by another\n workflow execution.\n
\n " }, "externalInitiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the SignalExternalWorkflowExecutionInitiated
event corresponding to the\n SignalExternalWorkflow
decision to signal this workflow execution.The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event. This field is set only if the signal was initiated by another workflow execution.\n\n
\n If the event is of type WorkflowExecutionSignaled
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The name of the marker.\n
\n ", "required": true }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Details of the marker (if any).\n
\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the RecordMarker
decision that requested this marker.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type MarkerRecorded
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
The marker's name.
\n ", "required": true }, "cause": { "shape_name": "RecordMarkerFailedCause", "type": "string", "enum": [ "OPERATION_NOT_PERMITTED" ], "documentation": "\nThe cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.
\n\nThe id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the RecordMarkerFailed
decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.
\n If the event is of type DecisionTaskFailed
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The unique Id of the timer that was started.\n
\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n
\n " }, "startToFireTimeout": { "shape_name": "DurationInSeconds", "type": "string", "min_length": 1, "max_length": 8, "documentation": "\n\n The duration of time after which the timer will fire.\n
\nThe duration is specified in seconds. The valid values are integers greater than or equal to 0.
\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the StartTimer
decision for this activity task.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type TimerStarted
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The unique Id of the timer that fired.\n
\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the TimerStarted
event that was recorded when this timer was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type TimerFired
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The unique Id of the timer that was canceled.\n
\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the TimerStarted
event that was recorded when this timer was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the CancelTimer
decision to cancel this timer.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type TimerCanceled
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The workflowId
of the child workflow execution.\n
\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the child workflow execution.\n
\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Optional data attached to the event that can be used by the decider in subsequent decision\n tasks. This data is not sent to the activity.\n
\n " }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The inputs provided to the child workflow execution (if any).\n
\n " }, "executionStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration,\n it will be timed out and force terminated.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n The name of the task list used for the decision tasks of the child workflow execution.\n
\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the StartChildWorkflowExecution
Decision to request this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n The policy to use for the child workflow executions if this execution gets terminated by explicitly calling\n the TerminateWorkflowExecution action or due to an expired timeout.
\nThe supported child policies are:
\n\nWorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n \n The maximum duration allowed for the decision tasks for this workflow execution.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The list of tags to associated with the child workflow execution.\n
\n " } }, "documentation": "\n\n If the event is of type StartChildWorkflowExecutionInitiated
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The child workflow execution that was started.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the child workflow execution.\n
\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the StartChildWorkflowExecutionInitiated
event corresponding to the\n StartChildWorkflowExecution
Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ChildWorkflowExecutionStarted
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The child workflow execution that was completed.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the child workflow execution.\n
\n ", "required": true }, "result": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The result of the child workflow execution (if any).\n
\n " }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the StartChildWorkflowExecutionInitiated
event corresponding to the\n StartChildWorkflowExecution
Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the ChildWorkflowExecutionStarted
event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ChildWorkflowExecutionCompleted
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The child workflow execution that failed.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the child workflow execution.\n
\n ", "required": true }, "reason": { "shape_name": "FailureReason", "type": "string", "max_length": 256, "documentation": "\n\n The reason for the failure (if provided).\n
\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The details of the failure (if provided).\n
\n " }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the StartChildWorkflowExecutionInitiated
event corresponding to the\n StartChildWorkflowExecution
Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the ChildWorkflowExecutionStarted
event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ChildWorkflowExecutionFailed
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The child workflow execution that timed out.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the child workflow execution.\n
\n ", "required": true }, "timeoutType": { "shape_name": "WorkflowExecutionTimeoutType", "type": "string", "enum": [ "START_TO_CLOSE" ], "documentation": "\n\n The type of the timeout that caused the child workflow execution to time out.\n
\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the StartChildWorkflowExecutionInitiated
event corresponding to the\n StartChildWorkflowExecution
Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the ChildWorkflowExecutionStarted
event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ChildWorkflowExecutionTimedOut
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The child workflow execution that was canceled.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the child workflow execution.\n
\n ", "required": true }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Details of the cancellation (if provided).\n
\n " }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the StartChildWorkflowExecutionInitiated
event corresponding to the\n StartChildWorkflowExecution
Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the ChildWorkflowExecutionStarted
event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ChildWorkflowExecutionCanceled
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The child workflow execution that was terminated.\n
\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the child workflow execution.\n
\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the StartChildWorkflowExecutionInitiated
event corresponding to the\n StartChildWorkflowExecution
Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The Id of the ChildWorkflowExecutionStarted
event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ChildWorkflowExecutionTerminated
then this member is set and provides\n detailed information about the event. It is not set for other event types.\n
\n The workflowId
of the external workflow execution.\n
\n The runId
of the external workflow execution to send the signal to.\n
\n The name of the signal.\n
\n ", "required": true }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Input provided to the signal (if any).\n
\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that resulted in\n the SignalExternalWorkflowExecution
decision for this signal.\n This information can be useful for diagnosing problems by tracing back the cause of events leading up to this event.\n
\n Optional data attached to the event that can be used by the decider in subsequent decision\n tasks.\n
\n " } }, "documentation": "\n\n If the event is of type SignalExternalWorkflowExecutionInitiated
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The external workflow execution that the signal was delivered to.\n
\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the SignalExternalWorkflowExecutionInitiated
event corresponding to the\n SignalExternalWorkflowExecution
decision to request this signal.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ExternalWorkflowExecutionSignaled
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The workflowId
of the external workflow execution that the signal was being delivered to.\n
\n The runId
of the external workflow execution that the signal was being delivered to.\n
The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.
\n\n\n The id of the SignalExternalWorkflowExecutionInitiated
event corresponding to the\n SignalExternalWorkflowExecution
decision to request this signal.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The id of the DecisionTaskCompleted
event corresponding to the decision task that resulted in\n the SignalExternalWorkflowExecution
decision for this signal.\n This information can be useful for diagnosing problems by tracing back the cause of events leading up to this event.\n
If the event is of type SignalExternalWorkflowExecutionFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.
\n The user defined identifier associated with the workflow execution.\n
\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n\n A system generated unique identifier for the workflow execution.\n
\n ", "required": true } }, "documentation": "\n\n The external workflow execution to which the cancellation request was delivered.\n
\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the RequestCancelExternalWorkflowExecutionInitiated
event corresponding to the\n RequestCancelExternalWorkflowExecution
decision to cancel this external workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ExternalWorkflowExecutionCancelRequested
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The workflowId
of the external workflow execution to be canceled.\n
\n The runId
of the external workflow execution to be canceled.\n
\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the RequestCancelExternalWorkflowExecution
decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n
\n " } }, "documentation": "\n\n If the event is of type RequestCancelExternalWorkflowExecutionInitiated
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The workflowId
of the external workflow to which the cancel request was to be delivered.\n
\n The runId
of the external workflow execution.\n
The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.
\n\n\n The id of the RequestCancelExternalWorkflowExecutionInitiated
event corresponding to the\n RequestCancelExternalWorkflowExecution
decision to cancel this external workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the RequestCancelExternalWorkflowExecution
decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type RequestCancelExternalWorkflowExecutionFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The name of this activity.\n
\n The version of this activity.\n
\n The activity type provided in the ScheduleActivityTask
decision that failed.\n
\n The activityId provided in the ScheduleActivityTask
decision that failed.\n
The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.
\n\n\n The id of the DecisionTaskCompleted
event corresponding to the decision that\n resulted in the scheduling of this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n If the event is of type ScheduleActivityTaskFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The activityId provided in the RequestCancelActivityTask
decision that failed.\n
The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.
\n\nThe id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the RequestCancelActivityTask
decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.
\n If the event is of type RequestCancelActivityTaskFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The timerId provided in the StartTimer
decision that failed.\n
The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.
\n\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the StartTimer
decision for this activity task.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type StartTimerFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The timerId provided in the CancelTimer
decision that failed.\n
\n The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.\n
\n\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the CancelTimer
decision to cancel this timer.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type CancelTimerFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The workflow type provided in the StartChildWorkflowExecution
Decision that failed.\n
The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.
\n\n\n The workflowId
of the child workflow execution.\n
\n The id of the StartChildWorkflowExecutionInitiated
event corresponding to the\n StartChildWorkflowExecution
Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n
\n The id of the DecisionTaskCompleted
event corresponding to the decision task that\n resulted in the StartChildWorkflowExecution
Decision to request this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n
\n If the event is of type StartChildWorkflowExecutionFailed
then this member\n is set and provides detailed information about the event. It is not set for other event types.\n
Event within a workflow execution. A history event can be one of these types:
\nRequestCancelActivityTask
decision was\n received by the system.\n RecordMarker
decision.\n StartTimer
decision.\n \n A paginated list of history events of the workflow execution. The decider uses this\n during the processing of the decision task.\n
\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n\n Returns a value if the results are paginated. To get the next page of results,\n repeat the request specifying this token and all other arguments unchanged.\n
\n " }, "previousStartedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n\n The id of the DecisionTaskStarted event of the previous decision task of this workflow execution\n that was processed by the decider. This can be used to determine the events in the history new since the\n last decision task received by the decider.\n
\n " } }, "documentation": "\n\n A structure that represents a decision task. Decision tasks are sent to\n deciders in order for them to make decisions.\n
\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " }, { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n
\n " } ], "documentation": "\n\n Used by deciders to get a DecisionTask from the specified decision taskList
.\n A decision task may be returned for any open workflow execution that is\n using the specified task list. The task includes a paginated view of the history of the workflow execution.\n The decider should use the workflow type and the history to determine how to properly handle the task.\n
\n This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available.\n If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned.\n An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.\n
\nPollForDecisionTask
using the nextPageToken
returned by the initial call.\n Note that you do not call GetWorkflowExecutionHistory
with this nextPageToken
. Instead, call PollForDecisionTask
again.\n Access Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The taskToken
of the ActivityTask.\n
taskToken
is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken
must also be passed. This enables it to provide its progress and respond with results.\n \n If specified, contains details about the progress of the task.\n
\n " } }, "documentation": null }, "output": { "shape_name": "ActivityTaskStatus", "type": "structure", "members": { "cancelRequested": { "shape_name": "Canceled", "type": "boolean", "documentation": "\n\n Set to true
if cancellation of the task is requested.\n
\n Status information about an activity task.\n
\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Used by activity workers to report to the service that the ActivityTask represented by the specified\n taskToken
is still making progress. The worker can also (optionally) specify details of the progress,\n for example percent complete, using the details
parameter.\n\n This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task.\n If a cancellation is being attempted for the specified task, then the boolean cancelRequested
flag\n returned by the service is set to true
.\n
\n This action resets the taskHeartbeatTimeout
clock.\n The taskHeartbeatTimeout
is specified in RegisterActivityType.\n
\n This action does not in itself create an event in the workflow execution history.\n However, if the task times out, the workflow execution history will contain a ActivityTaskTimedOut
event\n that contains the information from the last heartbeat generated by the activity worker.\n
taskStartToCloseTimeout
of an activity type is the maximum duration of an activity task, regardless\n of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout
is also\n specified in RegisterActivityType.\n cancelRequested
flag returns true
, a cancellation is being\n attempted. If the worker can cancel the activity, it should respond with\n RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.\n Access Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain in which this activity is to be registered.\n
\n ", "required": true }, "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the activity type within the domain.\n
\nThe specified string must not start or end with whitespace. It must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".
\n The version of the activity type.\n
\nThe specified string must not start or end with whitespace. It must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".
\n A textual description of the activity type.\n
\n " }, "defaultTaskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n If set, specifies the default maximum duration that a worker can take to process tasks of this activity type.\n This default can be overridden when scheduling an activity task using the ScheduleActivityTask
Decision.\n
The valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n If set, specifies the default maximum time before which a worker processing a task of this type must report progress by\n calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out.\n This default can be overridden when scheduling an activity task using the ScheduleActivityTask
Decision.\n If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives\n an UnknownResource
fault.\n In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.\n
The valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used\n if a task list is not provided when a task is scheduled through the ScheduleActivityTask
Decision.\n
\n If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker.\n This default can be overridden when scheduling an activity task using the ScheduleActivityTask
Decision.\n
The valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n If set, specifies the default maximum duration for a task of this activity type.\n This default can be overridden when scheduling an activity task using the ScheduleActivityTask
Decision.\n
The valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned if the type\n already exists in the specified domain. You will get this fault even if the existing\n type is in deprecated status.\n You can specify another version if the intent is to create a new distinct version of the type.\n
\n " }, { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n
\n " }, { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Registers a new activity type along with its configuration settings in the specified domain.\n
\n\nTypeAlreadyExists
fault is returned if the type already exists in the domain. You cannot change any configuration\n settings of the type after its registration, and it must be registered as a new version.\n Access Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.Condition
element with the appropriate keys.\n 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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n Name of the domain to register. The name must be unique.\n
\nThe specified string must not start or end with whitespace. It must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".
Textual description of the domain.
\n " }, "workflowExecutionRetentionPeriodInDays": { "shape_name": "DurationInDays", "type": "string", "min_length": 1, "max_length": 8, "documentation": "\nA duration (in days) for which the record (including the history) of workflow executions in this domain should\n be kept by the service. After the retention period, the workflow execution will not be available in the results of\n visibility calls.
\nIf you pass the value NONE
then there is no expiration for workflow execution history (effectively\n an infinite retention period).
\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned if the specified domain already exists. You will\n get this fault even if the existing domain is in deprecated status.\n
\n " }, { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Registers a new domain.\n
\n\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nAction
element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain in which to register the workflow type.\n
\n ", "required": true }, "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the workflow type.\n
\nThe specified string must not start or end with whitespace. It must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".
\n The version of the workflow type.\n
\nThe specified string must not start or end with whitespace. It must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".
\n Textual description of the workflow type.\n
\n " }, "defaultTaskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n If set, specifies the default maximum duration of decision tasks for this workflow type. This\n default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the\n StartChildWorkflowExecution
Decision.\n
The valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n If set, specifies the default maximum duration for executions of this workflow type. You can\n override this default when starting an execution through the StartWorkflowExecution Action or\n StartChildWorkflowExecution
Decision.\n
\n The duration is specified in seconds. The valid values are integers greater than or equal to 0.\n Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for defaultExecutionStartToCloseTimeout
; there is a\n one-year max limit on the time that a workflow execution can run. Exceeding this limit will always cause the workflow execution to time out.\n
\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type.\n This default is used only if a task list is not provided when starting the execution\n through the StartWorkflowExecution Action or StartChildWorkflowExecution
Decision.\n
\n If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated,\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or\n the StartChildWorkflowExecution
Decision.\n The supported child policies are:
WorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n \n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned if the type\n already exists in the specified domain. You will get this fault even if the existing\n type is in deprecated status.\n You can specify another version if the intent is to create a new distinct version of the type.\n
\n " }, { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n
\n " }, { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Registers a new workflow type and its configuration settings in the specified domain.\n
\n\n The retention period for the workflow history is set by the RegisterDomain action.\n
\nTypeAlreadyExists
fault is returned. You cannot change the configuration settings\n of a workflow type once it is registered and it must be registered as a new version.\n Access Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.Condition
element with the appropriate keys.\n 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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain containing the workflow execution to cancel.\n
\n ", "required": true }, "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The workflowId of the workflow execution to cancel.\n
\n ", "required": true }, "runId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n\n The runId of the workflow execution to cancel.\n
\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Records a WorkflowExecutionCancelRequested
event in the currently running workflow execution\n identified by the given domain, workflowId, and runId. This logically requests the\n cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n
WorkflowExecutionCancelRequested
event is recorded in the history of the current open workflow execution with the\n specified workflowId in the domain.\n Access Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The taskToken
of the ActivityTask.\n
taskToken
is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken
must also be passed. This enables it to provide its progress and respond with results.\n \n Optional information about the cancellation.\n
\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Used by workers to tell the service that the ActivityTask identified by the taskToken
\n was successfully canceled. Additional details
can be optionally provided using the details
argument.\n
\n These details
(if provided) appear in the ActivityTaskCanceled
event added to\n the workflow history.\n
canceled
flag of a RecordActivityTaskHeartbeat request returns\n true
and if the activity can be safely undone or abandoned.\n \n A task is considered open from the time that it is scheduled until it is\n closed. Therefore a task is reported as open while a worker is\n processing it. A task is closed after it has been specified in a call to\n RespondActivityTaskCompleted, RespondActivityTaskCanceled,\n RespondActivityTaskFailed, or the task has\n timed out.\n
\n\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The taskToken
of the ActivityTask.\n
taskToken
is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken
must also be passed. This enables it to provide its progress and respond with results.\n \n The result of the activity task. It is a free form string that is implementation specific.\n
\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Used by workers to tell the service that the ActivityTask identified by the taskToken
\n completed successfully with a result
(if provided).\n The result
appears in the ActivityTaskCompleted
event in the workflow\n history.\n
canceled
flag returned by\n RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.\n \n A task is considered open from the time that it is scheduled until it is\n closed. Therefore a task is reported as open while a worker is\n processing it. A task is closed after it has been specified in a call to\n RespondActivityTaskCompleted, RespondActivityTaskCanceled,\n RespondActivityTaskFailed, or the task has\n timed out.\n
\n\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The taskToken
of the ActivityTask.\n
taskToken
is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken
must also be passed. This enables it to provide its progress and respond with results.\n \n Description of the error that may assist in diagnostics.\n
\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Optional detailed information about the failure.\n
\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Used by workers to tell the service that the ActivityTask identified by the taskToken
\n has failed with reason
(if specified).\n The reason
and details
appear in the\n ActivityTaskFailed
event added to the workflow history.\n
\n A task is considered open from the time that it is scheduled until it is\n closed. Therefore a task is reported as open while a worker is\n processing it. A task is closed after it has been specified in a call to\n RespondActivityTaskCompleted, RespondActivityTaskCanceled,\n RespondActivityTaskFailed, or the task has\n timed out.\n
\n\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The taskToken
from the DecisionTask.\n
taskToken
is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken
must also be passed. This enables it to provide its progress and respond with results.\n \n Specifies the type of the decision.\n
\n ", "required": true }, "scheduleActivityTaskDecisionAttributes": { "shape_name": "ScheduleActivityTaskDecisionAttributes", "type": "structure", "members": { "activityType": { "shape_name": "ActivityType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of this activity.\n
\n The version of this activity.\n
\n The type of the activity task to schedule.\n This field is required.\n
\n ", "required": true }, "activityId": { "shape_name": "ActivityId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The activityId
of the activity task.\n This field is required.\n
The specified string must not start or end with whitespace. It must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".
\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks. This data is not sent to the activity.\n
\n " }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The input provided to the activity task.\n
\n " }, "scheduleToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n The maximum duration for this activity task.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList
\n registered with the activity type will be used.\n
The specified string must not start or end with whitespace. It must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".
\n If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This\n overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n If set, specifies the maximum duration a worker may take to process this activity task. This\n overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n If set, specifies the maximum time before which a worker processing a task of this type must report progress by\n calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out.\n If the worker subsequently attempts to record a heartbeat or returns a result, it will be ignored.\n This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n Provides details of the ScheduleActivityTask
decision. It is not set for other decision types.\n
\n The activityId
of the activity task to be canceled.\n
\n Provides details of the RequestCancelActivityTask
decision. It is not set for other decision types.\n
\n The result of the workflow execution. The form of the result is implementation defined.\n
\n " } }, "documentation": "\n\n Provides details of the CompleteWorkflowExecution
decision. It is not set for other decision types.\n
\n A descriptive reason for the failure that may help in diagnostics.\n
\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Optional details of the failure.\n
\n " } }, "documentation": "\n\n Provides details of the FailWorkflowExecution
decision. It is not set for other decision types.\n
\n Optional details of the cancellation.\n
\n " } }, "documentation": "\n\n Provides details of the CancelWorkflowExecution
decision. It is not set for other decision types.\n
\n The input provided to the new workflow execution.\n
\n " }, "executionStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n If set, specifies the total duration for this workflow execution. This overrides\n the defaultExecutionStartToCloseTimeout
specified when registering the workflow type.\n
The valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n Represents a task list.\n
\n " }, "taskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n Specifies the maximum duration of decision tasks for the new workflow execution.\n This parameter overrides the defaultTaskStartToCloseTimout
specified when registering the workflow type using RegisterWorkflowType.\n
The valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.\n The supported child policies are:
\n\nWorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n \n The list of tags to associate with the new workflow execution. A maximum\n of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions\n or ListClosedWorkflowExecutions and specifying a TagFilter.\n
\n " }, "workflowTypeVersion": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": null } }, "documentation": "\n\n Provides details of the ContinueAsNewWorkflowExecution
decision. It is not set for other decision types.\n
\n The name of the marker.\n This file is required.\n
\n ", "required": true }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Optional details of the marker.\n
\n " } }, "documentation": "\n\n Provides details of the RecordMarker
decision. It is not set for other decision types.\n
\n The unique Id of the timer.\n This field is required.
\nThe specified string must not start or end with whitespace. It must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".
\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n
\n " }, "startToFireTimeout": { "shape_name": "DurationInSeconds", "type": "string", "min_length": 1, "max_length": 8, "documentation": "\n\n The duration to wait before firing the timer.\n This field is required.\n
\nThe duration is specified in seconds. The valid values are integers greater than or equal to 0.
\n ", "required": true } }, "documentation": "\n\n Provides details of the StartTimer
decision. It is not set for other decision types.\n
\n The unique Id of the timer to cancel. This field is required.\n
\n ", "required": true } }, "documentation": "\n\n Provides details of the CancelTimer
decision. It is not set for other decision types.\n
\n The workflowId
of the workflow execution to be signaled.\n This field is required.\n
\n The runId
of the workflow execution to be signaled.\n
\n The name of the signal.The target workflow execution will use the signal name and\n input to process the signal.\n This field is required.\n
\n ", "required": true }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Optional input to be provided with the signal.The target workflow execution will use the signal name and\n input to process the signal.\n
\n " }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Optional data attached to the event that can be used by the decider in subsequent decision\n tasks.\n
\n " } }, "documentation": "\n\n Provides details of the SignalExternalWorkflowExecution
decision. It is not set for other decision types.\n
\n The workflowId
of the external workflow execution to cancel.\n This field is required.\n
\n The runId
of the external workflow execution to cancel.\n
\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n
\n " } }, "documentation": "\n\n Provides details of the RequestCancelExternalWorkflowExecution
decision. It is not set for other decision types.\n
\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the workflow execution to be started.\n This field is required.\n
\n ", "required": true }, "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The workflowId
of the workflow execution.\n This field is required.\n
The specified string must not start or end with whitespace. It must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".
\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks. This data is not sent to the child workflow execution.\n
\n " }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n The input to be provided to the workflow execution.\n
\n " }, "executionStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n The total duration for this workflow execution. This overrides\n the defaultExecutionStartToCloseTimeout specified when registering the workflow type.\n
\nThe valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n The name of the task list to be used for decision tasks of the child workflow execution.\n
\nThe specified string must not start or end with whitespace. It must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".
\n Specifies the maximum duration of decision tasks for this workflow execution.\n This parameter overrides the defaultTaskStartToCloseTimout
specified when registering the workflow type using RegisterWorkflowType.\n
The valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.
\n If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.\n The supported child policies are:
\nWorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n \n The list of tags to associate with the child workflow execution. A maximum\n of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions\n or ListClosedWorkflowExecutions and specifying a TagFilter.\n
\n " } }, "documentation": "\n\n Provides details of the StartChildWorkflowExecution
decision. It is not set for other decision types.\n
\n Specifies a decision made by the decider. A decision can be one of these types:\n
\nTimerCanceled
event in the history.WorkflowExecutionCanceled
event in the history.WorkflowExecutionCompleted
event in the history .WorkflowExecutionContinuedAsNew
event is recorded in the history.WorkflowExecutionFailed
event in the history.MarkerRecorded
event in the history. Markers can be used for adding\n custom information in the history for instance to let deciders know that they do not need to look at the history beyond\n the marker event.RequestCancelExternalWorkflowExecutionInitiated
event in the history.SignalExternalWorkflowExecutionInitiated
event in the history.StartChildWorkflowExecutionInitiated
event in the history. The child workflow execution is a separate workflow execution\n with its own history.TimerStarted
event in the history.\n This timer will fire after the specified delay and record a TimerFired
event.Access Control
\nIf you grant permission to use RespondDecisionTaskCompleted
, you can use IAM policies to express permissions for the list of decisions\n returned by this action as if they were members of the API. Treating decisions as a pseudo API maintains a uniform conceptual model and helps\n keep policies readable. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Decision Failure
\nDecisions can fail for several reasons
\nOne of the following events might be added to the history to indicate an error. The event attribute's cause parameter indicates the cause.\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions.\n
\n\nworkflowID
specified in the decision was incorrect.\n workflowID
specified in the decision was incorrect.\n \n The preceding error events might occur due to an error in the decider logic, which might put the workflow execution in an unstable state The cause field in the event structure for the error event indicates the cause of the error.\n
\n\nCompleteWorkflowExecution
, FailWorkflowExecution
, CancelWorkflowExecution
\n and ContinueAsNewWorkflowExecution
.\n An UnhandledDecision fault will be returned if a workflow closing decision is specified and a signal\n or activity event had been added to the history while the decision task was being performed by the decider.\n Unlike the above situations which are\n logic issues, this fault is always possible because of race conditions in a distributed system. The right\n action here is to call RespondDecisionTaskCompleted without any decisions. This would result in\n another decision task with these new events included in the history. The decider should handle the new events and\n may decide to close the workflow execution.\n How to Code a Decision
\n\n You code a decision by first setting the\n decision type field to one of the above decision values, and then set the corresponding attributes field\n shown below:\n
\n\n The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs\n for the Decision structure for details.\n
\n " }, "executionContext": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n User defined context to add to workflow execution.\n
\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Used by deciders to tell the service that the DecisionTask identified by the taskToken
\n has successfully completed. The decisions
argument specifies the list of decisions made while\n processing the task.\n
\n A DecisionTaskCompleted
event is added to the workflow history. The executionContext
specified is\n attached to the event in the workflow execution history.\n
Access Control
\nIf an IAM policy grants permission to use RespondDecisionTaskCompleted
, it can express permissions for the\n 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\n to be as readable as possible, you can express permissions on decisions as if they were actual API\n calls, including applying conditions to some parameters. For more information,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain containing the workflow execution to signal.\n
\n ", "required": true }, "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The workflowId of the workflow execution to signal.\n
\n ", "required": true }, "runId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n\n The runId of the workflow execution to signal.\n
\n " }, "signalName": { "shape_name": "SignalName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the signal. This name must be meaningful to the target workflow.\n
\n ", "required": true }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Data to attach to the WorkflowExecutionSignaled
event in the target workflow execution's history.\n
\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Records a WorkflowExecutionSignaled
event in the workflow execution history and creates\n a decision task for the workflow execution\n identified by the given domain, workflowId and runId. The event is recorded with the\n specified user defined signalName and input (if provided).\n
WorkflowExecutionSignaled
\n event is recorded in the history of the current open workflow with the matching workflowId in the domain.\n UnknownResource
.\n Access Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The name of the domain in which the workflow execution is created.\n
\n ", "required": true }, "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The user defined identifier associated with the workflow execution. You can use this to\n associate a custom identifier with the workflow execution. You may specify the same\n identifier if a workflow execution is logically a restart of a previous execution.\n You cannot have two open workflow executions with the same workflowId
at the same time.\n
The specified string must not start or end with whitespace. It must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".
\n The name of the workflow type.\n This field is required.\n
\n The version of the workflow type.\n This field is required.\n
\n The type of the workflow to start.\n
\n ", "required": true }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The name of the task list.\n
\n ", "required": true } }, "documentation": "\n\n The task list to use for the decision tasks generated for this workflow execution.\n This overrides the defaultTaskList
specified when registering the workflow type.\n
The specified string must not start or end with whitespace. It must not contain a :
(colon), /
(slash), |
(vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".
\n The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting.\n This input
is made available to the new workflow execution in the WorkflowExecutionStarted
history event.\n
\n The total duration for this workflow execution. This overrides\n the defaultExecutionStartToCloseTimeout specified when registering the workflow type.\n
\n\n\n The duration is specified in seconds. The valid values are integers greater than or equal to 0.\n Exceeding this limit will cause the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot\n specify a value of \"NONE\" for this timeout; there is a one-year max limit on the time that a workflow execution can run.\n
\n\n\n The list of tags to associate with the workflow execution. You can specify a maximum\n of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or\n ListClosedWorkflowExecutions and specifying a TagFilter.\n
\n " }, "taskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n Specifies the maximum duration of decision tasks for this workflow execution.\n This parameter overrides the defaultTaskStartToCloseTimout
specified when registering the workflow type using RegisterWorkflowType.\n
\n The valid values are integers greater than or equal to 0
. An integer value can be used to specify the duration in seconds while NONE
can be used to specify unlimited duration.\n
\n If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated,\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.\n The supported child policies are:
\n\nWorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n \n The runId
of a workflow execution. This Id is generated by the service and can be used to uniquely identify\n the workflow execution within a domain.\n
\n Specifies the runId
of a workflow execution.\n
\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "TypeDeprecatedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the specified activity or workflow type was already deprecated.\n
\n " }, { "shape_name": "WorkflowExecutionAlreadyStartedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned by StartWorkflowExecution when an open execution with the same\n workflowId is already running in the specified domain.\n
\n " }, { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " }, { "shape_name": "DefaultUndefinedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": null } ], "documentation": "\n\n Starts an execution of the workflow type in the specified domain using the provided workflowId
\n and input data.\n
This action returns the newly started workflow execution.
\n\nAccess Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.Condition
element with the appropriate keys.\n 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
.name
: String constraint. The key is swf:workflowType.name
.version
: String constraint. The key is swf:workflowType.version
.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.
\n The domain of the workflow execution to terminate.\n
\n ", "required": true }, "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n\n The workflowId of the workflow execution to terminate.\n
\n ", "required": true }, "runId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n\n The runId of the workflow execution to terminate.\n
\n " }, "reason": { "shape_name": "TerminateReason", "type": "string", "max_length": 256, "documentation": "\n\n An optional descriptive reason for terminating the workflow execution.\n
\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n\n Optional details for terminating the workflow execution.\n
\n " }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n\n If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.\n This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.\n The supported child policies are:
\nWorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n \n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\n\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n
\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n\n A description that may help with diagnosing the cause of the fault.\n
\n " } }, "documentation": "\nReturned when the caller does not have sufficient permissions to invoke the action.
\n " } ], "documentation": "\n\n Records a WorkflowExecutionTerminated
event and forces closure of the\n workflow execution identified by the given domain, runId, and workflowId.\n The child policy, registered with the workflow type or specified when starting this execution,\n is applied to any open child workflow executions of this\n workflow execution.\n
WorkflowExecutionTerminated
\n event is recorded in the history of the current open workflow with the matching workflowId in the domain.\n Access Control
\nYou can use IAM policies to control this action's access to Amazon SWF resources as follows:
\nResource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted
. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.