• 沒有找到結果。

Amazon Simple Workflow Service API Reference API Version 2012-01-25

N/A
N/A
Protected

Academic year: 2022

Share "Amazon Simple Workflow Service API Reference API Version 2012-01-25"

Copied!
318
0
0

加載中.... (立即查看全文)

全文

(1)

Amazon Simple Workflow Service

API Reference

API Version 2012-01-25

(2)

Amazon Simple Workflow Service: API Reference

Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.

(3)

Table of Contents

Welcome ... 1

Actions ... 2

CountClosedWorkflowExecutions ... 3

Request Syntax ... 3

Request Parameters ... 3

Response Syntax ... 5

Response Elements ... 5

Errors ... 5

Examples ... 6

See Also ... 6

CountOpenWorkflowExecutions ... 8

Request Syntax ... 8

Request Parameters ... 8

Response Syntax ... 9

Response Elements ... 9

Errors ... 10

Examples ... 10

See Also ... 11

CountPendingActivityTasks ... 12

Request Syntax ... 12

Request Parameters ... 12

Response Syntax ... 12

Response Elements ... 13

Errors ... 13

Examples ... 13

See Also ... 14

CountPendingDecisionTasks ... 15

Request Syntax ... 15

Request Parameters ... 15

Response Syntax ... 15

Response Elements ... 16

Errors ... 16

Examples ... 16

See Also ... 17

DeprecateActivityType ... 18

Request Syntax ... 18

Request Parameters ... 18

Response Elements ... 19

Errors ... 19

Examples ... 19

See Also ... 20

DeprecateDomain ... 21

Request Syntax ... 21

Request Parameters ... 21

Response Elements ... 21

Errors ... 21

Examples ... 22

See Also ... 23

DeprecateWorkflowType ... 24

Request Syntax ... 24

Request Parameters ... 24

Response Elements ... 25

Errors ... 25

Examples ... 25

(4)

See Also ... 26

DescribeActivityType ... 27

Request Syntax ... 27

Request Parameters ... 27

Response Syntax ... 28

Response Elements ... 28

Errors ... 28

Examples ... 29

See Also ... 30

DescribeDomain ... 31

Request Syntax ... 31

Request Parameters ... 31

Response Syntax ... 31

Response Elements ... 32

Errors ... 32

Examples ... 32

See Also ... 33

DescribeWorkflowExecution ... 34

Request Syntax ... 34

Request Parameters ... 34

Response Syntax ... 35

Response Elements ... 35

Errors ... 36

Examples ... 36

See Also ... 38

DescribeWorkflowType ... 39

Request Syntax ... 39

Request Parameters ... 39

Response Syntax ... 40

Response Elements ... 40

Errors ... 40

Examples ... 41

See Also ... 42

GetWorkflowExecutionHistory ... 43

Request Syntax ... 43

Request Parameters ... 43

Response Syntax ... 44

Response Elements ... 50

Errors ... 51

Examples ... 51

See Also ... 54

ListActivityTypes ... 55

Request Syntax ... 55

Request Parameters ... 55

Response Syntax ... 56

Response Elements ... 57

Errors ... 57

Examples ... 57

See Also ... 58

ListClosedWorkflowExecutions ... 59

Request Syntax ... 59

Request Parameters ... 60

Response Syntax ... 62

Response Elements ... 62

Errors ... 62

Examples ... 63

See Also ... 64

(5)

ListDomains ... 65

Request Syntax ... 65

Request Parameters ... 65

Response Syntax ... 66

Response Elements ... 66

Errors ... 67

Examples ... 67

See Also ... 68

ListOpenWorkflowExecutions ... 69

Request Syntax ... 69

Request Parameters ... 69

Response Syntax ... 71

Response Elements ... 71

Errors ... 72

Examples ... 72

See Also ... 73

ListTagsForResource ... 74

Request Syntax ... 74

Request Parameters ... 74

Response Syntax ... 74

Response Elements ... 74

Errors ... 74

See Also ... 75

ListWorkflowTypes ... 76

Request Syntax ... 76

Request Parameters ... 76

Response Syntax ... 77

Response Elements ... 78

Errors ... 78

Examples ... 78

See Also ... 79

PollForActivityTask ... 80

Request Syntax ... 80

Request Parameters ... 80

Response Syntax ... 81

Response Elements ... 81

Errors ... 82

Examples ... 82

See Also ... 83

PollForDecisionTask ... 85

Request Syntax ... 85

Request Parameters ... 85

Response Syntax ... 87

Response Elements ... 93

Errors ... 94

Examples ... 95

See Also ... 96

RecordActivityTaskHeartbeat ... 98

Request Syntax ... 98

Request Parameters ... 98

Response Syntax ... 99

Response Elements ... 99

Errors ... 99

Examples ... 100

See Also ... 100

RegisterActivityType ... 102

Request Syntax ... 102

(6)

Request Parameters ... 102

Response Elements ... 105

Errors ... 105

Examples ... 105

See Also ... 106

RegisterDomain ... 107

Request Syntax ... 107

Request Parameters ... 107

Response Elements ... 108

Errors ... 108

Examples ... 109

See Also ... 109

RegisterWorkflowType ... 111

Request Syntax ... 111

Request Parameters ... 111

Response Elements ... 114

Errors ... 114

Examples ... 114

See Also ... 115

RequestCancelWorkflowExecution ... 117

Request Syntax ... 117

Request Parameters ... 117

Response Elements ... 118

