-
Notifications
You must be signed in to change notification settings - Fork 553
/
RespondActivityTaskFailedCommand.ts
177 lines (166 loc) · 7.3 KB
/
RespondActivityTaskFailedCommand.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
// 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 { RespondActivityTaskFailedInput } from "../models/models_0";
import { de_RespondActivityTaskFailedCommand, se_RespondActivityTaskFailedCommand } from "../protocols/Aws_json1_0";
import { ServiceInputTypes, ServiceOutputTypes, SWFClientResolvedConfig } from "../SWFClient";
/**
* @public
*
* The input for {@link RespondActivityTaskFailedCommand}.
*/
export interface RespondActivityTaskFailedCommandInput extends RespondActivityTaskFailedInput {}
/**
* @public
*
* The output of {@link RespondActivityTaskFailedCommand}.
*/
export interface RespondActivityTaskFailedCommandOutput extends __MetadataBearer {}
/**
* @public
* <p>Used by workers to tell the service that the <a>ActivityTask</a> identified
* by the <code>taskToken</code> has failed with <code>reason</code> (if specified). The
* <code>reason</code> and <code>details</code> appear in the <code>ActivityTaskFailed</code>
* event added to the workflow history.</p>
* <p>A task is considered open from the time that it is scheduled until it is closed.
* Therefore a task is reported as open while a worker is processing it. A task is closed after
* it has been specified in a call to <a>RespondActivityTaskCompleted</a>, <a>RespondActivityTaskCanceled</a>, RespondActivityTaskFailed, or the task has <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types">timed
* out</a>.</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>You cannot use an IAM policy to constrain this action's parameters.</p>
* </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, RespondActivityTaskFailedCommand } from "@aws-sdk/client-swf"; // ES Modules import
* // const { SWFClient, RespondActivityTaskFailedCommand } = require("@aws-sdk/client-swf"); // CommonJS import
* const client = new SWFClient(config);
* const input = { // RespondActivityTaskFailedInput
* taskToken: "STRING_VALUE", // required
* reason: "STRING_VALUE",
* details: "STRING_VALUE",
* };
* const command = new RespondActivityTaskFailedCommand(input);
* const response = await client.send(command);
* // {};
*
* ```
*
* @param RespondActivityTaskFailedCommandInput - {@link RespondActivityTaskFailedCommandInput}
* @returns {@link RespondActivityTaskFailedCommandOutput}
* @see {@link RespondActivityTaskFailedCommandInput} for command's `input` shape.
* @see {@link RespondActivityTaskFailedCommandOutput} for command's `response` shape.
* @see {@link SWFClientResolvedConfig | config} for SWFClient's `config` shape.
*
* @throws {@link OperationNotPermittedFault} (client fault)
* <p>Returned when the caller doesn't have sufficient permissions to invoke the action.</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 SWFServiceException}
* <p>Base exception class for all service exceptions from SWF service.</p>
*
*/
export class RespondActivityTaskFailedCommand extends $Command<
RespondActivityTaskFailedCommandInput,
RespondActivityTaskFailedCommandOutput,
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: RespondActivityTaskFailedCommandInput) {
// Start section: command_constructor
super();
// End section: command_constructor
}
/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: SWFClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler<RespondActivityTaskFailedCommandInput, RespondActivityTaskFailedCommandOutput> {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.middlewareStack.use(
getEndpointPlugin(configuration, RespondActivityTaskFailedCommand.getEndpointParameterInstructions())
);
const stack = clientStack.concat(this.middlewareStack);
const { logger } = configuration;
const clientName = "SWFClient";
const commandName = "RespondActivityTaskFailedCommand";
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: RespondActivityTaskFailedCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
return se_RespondActivityTaskFailedCommand(input, context);
}
/**
* @internal
*/
private deserialize(
output: __HttpResponse,
context: __SerdeContext
): Promise<RespondActivityTaskFailedCommandOutput> {
return de_RespondActivityTaskFailedCommand(output, context);
}
// Start section: command_body_extra
// End section: command_body_extra
}