-
Notifications
You must be signed in to change notification settings - Fork 552
/
StartWorkflowExecutionCommand.ts
247 lines (236 loc) · 10.2 KB
/
StartWorkflowExecutionCommand.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
// smithy-typescript generated code
import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
import { Command as $Command } from "@aws-sdk/smithy-client";
import {
FinalizeHandlerArguments,
Handler,
HandlerExecutionContext,
HttpHandlerOptions as __HttpHandlerOptions,
MetadataBearer as __MetadataBearer,
MiddlewareStack,
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";
import { Run, StartWorkflowExecutionInput } from "../models/models_0";
import { de_StartWorkflowExecutionCommand, se_StartWorkflowExecutionCommand } from "../protocols/Aws_json1_0";
import { ServiceInputTypes, ServiceOutputTypes, SWFClientResolvedConfig } from "../SWFClient";
/**
* @public
*
* The input for {@link StartWorkflowExecutionCommand}.
*/
export interface StartWorkflowExecutionCommandInput extends StartWorkflowExecutionInput {}
/**
* @public
*
* The output of {@link StartWorkflowExecutionCommand}.
*/
export interface StartWorkflowExecutionCommandOutput extends Run, __MetadataBearer {}
/**
* @public
* <p>Starts an execution of the workflow type in the specified domain using the provided
* <code>workflowId</code> and input data.</p>
* <p>This action returns the newly started workflow execution.</p>
* <p>
* <b>Access Control</b>
* </p>
* <p>You can use IAM policies to control this action's access to Amazon SWF resources as
* follows:</p>
* <ul>
* <li>
* <p>Use a <code>Resource</code> element with the domain name to limit the action to
* only specified domains.</p>
* </li>
* <li>
* <p>Use an <code>Action</code> element to allow or deny permission to call this
* action.</p>
* </li>
* <li>
* <p>Constrain the following parameters by using a <code>Condition</code> element with
* the appropriate keys.</p>
* <ul>
* <li>
* <p>
* <code>tagList.member.0</code>: The key is <code>swf:tagList.member.0</code>.</p>
* </li>
* <li>
* <p>
* <code>tagList.member.1</code>: The key is <code>swf:tagList.member.1</code>.</p>
* </li>
* <li>
* <p>
* <code>tagList.member.2</code>: The key is <code>swf:tagList.member.2</code>.</p>
* </li>
* <li>
* <p>
* <code>tagList.member.3</code>: The key is <code>swf:tagList.member.3</code>.</p>
* </li>
* <li>
* <p>
* <code>tagList.member.4</code>: The key is <code>swf:tagList.member.4</code>.</p>
* </li>
* <li>
* <p>
* <code>taskList</code>: String constraint. The key is
* <code>swf:taskList.name</code>.</p>
* </li>
* <li>
* <p>
* <code>workflowType.name</code>: String constraint. The key is
* <code>swf:workflowType.name</code>.</p>
* </li>
* <li>
* <p>
* <code>workflowType.version</code>: String constraint. The key is
* <code>swf:workflowType.version</code>.</p>
* </li>
* </ul>
* </li>
* </ul>
* <p>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 <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
* For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
* Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { SWFClient, StartWorkflowExecutionCommand } from "@aws-sdk/client-swf"; // ES Modules import
* // const { SWFClient, StartWorkflowExecutionCommand } = require("@aws-sdk/client-swf"); // CommonJS import
* const client = new SWFClient(config);
* const input = { // StartWorkflowExecutionInput
* domain: "STRING_VALUE", // required
* workflowId: "STRING_VALUE", // required
* workflowType: { // WorkflowType
* name: "STRING_VALUE", // required
* version: "STRING_VALUE", // required
* },
* taskList: { // TaskList
* name: "STRING_VALUE", // required
* },
* taskPriority: "STRING_VALUE",
* input: "STRING_VALUE",
* executionStartToCloseTimeout: "STRING_VALUE",
* tagList: [ // TagList
* "STRING_VALUE",
* ],
* taskStartToCloseTimeout: "STRING_VALUE",
* childPolicy: "TERMINATE" || "REQUEST_CANCEL" || "ABANDON",
* lambdaRole: "STRING_VALUE",
* };
* const command = new StartWorkflowExecutionCommand(input);
* const response = await client.send(command);
* // { // Run
* // runId: "STRING_VALUE",
* // };
*
* ```
*
* @param StartWorkflowExecutionCommandInput - {@link StartWorkflowExecutionCommandInput}
* @returns {@link StartWorkflowExecutionCommandOutput}
* @see {@link StartWorkflowExecutionCommandInput} for command's `input` shape.
* @see {@link StartWorkflowExecutionCommandOutput} for command's `response` shape.
* @see {@link SWFClientResolvedConfig | config} for SWFClient's `config` shape.
*
* @throws {@link DefaultUndefinedFault} (client fault)
* <p>The <code>StartWorkflowExecution</code> API action was called without the required
* parameters set.</p>
* <p>Some workflow execution parameters, such as the decision <code>taskList</code>, must be
* set to start the execution. However, these parameters might have been set as defaults when the
* workflow type was registered. In this case, you can omit these parameters from the
* <code>StartWorkflowExecution</code> call and Amazon SWF uses the values defined in the workflow
* type.</p>
* <note>
* <p>If these parameters aren't set and no default parameters were defined in the workflow
* type, this error is displayed.</p>
* </note>
*
* @throws {@link LimitExceededFault} (client fault)
* <p>Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.</p>
*
* @throws {@link OperationNotPermittedFault} (client fault)
* <p>Returned when the caller doesn't have sufficient permissions to invoke the action.</p>
*
* @throws {@link TypeDeprecatedFault} (client fault)
* <p>Returned when the specified activity or workflow type was already deprecated.</p>
*
* @throws {@link UnknownResourceFault} (client fault)
* <p>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.</p>
*
* @throws {@link WorkflowExecutionAlreadyStartedFault} (client fault)
* <p>Returned by <a>StartWorkflowExecution</a> when an open execution with the same workflowId is already running in
* the specified domain.</p>
*
* @throws {@link SWFServiceException}
* <p>Base exception class for all service exceptions from SWF service.</p>
*
*/
export class StartWorkflowExecutionCommand extends $Command<
StartWorkflowExecutionCommandInput,
StartWorkflowExecutionCommandOutput,
SWFClientResolvedConfig
> {
// Start section: command_properties
// End section: command_properties
public static getEndpointParameterInstructions(): EndpointParameterInstructions {
return {
UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
Endpoint: { type: "builtInParams", name: "endpoint" },
Region: { type: "builtInParams", name: "region" },
UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
};
}
/**
* @public
*/
constructor(readonly input: StartWorkflowExecutionCommandInput) {
// Start section: command_constructor
super();
// End section: command_constructor
}
/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: SWFClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler<StartWorkflowExecutionCommandInput, StartWorkflowExecutionCommandOutput> {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.middlewareStack.use(
getEndpointPlugin(configuration, StartWorkflowExecutionCommand.getEndpointParameterInstructions())
);
const stack = clientStack.concat(this.middlewareStack);
const { logger } = configuration;
const clientName = "SWFClient";
const commandName = "StartWorkflowExecutionCommand";
const handlerExecutionContext: HandlerExecutionContext = {
logger,
clientName,
commandName,
inputFilterSensitiveLog: (_: any) => _,
outputFilterSensitiveLog: (_: any) => _,
};
const { requestHandler } = configuration;
return stack.resolve(
(request: FinalizeHandlerArguments<any>) =>
requestHandler.handle(request.request as __HttpRequest, options || {}),
handlerExecutionContext
);
}
/**
* @internal
*/
private serialize(input: StartWorkflowExecutionCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
return se_StartWorkflowExecutionCommand(input, context);
}
/**
* @internal
*/
private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<StartWorkflowExecutionCommandOutput> {
return de_StartWorkflowExecutionCommand(output, context);
}
// Start section: command_body_extra
// End section: command_body_extra
}