Errors ... 118

Examples ... 118

See Also ... 119

RespondActivityTaskCanceled ... 120

Request Syntax ... 120

Request Parameters ... 120

Response Elements ... 121

Errors ... 121

Examples ... 121

See Also ... 122

RespondActivityTaskCompleted ... 123

Request Syntax ... 123

Request Parameters ... 123

Response Elements ... 124

Errors ... 124

Examples ... 124

See Also ... 125

RespondActivityTaskFailed ... 126

Request Syntax ... 126

Request Parameters ... 126

Response Elements ... 127

Errors ... 127

Examples ... 127

See Also ... 128

RespondDecisionTaskCompleted ... 129

Request Syntax ... 129

Request Parameters ... 130

Response Elements ... 131

Errors ... 131

Examples ... 132

See Also ... 133

SignalWorkflowExecution ... 134

Request Syntax ... 134

Request Parameters ... 134

(7)

Response Elements ... 135

Errors ... 135

Examples ... 135

See Also ... 136

StartWorkflowExecution ... 137

Request Syntax ... 137

Request Parameters ... 137

Response Syntax ... 140

Response Elements ... 140

Errors ... 141

Examples ... 142

See Also ... 143

TagResource ... 144

Request Syntax ... 144

Request Parameters ... 144

Response Elements ... 144

Errors ... 144

See Also ... 145

TerminateWorkflowExecution ... 146

Request Syntax ... 146

Request Parameters ... 146

Response Elements ... 148

Errors ... 148

Examples ... 148

See Also ... 149

UndeprecateActivityType ... 150

Request Syntax ... 150

Request Parameters ... 150

Response Elements ... 151

Errors ... 151

See Also ... 151

UndeprecateDomain ... 152

Request Syntax ... 152

Request Parameters ... 152

Response Elements ... 152

Errors ... 152

See Also ... 153

UndeprecateWorkflowType ... 154

Request Syntax ... 154

Request Parameters ... 154

Response Elements ... 155

Errors ... 155

See Also ... 155

UntagResource ... 156

Request Syntax ... 156

Request Parameters ... 156

Response Elements ... 156

Errors ... 156

See Also ... 157

Data Types ... 158

ActivityTask ... 161

Contents ... 161

See Also ... 162

ActivityTaskCanceledEventAttributes ... 163

Contents ... 163

See Also ... 163

ActivityTaskCancelRequestedEventAttributes ... 164

(8)

Contents ... 164

See Also ... 164

ActivityTaskCompletedEventAttributes ... 165

Contents ... 165

See Also ... 165

ActivityTaskFailedEventAttributes ... 166

Contents ... 166

See Also ... 166

ActivityTaskScheduledEventAttributes ... 167

Contents ... 167

See Also ... 168

ActivityTaskStartedEventAttributes ... 170

Contents ... 170

See Also ... 170

ActivityTaskTimedOutEventAttributes ... 171

Contents ... 171

See Also ... 171

ActivityType ... 172

Contents ... 172

See Also ... 172

ActivityTypeConfiguration ... 173

Contents ... 173

See Also ... 174

ActivityTypeInfo ... 175

Contents ... 175

See Also ... 175

CancelTimerDecisionAttributes ... 176

Contents ... 176

See Also ... 176

CancelTimerFailedEventAttributes ... 177

Contents ... 177

See Also ... 177

CancelWorkflowExecutionDecisionAttributes ... 178

Contents ... 178

See Also ... 178

CancelWorkflowExecutionFailedEventAttributes ... 179

Contents ... 179

See Also ... 179

ChildWorkflowExecutionCanceledEventAttributes ... 180

Contents ... 180

See Also ... 180

ChildWorkflowExecutionCompletedEventAttributes ... 182

Contents ... 182

See Also ... 182

ChildWorkflowExecutionFailedEventAttributes ... 184

Contents ... 184

See Also ... 185

ChildWorkflowExecutionStartedEventAttributes ... 186

Contents ... 186

See Also ... 186

ChildWorkflowExecutionTerminatedEventAttributes ... 187

Contents ... 187

See Also ... 187

ChildWorkflowExecutionTimedOutEventAttributes ... 188

Contents ... 188

See Also ... 188

CloseStatusFilter ... 190

(9)

Contents ... 190

See Also ... 190

CompleteWorkflowExecutionDecisionAttributes ... 191

Contents ... 191

See Also ... 191

CompleteWorkflowExecutionFailedEventAttributes ... 192

Contents ... 192

See Also ... 192

ContinueAsNewWorkflowExecutionDecisionAttributes ... 193

Contents ... 193

See Also ... 195

ContinueAsNewWorkflowExecutionFailedEventAttributes ... 196

Contents ... 196

See Also ... 196

Decision ... 197

Contents ... 199

See Also ... 201

DecisionTask ... 202

Contents ... 202

See Also ... 203

DecisionTaskCompletedEventAttributes ... 204

Contents ... 204

See Also ... 204

DecisionTaskScheduledEventAttributes ... 205

Contents ... 205

See Also ... 205

DecisionTaskStartedEventAttributes ... 206

Contents ... 206

See Also ... 206

DecisionTaskTimedOutEventAttributes ... 207

Contents ... 207

See Also ... 207

DomainConfiguration ... 208

Contents ... 208

See Also ... 208

DomainInfo ... 209

Contents ... 209

See Also ... 209

ExecutionTimeFilter ... 211

Contents ... 211

See Also ... 211

ExternalWorkflowExecutionCancelRequestedEventAttributes ... 212

Contents ... 212

See Also ... 212

ExternalWorkflowExecutionSignaledEventAttributes ... 213

Contents ... 213

See Also ... 213

FailWorkflowExecutionDecisionAttributes ... 214

Contents ... 214

See Also ... 214

FailWorkflowExecutionFailedEventAttributes ... 215

Contents ... 215

See Also ... 215

HistoryEvent ... 216

Contents ... 217

See Also ... 225

LambdaFunctionCompletedEventAttributes ... 226

(10)

Contents ... 226

See Also ... 226

LambdaFunctionFailedEventAttributes ... 227

Contents ... 227

See Also ... 227

LambdaFunctionScheduledEventAttributes ... 228

Contents ... 228

See Also ... 229

LambdaFunctionStartedEventAttributes ... 230

Contents ... 230

See Also ... 230

LambdaFunctionTimedOutEventAttributes ... 231

Contents ... 231

See Also ... 231

MarkerRecordedEventAttributes ... 232

Contents ... 232

See Also ... 232

RecordMarkerDecisionAttributes ... 233

Contents ... 233

See Also ... 233

RecordMarkerFailedEventAttributes ... 234

Contents ... 234

See Also ... 234

RequestCancelActivityTaskDecisionAttributes ... 235

Contents ... 235

See Also ... 235

RequestCancelActivityTaskFailedEventAttributes ... 236

Contents ... 236

See Also ... 236

RequestCancelExternalWorkflowExecutionDecisionAttributes ... 237

Contents ... 237

See Also ... 237

RequestCancelExternalWorkflowExecutionFailedEventAttributes ... 239

Contents ... 239

See Also ... 240

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes ... 241

Contents ... 241

See Also ... 241

ResourceTag ... 242

Contents ... 242

See Also ... 242

ScheduleActivityTaskDecisionAttributes ... 243

Contents ... 243

See Also ... 245

ScheduleActivityTaskFailedEventAttributes ... 246

Contents ... 246

See Also ... 246

ScheduleLambdaFunctionDecisionAttributes ... 248

Contents ... 248

See Also ... 249

ScheduleLambdaFunctionFailedEventAttributes ... 250

Contents ... 250

See Also ... 250

SignalExternalWorkflowExecutionDecisionAttributes ... 252

Contents ... 252

See Also ... 253

SignalExternalWorkflowExecutionFailedEventAttributes ... 254

(11)

Contents ... 254

See Also ... 255

SignalExternalWorkflowExecutionInitiatedEventAttributes ... 256

Contents ... 256

See Also ... 257

StartChildWorkflowExecutionDecisionAttributes ... 258

Contents ... 258

See Also ... 261

StartChildWorkflowExecutionFailedEventAttributes ... 262

Contents ... 262

See Also ... 263

StartChildWorkflowExecutionInitiatedEventAttributes ... 264

Contents ... 264

See Also ... 266

StartLambdaFunctionFailedEventAttributes ... 267

Contents ... 267

See Also ... 267

StartTimerDecisionAttributes ... 268

Contents ... 268

See Also ... 268

StartTimerFailedEventAttributes ... 270

Contents ... 270

See Also ... 270

TagFilter ... 271

Contents ... 271

See Also ... 271

TaskList ... 272

Contents ... 272

See Also ... 272

TimerCanceledEventAttributes ... 273

Contents ... 273

See Also ... 273

TimerFiredEventAttributes ... 274

Contents ... 274

See Also ... 274

TimerStartedEventAttributes ... 275

Contents ... 275

See Also ... 275

WorkflowExecution ... 276

Contents ... 276

See Also ... 276

WorkflowExecutionCanceledEventAttributes ... 277

Contents ... 277

See Also ... 277

WorkflowExecutionCancelRequestedEventAttributes ... 278

Contents ... 278

See Also ... 278

WorkflowExecutionCompletedEventAttributes ... 279

Contents ... 279

See Also ... 279

WorkflowExecutionConfiguration ... 280

Contents ... 280

See Also ... 281

WorkflowExecutionContinuedAsNewEventAttributes ... 282

Contents ... 282

See Also ... 283

WorkflowExecutionFailedEventAttributes ... 285

(12)

Contents ... 285

See Also ... 285

WorkflowExecutionFilter ... 286

Contents ... 286

See Also ... 286

WorkflowExecutionInfo ... 287

Contents ... 287

See Also ... 288

WorkflowExecutionOpenCounts ... 289

Contents ... 289

See Also ... 289

WorkflowExecutionSignaledEventAttributes ... 291

Contents ... 291

See Also ... 291

WorkflowExecutionStartedEventAttributes ... 292

Contents ... 292

See Also ... 294

WorkflowExecutionTerminatedEventAttributes ... 295

Contents ... 295

See Also ... 295

WorkflowExecutionTimedOutEventAttributes ... 297

Contents ... 297

See Also ... 297

WorkflowType ... 298

Contents ... 298

See Also ... 298

WorkflowTypeConfiguration ... 299

Contents ... 299

See Also ... 300

WorkflowTypeFilter ... 301

Contents ... 301

See Also ... 301

WorkflowTypeInfo ... 302

Contents ... 302

See Also ... 302

Common Parameters ... 303

Common Errors ... 305

(13)

Welcome

The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.

Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.

This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide .

This document was last published on March 6, 2022.

(14)

Actions

The following actions are supported:

• CountClosedWorkflowExecutions (p. 3)

• CountOpenWorkflowExecutions (p. 8)

• CountPendingActivityTasks (p. 12)

• CountPendingDecisionTasks (p. 15)

• DeprecateActivityType (p. 18)

• DeprecateDomain (p. 21)

• DeprecateWorkflowType (p. 24)

• DescribeActivityType (p. 27)

• DescribeDomain (p. 31)

• DescribeWorkflowExecution (p. 34)

• DescribeWorkflowType (p. 39)

• GetWorkflowExecutionHistory (p. 43)

• ListActivityTypes (p. 55)

• ListClosedWorkflowExecutions (p. 59)

• ListDomains (p. 65)

• ListOpenWorkflowExecutions (p. 69)

• ListTagsForResource (p. 74)

• ListWorkflowTypes (p. 76)

• PollForActivityTask (p. 80)

• PollForDecisionTask (p. 85)

• RecordActivityTaskHeartbeat (p. 98)

• RegisterActivityType (p. 102)

• RegisterDomain (p. 107)

• RegisterWorkflowType (p. 111)

• RequestCancelWorkflowExecution (p. 117)

• RespondActivityTaskCanceled (p. 120)

• RespondActivityTaskCompleted (p. 123)

• RespondActivityTaskFailed (p. 126)

• RespondDecisionTaskCompleted (p. 129)

• SignalWorkflowExecution (p. 134)

• StartWorkflowExecution (p. 137)

• TagResource (p. 144)

• TerminateWorkflowExecution (p. 146)

• UndeprecateActivityType (p. 150)

• UndeprecateDomain (p. 152)

• UndeprecateWorkflowType (p. 154)

• UntagResource (p. 156)

(15)

CountClosedWorkflowExecutions

CountClosedWorkflowExecutions

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

NoteThis operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.

• Use an Action element to allow or deny permission to call this action.

• Constrain the following parameters by using a Condition element with the appropriate keys.

• tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

• typeFilter.name: String constraint. The key is swf:typeFilter.name.

• typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Request Syntax

{

"closeStatusFilter": { "status": "string"

},

"closeTimeFilter": { "latestDate": number, "oldestDate": number },

"domain": "string", "executionFilter": { "workflowId": "string"

},

"startTimeFilter": { "latestDate": number, "oldestDate": number },

"tagFilter": { "tag": "string"

},

"typeFilter": { "name": "string", "version": "string"

} }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 303).

(16)

Request Parameters

The request accepts the following data in JSON format.

closeStatusFilter (p. 3)

If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED.

Note

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Type: CloseStatusFilter (p. 190) object Required: No

closeTimeFilter (p. 3)

If specified, only workflow executions that meet the close time criteria of the filter are counted.

Note

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Type: ExecutionTimeFilter (p. 211) object Required: No

domain (p. 3)

The name of the domain containing the workflow executions to count.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes executionFilter (p. 3)

If specified, only workflow executions matching the WorkflowId in the filter are counted.

Note

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Type: WorkflowExecutionFilter (p. 286) object Required: No

startTimeFilter (p. 3)

If specified, only workflow executions that meet the start time criteria of the filter are counted.

Note

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Type: ExecutionTimeFilter (p. 211) object Required: No

tagFilter (p. 3)

If specified, only executions that have a tag that matches the filter are counted.

Note

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

(17)

Response Syntax

Type: TagFilter (p. 271) object Required: No

typeFilter (p. 3)

If specified, indicates the type of the workflow executions to be counted.

Note

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Type: WorkflowTypeFilter (p. 301) object Required: No

Response Syntax

{

"count": number, "truncated": boolean }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

count (p. 5)

The number of workflow executions.

Type: Integer

Valid Range: Minimum value of 0.

truncated (p. 5)

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.

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Errors (p. 305).

OperationNotPermittedFault

Returned when the caller doesn't have sufficient permissions to invoke the action.

HTTP Status Code: 400 UnknownResourceFault

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

(18)

Examples

HTTP Status Code: 400

Examples

CountClosedWorkflowExecutions Example

This example illustrates one usage of CountClosedWorkflowExecutions.

Sample Request

POST / HTTP/1.1

Host: swf.us-east-1.amazonaws.com

User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)

Accept: application/json, text/javascript, */*

Accept-Language: en-us,en;q=0.5 Accept-Encoding: gzip,deflate

Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7 Keep-Alive: 115

Connection: keep-alive

Content-Type: application/x-amz-json-1.0 X-Requested-With: XMLHttpRequest

X-Amz-Date: Sun, 15 Jan 2012 02:42:47 GMT

X-Amz-Target: SimpleWorkflowService.CountClosedWorkflowExecutions Content-Encoding: amz-1.0

X-Amzn-Authorization: AWS3

AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X- Amz-Target;Content-Encoding,Signature=jFS74utjeATV7vj72CWdLToPCKW0RQse6OEDkafB+SA=

Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html Content-Length: 157

Pragma: no-cache Cache-Control: no-cache { "domain": "867530901", "activityType": { "version": "1.0", "name": "activityVerify"

}}

Sample Response

HTTP/1.1 200 OK Content-Length: 29

Content-Type: application/json

x-amzn-RequestId: 9bfad387-3f22-11e1-9914-a356b6ea8bdf { "count":3, "truncated":false }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

(19)

See Also

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(20)

CountOpenWorkflowExecutions

CountOpenWorkflowExecutions

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

NoteThis operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.

• Use an Action element to allow or deny permission to call this action.

• Constrain the following parameters by using a Condition element with the appropriate keys.

• tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

• typeFilter.name: String constraint. The key is swf:typeFilter.name.

• typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Request Syntax

{ "domain": "string", "executionFilter": { "workflowId": "string"

},

"startTimeFilter": { "latestDate": number, "oldestDate": number },

"tagFilter": { "tag": "string"

},

"typeFilter": { "name": "string", "version": "string"

}}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 303).

The request accepts the following data in JSON format.

domain (p. 8)

The name of the domain containing the workflow executions to count.

(21)

Response Syntax

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes executionFilter (p. 8)

If specified, only workflow executions matching the WorkflowId in the filter are counted.

Note

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Type: WorkflowExecutionFilter (p. 286) object Required: No

startTimeFilter (p. 8)

Specifies the start time criteria that workflow executions must meet in order to be counted.

Type: ExecutionTimeFilter (p. 211) object Required: Yes

tagFilter (p. 8)

If specified, only executions that have a tag that matches the filter are counted.

Note

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Type: TagFilter (p. 271) object Required: No

typeFilter (p. 8)

Specifies the type of the workflow executions to be counted.

Note

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Type: WorkflowTypeFilter (p. 301) object Required: No

Response Syntax

{ "count": number, "truncated": boolean }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

(22)

Errors

count (p. 9)

The number of workflow executions.

Type: Integer

Valid Range: Minimum value of 0.

truncated (p. 9)

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.

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Errors (p. 305).

OperationNotPermittedFault

Returned when the caller doesn't have sufficient permissions to invoke the action.

HTTP Status Code: 400 UnknownResourceFault

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

HTTP Status Code: 400

Examples

CountOpenWorkflowExecutions Example

This example illustrates one usage of CountOpenWorkflowExecutions.

Sample Request

POST / HTTP/1.1

Host: swf.us-east-1.amazonaws.com

User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)

Accept: application/json, text/javascript, */*

Accept-Language: en-us,en;q=0.5 Accept-Encoding: gzip,deflate

Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7 Keep-Alive: 115

Connection: keep-alive

Content-Type: application/x-amz-json-1.0 X-Requested-With: XMLHttpRequest

X-Amz-Date: Sat, 14 Jan 2012 23:13:29 GMT

X-Amz-Target: SimpleWorkflowService.CountOpenWorkflowExecutions Content-Encoding: amz-1.0

X-Amzn-Authorization: AWS3

AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X- Amz-Target;Content-Encoding,Signature=3v6shiGzWukq4KiX/5HFMIUF/w5qajhW4dp+6AKyOtY=

(23)

See Also

Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html Content-Length: 150

Pragma: no-cache Cache-Control: no-cache {"domain": "867530901",

"startTimeFilter":

{"oldestDate": 1325376070,

"latestDate": 1356998399},

"tagFilter":

{"tag": "ricoh-the-dog"}

}

Sample Response

HTTP/1.1 200 OK Content-Length: 29

Content-Type: application/json

x-amzn-RequestId: 5ea6789e-3f05-11e1-9e8f-57bb03e21482 {"count":1,"truncated":false}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(24)

CountPendingActivityTasks

CountPendingActivityTasks

Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 is returned.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.

• Use an Action element to allow or deny permission to call this action.

• Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Request Syntax

{ "domain": "string", "taskList": { "name": "string"

} }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 303).

The request accepts the following data in JSON format.

domain (p. 12)

The name of the domain that contains the task list.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes taskList (p. 12)

The name of the task list.

Type: TaskList (p. 272) object Required: Yes

Response Syntax

{

(25)

Response Elements

"count": number, "truncated": boolean }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

count (p. 12)

The number of tasks in the task list.

Type: Integer

Valid Range: Minimum value of 0.

truncated (p. 12)

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.

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Errors (p. 305).

OperationNotPermittedFault

Returned when the caller doesn't have sufficient permissions to invoke the action.

HTTP Status Code: 400 UnknownResourceFault

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

HTTP Status Code: 400

Examples

CountPendingActivityTasks Example

This example illustrates one usage of CountPendingActivityTasks.

Sample Request

POST / HTTP/1.1

Host: swf.us-east-1.amazonaws.com

User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)

Accept: application/json, text/javascript, */*

Accept-Language: en-us,en;q=0.5

(26)

See Also

Accept-Encoding: gzip,deflate

Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7 Keep-Alive: 115

Connection: keep-alive

Content-Type: application/x-amz-json-1.0 X-Requested-With: XMLHttpRequest

X-Amz-Date: Mon, 16 Jan 2012 03:29:28 GMT

X-Amz-Target: SimpleWorkflowService.CountPendingActivityTasks Content-Encoding: amz-1.0

X-Amzn-Authorization: AWS3

AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X- Amz-Target;Content-Encoding,Signature=eCNiyyl5qmP0gGQ0hM8LqeRzxEvVZ0LAjE4oxVzzk9w=

Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html Content-Length: 70

Pragma: no-cache Cache-Control: no-cache {"domain": "867530901",

"taskList":

{"name": "specialTaskList"}

}

Sample Response

HTTP/1.1 200 OK Content-Length: 29

Content-Type: application/json

x-amzn-RequestId: 4b977c76-3ff2-11e1-a23a-99d60383ae71 {"count":1,"truncated":false}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(27)

CountPendingDecisionTasks

CountPendingDecisionTasks

Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 is returned.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.

• Use an Action element to allow or deny permission to call this action.

• Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Request Syntax

{ "domain": "string", "taskList": { "name": "string"

} }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 303).

The request accepts the following data in JSON format.

domain (p. 15)

The name of the domain that contains the task list.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes taskList (p. 15)

The name of the task list.

Type: TaskList (p. 272) object Required: Yes

Response Syntax

{

(28)

Response Elements

"count": number, "truncated": boolean }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

count (p. 15)

The number of tasks in the task list.

Type: Integer

Valid Range: Minimum value of 0.

truncated (p. 15)

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.

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Errors (p. 305).

OperationNotPermittedFault

Returned when the caller doesn't have sufficient permissions to invoke the action.

HTTP Status Code: 400 UnknownResourceFault

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

HTTP Status Code: 400

Examples

CountPendingDecisionTasks Example

This example illustrates one usage of CountPendingDecisionTasks.

Sample Request

POST / HTTP/1.1

Host: swf.us-east-1.amazonaws.com

User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)

Accept: application/json, text/javascript, */*

Accept-Language: en-us,en;q=0.5

(29)

See Also

Accept-Encoding: gzip,deflate

Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7 Keep-Alive: 115

Connection: keep-alive

Content-Type: application/x-amz-json-1.0 X-Requested-With: XMLHttpRequest

X-Amz-Date: Sun, 15 Jan 2012 23:25:57 GMT

X-Amz-Target: SimpleWorkflowService.CountPendingDecisionTasks Content-Encoding: amz-1.0

X-Amzn-Authorization: AWS3

AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X- Amz-Target;Content-Encoding,Signature=i9tUkWnZBLfn/T6BOymajCtwArAll6Stuh1x2C4dbsE=

Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html Content-Length: 70

Pragma: no-cache Cache-Control: no-cache {"domain": "867530901",

"taskList":

{"name": "specialTaskList"}

}

Sample Response

HTTP/1.1 200 OK Content-Length: 29

Content-Type: application/json

x-amzn-RequestId: 4718a364-3fd0-11e1-9914-a356b6ea8bdf {"count": 2,

"truncated": false}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(30)

DeprecateActivityType

DeprecateActivityType

Deprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated continue to run.

NoteThis operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.

• Use an Action element to allow or deny permission to call this action.

• Constrain the following parameters by using a Condition element with the appropriate keys.

• activityType.name: String constraint. The key is swf:activityType.name.

• activityType.version: String constraint. The key is swf:activityType.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Request Syntax

{

"activityType": { "name": "string", "version": "string"

},

"domain": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 303).

The request accepts the following data in JSON format.

activityType (p. 18)

The activity type to deprecate.

Type: ActivityType (p. 172) object Required: Yes

domain (p. 18)

The name of the domain in which the activity type is registered.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

(31)

Response Elements

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 305).

OperationNotPermittedFault

Returned when the caller doesn't have sufficient permissions to invoke the action.

HTTP Status Code: 400 TypeDeprecatedFault

Returned when the specified activity or workflow type was already deprecated.

HTTP Status Code: 400 UnknownResourceFault

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

HTTP Status Code: 400

Examples

DeprecateActivityType Example

This example illustrates one usage of DeprecateActivityType.

Sample Request

POST / HTTP/1.1

Host: swf.us-east-1.amazonaws.com

User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)

Accept: application/json, text/javascript, */*

Accept-Language: en-us,en;q=0.5 Accept-Encoding: gzip,deflate

Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7 Keep-Alive: 115

Connection: keep-alive

Content-Type: application/x-amz-json-1.0 X-Requested-With: XMLHttpRequest

X-Amz-Date: Mon, 16 Jan 2012 05:01:06 GMT

X-Amz-Target: SimpleWorkflowService.DeprecateActivityType Content-Encoding: amz-1.0

X-Amzn-Authorization: AWS3

AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X- Amz-Target;Content-Encoding,Signature=iX/mNMtNH6IaSNwfZq9hHOhDlLnp7buuj9tO93kRIrQ=

Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html Content-Length: 95

(32)

See Also

Pragma: no-cache Cache-Control: no-cache {"domain": "867530901",

"activityType":

{"name": "activityVerify",

"version": "1.0"}

}

Sample Response

HTTP/1.1 200 OK Content-Length: 0

Content-Type: application/json

x-amzn-RequestId: 191ee17e-3fff-11e1-a23a-99d60383ae71

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(33)

DeprecateDomain

DeprecateDomain

Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain.

Executions that were started before the domain was deprecated continues to run.

NoteThis operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.

• Use an Action element to allow or deny permission to call this action.

• You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Request Syntax

{ "name": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 303).

The request accepts the following data in JSON format.

name (p. 21)

The name of the domain to deprecate.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 305).

(34)

Examples

DomainDeprecatedFault

Returned when the specified domain has been deprecated.

HTTP Status Code: 400 OperationNotPermittedFault

Returned when the caller doesn't have sufficient permissions to invoke the action.

HTTP Status Code: 400 UnknownResourceFault

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

HTTP Status Code: 400

Examples

DeprecateDomain Example

This example illustrates one usage of DeprecateDomain.

Sample Request

POST / HTTP/1.1

Host: swf.us-east-1.amazonaws.com

User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)

Accept: application/json, text/javascript, */*

Accept-Language: en-us,en;q=0.5 Accept-Encoding: gzip,deflate

Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7 Keep-Alive: 115

Connection: keep-alive

Content-Type: application/x-amz-json-1.0 X-Requested-With: XMLHttpRequest

X-Amz-Date: Mon, 16 Jan 2012 05:07:47 GMT

X-Amz-Target: SimpleWorkflowService.DeprecateDomain Content-Encoding: amz-1.0

X-Amzn-Authorization: AWS3

AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X- Amz-Target;Content-Encoding,Signature=BkJDtbH9uZvrarqXTkBEYuYHO7PPygRI8ykV29Dz/5M=

Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html Content-Length: 21

Pragma: no-cache Cache-Control: no-cache {"name": "867530901"}

Sample Response

HTTP/1.1 200 OK Content-Length: 0

Content-Type: application/json

x-amzn-RequestId: 0800c01a-4000-11e1-9914-a356b6ea8bdf

(35)

See Also

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(36)

DeprecateWorkflowType

DeprecateWorkflowType

Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated continues to run. A deprecated workflow type may still be used when calling visibility actions.

NoteThis operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.

• Use an Action element to allow or deny permission to call this action.

• Constrain the following parameters by using a Condition element with the appropriate keys.

• workflowType.name: String constraint. The key is swf:workflowType.name.

• workflowType.version: String constraint. The key is swf:workflowType.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Request Syntax

{

"domain": "string", "workflowType": { "name": "string", "version": "string"

} }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 303).

The request accepts the following data in JSON format.

domain (p. 24)

The name of the domain in which the workflow type is registered.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes workflowType (p. 24)

The workflow type to deprecate.

Type: WorkflowType (p. 298) object

(37)

Response Elements

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 305).

OperationNotPermittedFault

Returned when the caller doesn't have sufficient permissions to invoke the action.

HTTP Status Code: 400 TypeDeprecatedFault

Returned when the specified activity or workflow type was already deprecated.

HTTP Status Code: 400 UnknownResourceFault

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

HTTP Status Code: 400

Examples

DeprecateWorkflowType Example

This example illustrates one usage of DeprecateWorkflowType.

Sample Request

POST / HTTP/1.1

Host: swf.us-east-1.amazonaws.com

User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)

Accept: application/json, text/javascript, */*

Accept-Language: en-us,en;q=0.5 Accept-Encoding: gzip,deflate

Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7 Keep-Alive: 115

Connection: keep-alive

Content-Type: application/x-amz-json-1.0 X-Requested-With: XMLHttpRequest

X-Amz-Date: Mon, 16 Jan 2012 05:04:47 GMT

X-Amz-Target: SimpleWorkflowService.DeprecateWorkflowType Content-Encoding: amz-1.0

X-Amzn-Authorization: AWS3

AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X- Amz-Target;Content-Encoding,Signature=BGrr1djQvp+YLq3ci2ffpK8KWhZm/PakBL2fFhc3zds=

Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html Content-Length: 102

(38)

See Also

Pragma: no-cache Cache-Control: no-cache {"domain": "867530901",

"workflowType":

{"name": "customerOrderWorkflow",

"version": "1.0"}

}

Sample Response

HTTP/1.1 200 OK Content-Length: 0

Content-Type: application/json

x-amzn-RequestId: 9c8d6d3b-3fff-11e1-9e8f-57bb03e21482

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(39)

DescribeActivityType

DescribeActivityType

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.

• Use an Action element to allow or deny permission to call this action.

• Constrain the following parameters by using a Condition element with the appropriate keys.

• activityType.name: String constraint. The key is swf:activityType.name.

• activityType.version: String constraint. The key is swf:activityType.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Request Syntax

{

"activityType": { "name": "string", "version": "string"

},

"domain": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 303).

The request accepts the following data in JSON format.

activityType (p. 27)

The activity type to get information about. Activity types are identified by the name and version that were supplied when the activity was registered.

Type: ActivityType (p. 172) object Required: Yes

domain (p. 27)

The name of the domain in which the activity type is registered.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

(40)

Response Syntax

Response Syntax

{ "configuration": {

"defaultTaskHeartbeatTimeout": "string", "defaultTaskList": {

"name": "string"

},

"defaultTaskPriority": "string",

"defaultTaskScheduleToCloseTimeout": "string", "defaultTaskScheduleToStartTimeout": "string", "defaultTaskStartToCloseTimeout": "string"

},

"typeInfo": {

"activityType": { "name": "string", "version": "string"

},

"creationDate": number, "deprecationDate": number, "description": "string", "status": "string"

}}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

configuration (p. 28)

The configuration settings registered with the activity type.

Type: ActivityTypeConfiguration (p. 173) object typeInfo (p. 28)

General information about the activity type.

The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.

• REGISTERED – The type is registered and available. Workers supporting this type should be running.

• DEPRECATED – The type was deprecated using DeprecateActivityType (p. 18), but is still in use.

You should keep workers supporting this type running. You cannot create new tasks of this type.

Type: ActivityTypeInfo (p. 175) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 305).

OperationNotPermittedFault

Returned when the caller doesn't have sufficient permissions to invoke the action.

HTTP Status Code: 400

(41)

Examples

UnknownResourceFault

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

HTTP Status Code: 400

Examples

DescribeActivityType Example

This example illustrates one usage of DescribeActivityType.

Sample Request

POST / HTTP/1.1

Host: swf.us-east-1.amazonaws.com

User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)

Accept: application/json, text/javascript, */*

Accept-Language: en-us,en;q=0.5 Accept-Encoding: gzip,deflate

Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7 Keep-Alive: 115

Connection: keep-alive

Content-Type: application/x-amz-json-1.0 X-Requested-With: XMLHttpRequest

X-Amz-Date: Sun, 15 Jan 2012 03:04:10 GMT

X-Amz-Target: SimpleWorkflowService.DescribeActivityType Content-Encoding: amz-1.0

X-Amzn-Authorization: AWS3

AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X- Amz-Target;Content-Encoding,Signature=XiGRwOZNLt+ic3VBWvIlRGdcFcRJVSE8J7zyZLU3oXg=

Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html Content-Length: 95

Pragma: no-cache Cache-Control: no-cache { "domain": "867530901", "activityType": { "version": "1.0", "name": "activityVerify"

}}

Sample Response

HTTP/1.1 200 OK Content-Length: 387

Content-Type: application/json

x-amzn-RequestId: 98d56ff5-3f25-11e1-9b11-7182192d0b57 {

"configuration": {

"defaultTaskHeartbeatTimeout": "120",

"defaultTaskList": {"name": "mainTaskList"}, "defaultTaskPriority", "100",

"defaultTaskScheduleToCloseTimeout": "900",

(42)

See Also

"defaultTaskScheduleToStartTimeout": "300", "defaultTaskStartToCloseTimeout": "600"

}, "typeInfo": {

"activityType": {"name": "activityVerify", "version": "1.0"}, "creationDate": 1326586446.471,

"description": "Verify the customer credit", "status": "REGISTERED"

} }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(43)

DescribeDomain

DescribeDomain

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.

• Use an Action element to allow or deny permission to call this action.

• You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Request Syntax

{

"name": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 303).

The request accepts the following data in JSON format.

name (p. 31)

The name of the domain to describe.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Response Syntax

{

"configuration": {

"workflowExecutionRetentionPeriodInDays": "string"

},

"domainInfo": { "arn": "string",

"description": "string", "name": "string", "status": "string"

}}

(44)

Response Elements

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

configuration (p. 31)

The domain configuration. Currently, this includes only the domain's retention period.

Type: DomainConfiguration (p. 208) object domainInfo (p. 31)

The basic information about a domain, such as its name, status, and description.

Type: DomainInfo (p. 209) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 305).

OperationNotPermittedFault

Returned when the caller doesn't have sufficient permissions to invoke the action.

HTTP Status Code: 400 UnknownResourceFault

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

HTTP Status Code: 400

Examples

DescribeDomain Example

This example illustrates one usage of DescribeDomain.

Sample Request

POST / HTTP/1.1

Host: swf.us-east-1.amazonaws.com

User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)

Accept: application/json, text/javascript, */*

Accept-Language: en-us,en;q=0.5 Accept-Encoding: gzip,deflate

Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7 Keep-Alive: 115

Connection: keep-alive

Content-Type: application/x-amz-json-1.0 X-Requested-With: XMLHttpRequest

X-Amz-Date: Sun, 15 Jan 2012 03:13:33 GMT

X-Amz-Target: SimpleWorkflowService.DescribeDomain

(45)

See Also

Content-Encoding: amz-1.0 X-Amzn-Authorization: AWS3

AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X- Amz-Target;Content-Encoding,Signature=IFJtq3M366CHqMlTpyqYqd9z0ChCoKDC5SCJBsLifu4=

Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html Content-Length: 21

Pragma: no-cache Cache-Control: no-cache {"name": "867530901"}

Sample Response

HTTP/1.1 200 OK Content-Length: 137

Content-Type: application/json

x-amzn-RequestId: e86a6779-3f26-11e1-9a27-0760db01a4a8 {"configuration":

{"workflowExecutionRetentionPeriodInDays": "60"}, "domainInfo":

{"description": "music", "name": "867530901", "status": "REGISTERED"}

}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

(46)

DescribeWorkflowExecution

DescribeWorkflowExecution

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

Note

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.

• Use an Action element to allow or deny permission to call this action.

• You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Request Syntax

{

"domain": "string", "execution": { "runId": "string", "workflowId": "string"

} }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 303).

The request accepts the following data in JSON format.

domain (p. 34)

The name of the domain containing the workflow execution.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes execution (p. 34)

The workflow execution to describe.

Type: WorkflowExecution (p. 276) object Required: Yes

參考文獻

相關文件

This document uses the terminology defined in the UPnP Architecture document, such as: action, SST variable, and action parameter. This sub-section defines the following

了⼀一個方案,用以尋找滿足 Calabi 方程的空 間,這些空間現在通稱為 Calabi-Yau 空間。.

Reading Task 6: Genre Structure and Language Features. • Now let’s look at how language features (e.g. sentence patterns) are connected to the structure

• ‘ content teachers need to support support the learning of those parts of language knowledge that students are missing and that may be preventing them mastering the

• School-based curriculum is enriched to allow for value addedness in the reading and writing performance of the students. • Students have a positive attitude and are interested and

volume suppressed mass: (TeV) 2 /M P ∼ 10 −4 eV → mm range can be experimentally tested for any number of extra dimensions - Light U(1) gauge bosons: no derivative couplings. =>

• Formation of massive primordial stars as origin of objects in the early universe. • Supernova explosions might be visible to the most

This kind of algorithm has also been a powerful tool for solving many other optimization problems, including symmetric cone complementarity problems [15, 16, 20–22], symmetric