@aws-sdk/client-sfn 3.357.0 → 3.359.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +64 -0
- package/dist-cjs/SFN.js +16 -0
- package/dist-cjs/commands/CreateStateMachineAliasCommand.js +47 -0
- package/dist-cjs/commands/DeleteStateMachineAliasCommand.js +46 -0
- package/dist-cjs/commands/DeleteStateMachineVersionCommand.js +46 -0
- package/dist-cjs/commands/DescribeStateMachineAliasCommand.js +47 -0
- package/dist-cjs/commands/ListStateMachineAliasesCommand.js +46 -0
- package/dist-cjs/commands/ListStateMachineVersionsCommand.js +46 -0
- package/dist-cjs/commands/PublishStateMachineVersionCommand.js +47 -0
- package/dist-cjs/commands/UpdateStateMachineAliasCommand.js +47 -0
- package/dist-cjs/commands/index.js +8 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +66 -16
- package/dist-cjs/protocols/Aws_json1_0.js +510 -2
- package/dist-es/SFN.js +16 -0
- package/dist-es/commands/CreateStateMachineAliasCommand.js +43 -0
- package/dist-es/commands/DeleteStateMachineAliasCommand.js +42 -0
- package/dist-es/commands/DeleteStateMachineVersionCommand.js +42 -0
- package/dist-es/commands/DescribeStateMachineAliasCommand.js +43 -0
- package/dist-es/commands/ListStateMachineAliasesCommand.js +42 -0
- package/dist-es/commands/ListStateMachineVersionsCommand.js +42 -0
- package/dist-es/commands/PublishStateMachineVersionCommand.js +43 -0
- package/dist-es/commands/UpdateStateMachineAliasCommand.js +43 -0
- package/dist-es/commands/index.js +8 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +57 -13
- package/dist-es/protocols/Aws_json1_0.js +493 -1
- package/dist-types/SFN.d.ts +56 -0
- package/dist-types/SFNClient.d.ts +10 -2
- package/dist-types/commands/CreateStateMachineAliasCommand.d.ts +144 -0
- package/dist-types/commands/CreateStateMachineCommand.d.ts +14 -2
- package/dist-types/commands/DeleteStateMachineAliasCommand.d.ts +112 -0
- package/dist-types/commands/DeleteStateMachineCommand.d.ts +21 -6
- package/dist-types/commands/DeleteStateMachineVersionCommand.d.ts +106 -0
- package/dist-types/commands/DescribeExecutionCommand.d.ts +9 -2
- package/dist-types/commands/DescribeMapRunCommand.d.ts +1 -2
- package/dist-types/commands/DescribeStateMachineAliasCommand.d.ts +117 -0
- package/dist-types/commands/DescribeStateMachineCommand.d.ts +33 -4
- package/dist-types/commands/DescribeStateMachineForExecutionCommand.d.ts +7 -1
- package/dist-types/commands/GetActivityTaskCommand.d.ts +0 -2
- package/dist-types/commands/GetExecutionHistoryCommand.d.ts +2 -0
- package/dist-types/commands/ListExecutionsCommand.d.ts +4 -2
- package/dist-types/commands/ListStateMachineAliasesCommand.d.ts +124 -0
- package/dist-types/commands/ListStateMachineVersionsCommand.d.ts +108 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -2
- package/dist-types/commands/PublishStateMachineVersionCommand.d.ts +122 -0
- package/dist-types/commands/StartExecutionCommand.d.ts +37 -9
- package/dist-types/commands/TagResourceCommand.d.ts +1 -2
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -2
- package/dist-types/commands/UpdateMapRunCommand.d.ts +1 -2
- package/dist-types/commands/UpdateStateMachineAliasCommand.d.ts +132 -0
- package/dist-types/commands/UpdateStateMachineCommand.d.ts +49 -7
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +475 -36
- package/dist-types/protocols/Aws_json1_0.d.ts +72 -0
- package/dist-types/ts3.4/SFN.d.ts +136 -0
- package/dist-types/ts3.4/SFNClient.d.ts +48 -0
- package/dist-types/ts3.4/commands/CreateStateMachineAliasCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteStateMachineAliasCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteStateMachineVersionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DescribeStateMachineAliasCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListStateMachineAliasesCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListStateMachineVersionsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/PublishStateMachineVersionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateStateMachineAliasCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +130 -14
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +96 -0
- package/package.json +6 -6
package/dist-types/SFN.d.ts
CHANGED
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
2
2
|
import { CreateActivityCommandInput, CreateActivityCommandOutput } from "./commands/CreateActivityCommand";
|
|
3
|
+
import { CreateStateMachineAliasCommandInput, CreateStateMachineAliasCommandOutput } from "./commands/CreateStateMachineAliasCommand";
|
|
3
4
|
import { CreateStateMachineCommandInput, CreateStateMachineCommandOutput } from "./commands/CreateStateMachineCommand";
|
|
4
5
|
import { DeleteActivityCommandInput, DeleteActivityCommandOutput } from "./commands/DeleteActivityCommand";
|
|
6
|
+
import { DeleteStateMachineAliasCommandInput, DeleteStateMachineAliasCommandOutput } from "./commands/DeleteStateMachineAliasCommand";
|
|
5
7
|
import { DeleteStateMachineCommandInput, DeleteStateMachineCommandOutput } from "./commands/DeleteStateMachineCommand";
|
|
8
|
+
import { DeleteStateMachineVersionCommandInput, DeleteStateMachineVersionCommandOutput } from "./commands/DeleteStateMachineVersionCommand";
|
|
6
9
|
import { DescribeActivityCommandInput, DescribeActivityCommandOutput } from "./commands/DescribeActivityCommand";
|
|
7
10
|
import { DescribeExecutionCommandInput, DescribeExecutionCommandOutput } from "./commands/DescribeExecutionCommand";
|
|
8
11
|
import { DescribeMapRunCommandInput, DescribeMapRunCommandOutput } from "./commands/DescribeMapRunCommand";
|
|
12
|
+
import { DescribeStateMachineAliasCommandInput, DescribeStateMachineAliasCommandOutput } from "./commands/DescribeStateMachineAliasCommand";
|
|
9
13
|
import { DescribeStateMachineCommandInput, DescribeStateMachineCommandOutput } from "./commands/DescribeStateMachineCommand";
|
|
10
14
|
import { DescribeStateMachineForExecutionCommandInput, DescribeStateMachineForExecutionCommandOutput } from "./commands/DescribeStateMachineForExecutionCommand";
|
|
11
15
|
import { GetActivityTaskCommandInput, GetActivityTaskCommandOutput } from "./commands/GetActivityTaskCommand";
|
|
@@ -13,8 +17,11 @@ import { GetExecutionHistoryCommandInput, GetExecutionHistoryCommandOutput } fro
|
|
|
13
17
|
import { ListActivitiesCommandInput, ListActivitiesCommandOutput } from "./commands/ListActivitiesCommand";
|
|
14
18
|
import { ListExecutionsCommandInput, ListExecutionsCommandOutput } from "./commands/ListExecutionsCommand";
|
|
15
19
|
import { ListMapRunsCommandInput, ListMapRunsCommandOutput } from "./commands/ListMapRunsCommand";
|
|
20
|
+
import { ListStateMachineAliasesCommandInput, ListStateMachineAliasesCommandOutput } from "./commands/ListStateMachineAliasesCommand";
|
|
16
21
|
import { ListStateMachinesCommandInput, ListStateMachinesCommandOutput } from "./commands/ListStateMachinesCommand";
|
|
22
|
+
import { ListStateMachineVersionsCommandInput, ListStateMachineVersionsCommandOutput } from "./commands/ListStateMachineVersionsCommand";
|
|
17
23
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
24
|
+
import { PublishStateMachineVersionCommandInput, PublishStateMachineVersionCommandOutput } from "./commands/PublishStateMachineVersionCommand";
|
|
18
25
|
import { SendTaskFailureCommandInput, SendTaskFailureCommandOutput } from "./commands/SendTaskFailureCommand";
|
|
19
26
|
import { SendTaskHeartbeatCommandInput, SendTaskHeartbeatCommandOutput } from "./commands/SendTaskHeartbeatCommand";
|
|
20
27
|
import { SendTaskSuccessCommandInput, SendTaskSuccessCommandOutput } from "./commands/SendTaskSuccessCommand";
|
|
@@ -24,6 +31,7 @@ import { StopExecutionCommandInput, StopExecutionCommandOutput } from "./command
|
|
|
24
31
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
25
32
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
26
33
|
import { UpdateMapRunCommandInput, UpdateMapRunCommandOutput } from "./commands/UpdateMapRunCommand";
|
|
34
|
+
import { UpdateStateMachineAliasCommandInput, UpdateStateMachineAliasCommandOutput } from "./commands/UpdateStateMachineAliasCommand";
|
|
27
35
|
import { UpdateStateMachineCommandInput, UpdateStateMachineCommandOutput } from "./commands/UpdateStateMachineCommand";
|
|
28
36
|
import { SFNClient } from "./SFNClient";
|
|
29
37
|
export interface SFN {
|
|
@@ -39,6 +47,12 @@ export interface SFN {
|
|
|
39
47
|
createStateMachine(args: CreateStateMachineCommandInput, options?: __HttpHandlerOptions): Promise<CreateStateMachineCommandOutput>;
|
|
40
48
|
createStateMachine(args: CreateStateMachineCommandInput, cb: (err: any, data?: CreateStateMachineCommandOutput) => void): void;
|
|
41
49
|
createStateMachine(args: CreateStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStateMachineCommandOutput) => void): void;
|
|
50
|
+
/**
|
|
51
|
+
* @see {@link CreateStateMachineAliasCommand}
|
|
52
|
+
*/
|
|
53
|
+
createStateMachineAlias(args: CreateStateMachineAliasCommandInput, options?: __HttpHandlerOptions): Promise<CreateStateMachineAliasCommandOutput>;
|
|
54
|
+
createStateMachineAlias(args: CreateStateMachineAliasCommandInput, cb: (err: any, data?: CreateStateMachineAliasCommandOutput) => void): void;
|
|
55
|
+
createStateMachineAlias(args: CreateStateMachineAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStateMachineAliasCommandOutput) => void): void;
|
|
42
56
|
/**
|
|
43
57
|
* @see {@link DeleteActivityCommand}
|
|
44
58
|
*/
|
|
@@ -51,6 +65,18 @@ export interface SFN {
|
|
|
51
65
|
deleteStateMachine(args: DeleteStateMachineCommandInput, options?: __HttpHandlerOptions): Promise<DeleteStateMachineCommandOutput>;
|
|
52
66
|
deleteStateMachine(args: DeleteStateMachineCommandInput, cb: (err: any, data?: DeleteStateMachineCommandOutput) => void): void;
|
|
53
67
|
deleteStateMachine(args: DeleteStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStateMachineCommandOutput) => void): void;
|
|
68
|
+
/**
|
|
69
|
+
* @see {@link DeleteStateMachineAliasCommand}
|
|
70
|
+
*/
|
|
71
|
+
deleteStateMachineAlias(args: DeleteStateMachineAliasCommandInput, options?: __HttpHandlerOptions): Promise<DeleteStateMachineAliasCommandOutput>;
|
|
72
|
+
deleteStateMachineAlias(args: DeleteStateMachineAliasCommandInput, cb: (err: any, data?: DeleteStateMachineAliasCommandOutput) => void): void;
|
|
73
|
+
deleteStateMachineAlias(args: DeleteStateMachineAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStateMachineAliasCommandOutput) => void): void;
|
|
74
|
+
/**
|
|
75
|
+
* @see {@link DeleteStateMachineVersionCommand}
|
|
76
|
+
*/
|
|
77
|
+
deleteStateMachineVersion(args: DeleteStateMachineVersionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteStateMachineVersionCommandOutput>;
|
|
78
|
+
deleteStateMachineVersion(args: DeleteStateMachineVersionCommandInput, cb: (err: any, data?: DeleteStateMachineVersionCommandOutput) => void): void;
|
|
79
|
+
deleteStateMachineVersion(args: DeleteStateMachineVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStateMachineVersionCommandOutput) => void): void;
|
|
54
80
|
/**
|
|
55
81
|
* @see {@link DescribeActivityCommand}
|
|
56
82
|
*/
|
|
@@ -75,6 +101,12 @@ export interface SFN {
|
|
|
75
101
|
describeStateMachine(args: DescribeStateMachineCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStateMachineCommandOutput>;
|
|
76
102
|
describeStateMachine(args: DescribeStateMachineCommandInput, cb: (err: any, data?: DescribeStateMachineCommandOutput) => void): void;
|
|
77
103
|
describeStateMachine(args: DescribeStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStateMachineCommandOutput) => void): void;
|
|
104
|
+
/**
|
|
105
|
+
* @see {@link DescribeStateMachineAliasCommand}
|
|
106
|
+
*/
|
|
107
|
+
describeStateMachineAlias(args: DescribeStateMachineAliasCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStateMachineAliasCommandOutput>;
|
|
108
|
+
describeStateMachineAlias(args: DescribeStateMachineAliasCommandInput, cb: (err: any, data?: DescribeStateMachineAliasCommandOutput) => void): void;
|
|
109
|
+
describeStateMachineAlias(args: DescribeStateMachineAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStateMachineAliasCommandOutput) => void): void;
|
|
78
110
|
/**
|
|
79
111
|
* @see {@link DescribeStateMachineForExecutionCommand}
|
|
80
112
|
*/
|
|
@@ -111,18 +143,36 @@ export interface SFN {
|
|
|
111
143
|
listMapRuns(args: ListMapRunsCommandInput, options?: __HttpHandlerOptions): Promise<ListMapRunsCommandOutput>;
|
|
112
144
|
listMapRuns(args: ListMapRunsCommandInput, cb: (err: any, data?: ListMapRunsCommandOutput) => void): void;
|
|
113
145
|
listMapRuns(args: ListMapRunsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMapRunsCommandOutput) => void): void;
|
|
146
|
+
/**
|
|
147
|
+
* @see {@link ListStateMachineAliasesCommand}
|
|
148
|
+
*/
|
|
149
|
+
listStateMachineAliases(args: ListStateMachineAliasesCommandInput, options?: __HttpHandlerOptions): Promise<ListStateMachineAliasesCommandOutput>;
|
|
150
|
+
listStateMachineAliases(args: ListStateMachineAliasesCommandInput, cb: (err: any, data?: ListStateMachineAliasesCommandOutput) => void): void;
|
|
151
|
+
listStateMachineAliases(args: ListStateMachineAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStateMachineAliasesCommandOutput) => void): void;
|
|
114
152
|
/**
|
|
115
153
|
* @see {@link ListStateMachinesCommand}
|
|
116
154
|
*/
|
|
117
155
|
listStateMachines(args: ListStateMachinesCommandInput, options?: __HttpHandlerOptions): Promise<ListStateMachinesCommandOutput>;
|
|
118
156
|
listStateMachines(args: ListStateMachinesCommandInput, cb: (err: any, data?: ListStateMachinesCommandOutput) => void): void;
|
|
119
157
|
listStateMachines(args: ListStateMachinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStateMachinesCommandOutput) => void): void;
|
|
158
|
+
/**
|
|
159
|
+
* @see {@link ListStateMachineVersionsCommand}
|
|
160
|
+
*/
|
|
161
|
+
listStateMachineVersions(args: ListStateMachineVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListStateMachineVersionsCommandOutput>;
|
|
162
|
+
listStateMachineVersions(args: ListStateMachineVersionsCommandInput, cb: (err: any, data?: ListStateMachineVersionsCommandOutput) => void): void;
|
|
163
|
+
listStateMachineVersions(args: ListStateMachineVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStateMachineVersionsCommandOutput) => void): void;
|
|
120
164
|
/**
|
|
121
165
|
* @see {@link ListTagsForResourceCommand}
|
|
122
166
|
*/
|
|
123
167
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
124
168
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
125
169
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
170
|
+
/**
|
|
171
|
+
* @see {@link PublishStateMachineVersionCommand}
|
|
172
|
+
*/
|
|
173
|
+
publishStateMachineVersion(args: PublishStateMachineVersionCommandInput, options?: __HttpHandlerOptions): Promise<PublishStateMachineVersionCommandOutput>;
|
|
174
|
+
publishStateMachineVersion(args: PublishStateMachineVersionCommandInput, cb: (err: any, data?: PublishStateMachineVersionCommandOutput) => void): void;
|
|
175
|
+
publishStateMachineVersion(args: PublishStateMachineVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishStateMachineVersionCommandOutput) => void): void;
|
|
126
176
|
/**
|
|
127
177
|
* @see {@link SendTaskFailureCommand}
|
|
128
178
|
*/
|
|
@@ -183,6 +233,12 @@ export interface SFN {
|
|
|
183
233
|
updateStateMachine(args: UpdateStateMachineCommandInput, options?: __HttpHandlerOptions): Promise<UpdateStateMachineCommandOutput>;
|
|
184
234
|
updateStateMachine(args: UpdateStateMachineCommandInput, cb: (err: any, data?: UpdateStateMachineCommandOutput) => void): void;
|
|
185
235
|
updateStateMachine(args: UpdateStateMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStateMachineCommandOutput) => void): void;
|
|
236
|
+
/**
|
|
237
|
+
* @see {@link UpdateStateMachineAliasCommand}
|
|
238
|
+
*/
|
|
239
|
+
updateStateMachineAlias(args: UpdateStateMachineAliasCommandInput, options?: __HttpHandlerOptions): Promise<UpdateStateMachineAliasCommandOutput>;
|
|
240
|
+
updateStateMachineAlias(args: UpdateStateMachineAliasCommandInput, cb: (err: any, data?: UpdateStateMachineAliasCommandOutput) => void): void;
|
|
241
|
+
updateStateMachineAlias(args: UpdateStateMachineAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStateMachineAliasCommandOutput) => void): void;
|
|
186
242
|
}
|
|
187
243
|
/**
|
|
188
244
|
* @public
|
|
@@ -9,12 +9,16 @@ import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as
|
|
|
9
9
|
import { HttpHandler as __HttpHandler } from "@smithy/protocol-http";
|
|
10
10
|
import { Decoder as __Decoder, Encoder as __Encoder, Provider as __Provider, StreamCollector as __StreamCollector } from "@smithy/types";
|
|
11
11
|
import { CreateActivityCommandInput, CreateActivityCommandOutput } from "./commands/CreateActivityCommand";
|
|
12
|
+
import { CreateStateMachineAliasCommandInput, CreateStateMachineAliasCommandOutput } from "./commands/CreateStateMachineAliasCommand";
|
|
12
13
|
import { CreateStateMachineCommandInput, CreateStateMachineCommandOutput } from "./commands/CreateStateMachineCommand";
|
|
13
14
|
import { DeleteActivityCommandInput, DeleteActivityCommandOutput } from "./commands/DeleteActivityCommand";
|
|
15
|
+
import { DeleteStateMachineAliasCommandInput, DeleteStateMachineAliasCommandOutput } from "./commands/DeleteStateMachineAliasCommand";
|
|
14
16
|
import { DeleteStateMachineCommandInput, DeleteStateMachineCommandOutput } from "./commands/DeleteStateMachineCommand";
|
|
17
|
+
import { DeleteStateMachineVersionCommandInput, DeleteStateMachineVersionCommandOutput } from "./commands/DeleteStateMachineVersionCommand";
|
|
15
18
|
import { DescribeActivityCommandInput, DescribeActivityCommandOutput } from "./commands/DescribeActivityCommand";
|
|
16
19
|
import { DescribeExecutionCommandInput, DescribeExecutionCommandOutput } from "./commands/DescribeExecutionCommand";
|
|
17
20
|
import { DescribeMapRunCommandInput, DescribeMapRunCommandOutput } from "./commands/DescribeMapRunCommand";
|
|
21
|
+
import { DescribeStateMachineAliasCommandInput, DescribeStateMachineAliasCommandOutput } from "./commands/DescribeStateMachineAliasCommand";
|
|
18
22
|
import { DescribeStateMachineCommandInput, DescribeStateMachineCommandOutput } from "./commands/DescribeStateMachineCommand";
|
|
19
23
|
import { DescribeStateMachineForExecutionCommandInput, DescribeStateMachineForExecutionCommandOutput } from "./commands/DescribeStateMachineForExecutionCommand";
|
|
20
24
|
import { GetActivityTaskCommandInput, GetActivityTaskCommandOutput } from "./commands/GetActivityTaskCommand";
|
|
@@ -22,8 +26,11 @@ import { GetExecutionHistoryCommandInput, GetExecutionHistoryCommandOutput } fro
|
|
|
22
26
|
import { ListActivitiesCommandInput, ListActivitiesCommandOutput } from "./commands/ListActivitiesCommand";
|
|
23
27
|
import { ListExecutionsCommandInput, ListExecutionsCommandOutput } from "./commands/ListExecutionsCommand";
|
|
24
28
|
import { ListMapRunsCommandInput, ListMapRunsCommandOutput } from "./commands/ListMapRunsCommand";
|
|
29
|
+
import { ListStateMachineAliasesCommandInput, ListStateMachineAliasesCommandOutput } from "./commands/ListStateMachineAliasesCommand";
|
|
25
30
|
import { ListStateMachinesCommandInput, ListStateMachinesCommandOutput } from "./commands/ListStateMachinesCommand";
|
|
31
|
+
import { ListStateMachineVersionsCommandInput, ListStateMachineVersionsCommandOutput } from "./commands/ListStateMachineVersionsCommand";
|
|
26
32
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
33
|
+
import { PublishStateMachineVersionCommandInput, PublishStateMachineVersionCommandOutput } from "./commands/PublishStateMachineVersionCommand";
|
|
27
34
|
import { SendTaskFailureCommandInput, SendTaskFailureCommandOutput } from "./commands/SendTaskFailureCommand";
|
|
28
35
|
import { SendTaskHeartbeatCommandInput, SendTaskHeartbeatCommandOutput } from "./commands/SendTaskHeartbeatCommand";
|
|
29
36
|
import { SendTaskSuccessCommandInput, SendTaskSuccessCommandOutput } from "./commands/SendTaskSuccessCommand";
|
|
@@ -33,17 +40,18 @@ import { StopExecutionCommandInput, StopExecutionCommandOutput } from "./command
|
|
|
33
40
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
34
41
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
35
42
|
import { UpdateMapRunCommandInput, UpdateMapRunCommandOutput } from "./commands/UpdateMapRunCommand";
|
|
43
|
+
import { UpdateStateMachineAliasCommandInput, UpdateStateMachineAliasCommandOutput } from "./commands/UpdateStateMachineAliasCommand";
|
|
36
44
|
import { UpdateStateMachineCommandInput, UpdateStateMachineCommandOutput } from "./commands/UpdateStateMachineCommand";
|
|
37
45
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
38
46
|
export { __Client };
|
|
39
47
|
/**
|
|
40
48
|
* @public
|
|
41
49
|
*/
|
|
42
|
-
export type ServiceInputTypes = CreateActivityCommandInput | CreateStateMachineCommandInput | DeleteActivityCommandInput | DeleteStateMachineCommandInput | DescribeActivityCommandInput | DescribeExecutionCommandInput | DescribeMapRunCommandInput | DescribeStateMachineCommandInput | DescribeStateMachineForExecutionCommandInput | GetActivityTaskCommandInput | GetExecutionHistoryCommandInput | ListActivitiesCommandInput | ListExecutionsCommandInput | ListMapRunsCommandInput | ListStateMachinesCommandInput | ListTagsForResourceCommandInput | SendTaskFailureCommandInput | SendTaskHeartbeatCommandInput | SendTaskSuccessCommandInput | StartExecutionCommandInput | StartSyncExecutionCommandInput | StopExecutionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateMapRunCommandInput | UpdateStateMachineCommandInput;
|
|
50
|
+
export type ServiceInputTypes = CreateActivityCommandInput | CreateStateMachineAliasCommandInput | CreateStateMachineCommandInput | DeleteActivityCommandInput | DeleteStateMachineAliasCommandInput | DeleteStateMachineCommandInput | DeleteStateMachineVersionCommandInput | DescribeActivityCommandInput | DescribeExecutionCommandInput | DescribeMapRunCommandInput | DescribeStateMachineAliasCommandInput | DescribeStateMachineCommandInput | DescribeStateMachineForExecutionCommandInput | GetActivityTaskCommandInput | GetExecutionHistoryCommandInput | ListActivitiesCommandInput | ListExecutionsCommandInput | ListMapRunsCommandInput | ListStateMachineAliasesCommandInput | ListStateMachineVersionsCommandInput | ListStateMachinesCommandInput | ListTagsForResourceCommandInput | PublishStateMachineVersionCommandInput | SendTaskFailureCommandInput | SendTaskHeartbeatCommandInput | SendTaskSuccessCommandInput | StartExecutionCommandInput | StartSyncExecutionCommandInput | StopExecutionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateMapRunCommandInput | UpdateStateMachineAliasCommandInput | UpdateStateMachineCommandInput;
|
|
43
51
|
/**
|
|
44
52
|
* @public
|
|
45
53
|
*/
|
|
46
|
-
export type ServiceOutputTypes = CreateActivityCommandOutput | CreateStateMachineCommandOutput | DeleteActivityCommandOutput | DeleteStateMachineCommandOutput | DescribeActivityCommandOutput | DescribeExecutionCommandOutput | DescribeMapRunCommandOutput | DescribeStateMachineCommandOutput | DescribeStateMachineForExecutionCommandOutput | GetActivityTaskCommandOutput | GetExecutionHistoryCommandOutput | ListActivitiesCommandOutput | ListExecutionsCommandOutput | ListMapRunsCommandOutput | ListStateMachinesCommandOutput | ListTagsForResourceCommandOutput | SendTaskFailureCommandOutput | SendTaskHeartbeatCommandOutput | SendTaskSuccessCommandOutput | StartExecutionCommandOutput | StartSyncExecutionCommandOutput | StopExecutionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateMapRunCommandOutput | UpdateStateMachineCommandOutput;
|
|
54
|
+
export type ServiceOutputTypes = CreateActivityCommandOutput | CreateStateMachineAliasCommandOutput | CreateStateMachineCommandOutput | DeleteActivityCommandOutput | DeleteStateMachineAliasCommandOutput | DeleteStateMachineCommandOutput | DeleteStateMachineVersionCommandOutput | DescribeActivityCommandOutput | DescribeExecutionCommandOutput | DescribeMapRunCommandOutput | DescribeStateMachineAliasCommandOutput | DescribeStateMachineCommandOutput | DescribeStateMachineForExecutionCommandOutput | GetActivityTaskCommandOutput | GetExecutionHistoryCommandOutput | ListActivitiesCommandOutput | ListExecutionsCommandOutput | ListMapRunsCommandOutput | ListStateMachineAliasesCommandOutput | ListStateMachineVersionsCommandOutput | ListStateMachinesCommandOutput | ListTagsForResourceCommandOutput | PublishStateMachineVersionCommandOutput | SendTaskFailureCommandOutput | SendTaskHeartbeatCommandOutput | SendTaskSuccessCommandOutput | StartExecutionCommandOutput | StartSyncExecutionCommandOutput | StopExecutionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateMapRunCommandOutput | UpdateStateMachineAliasCommandOutput | UpdateStateMachineCommandOutput;
|
|
47
55
|
/**
|
|
48
56
|
* @public
|
|
49
57
|
*/
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { CreateStateMachineAliasInput, CreateStateMachineAliasOutput } from "../models/models_0";
|
|
5
|
+
import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateStateMachineAliasCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateStateMachineAliasCommandInput extends CreateStateMachineAliasInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateStateMachineAliasCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateStateMachineAliasCommandOutput extends CreateStateMachineAliasOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Creates an <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> for a state machine that points to one or two <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">versions</a> of the same state machine. You can set your application to call <a>StartExecution</a> with an alias and update the version the alias uses without changing the client's code.</p>
|
|
27
|
+
* <p>You can also map an alias to split <a>StartExecution</a> requests between two
|
|
28
|
+
* versions of a state machine. To do this, add a second <code>RoutingConfig</code> object in the
|
|
29
|
+
* <code>routingConfiguration</code> parameter. You must also specify the percentage of
|
|
30
|
+
* execution run requests each version should receive in both <code>RoutingConfig</code> objects.
|
|
31
|
+
* Step Functions randomly chooses which version runs a given execution based on the
|
|
32
|
+
* percentage you specify.</p>
|
|
33
|
+
* <p>To create an alias that points to a single version, specify a single
|
|
34
|
+
* <code>RoutingConfig</code> object with a <code>weight</code> set to 100.</p>
|
|
35
|
+
* <p>You can create up to 100 aliases for each state machine. You must delete unused aliases using the <a>DeleteStateMachineAlias</a> API action.</p>
|
|
36
|
+
* <p>
|
|
37
|
+
* <code>CreateStateMachineAlias</code> is an idempotent API. Step Functions bases the
|
|
38
|
+
* idempotency check on the <code>stateMachineArn</code>, <code>description</code>,
|
|
39
|
+
* <code>name</code>, and <code>routingConfiguration</code> parameters. Requests that contain
|
|
40
|
+
* the same values for these parameters return a successful idempotent response without creating
|
|
41
|
+
* a duplicate resource.</p>
|
|
42
|
+
* <p>
|
|
43
|
+
* <b>Related operations:</b>
|
|
44
|
+
* </p>
|
|
45
|
+
* <ul>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>
|
|
48
|
+
* <a>DescribeStateMachineAlias</a>
|
|
49
|
+
* </p>
|
|
50
|
+
* </li>
|
|
51
|
+
* <li>
|
|
52
|
+
* <p>
|
|
53
|
+
* <a>ListStateMachineAliases</a>
|
|
54
|
+
* </p>
|
|
55
|
+
* </li>
|
|
56
|
+
* <li>
|
|
57
|
+
* <p>
|
|
58
|
+
* <a>UpdateStateMachineAlias</a>
|
|
59
|
+
* </p>
|
|
60
|
+
* </li>
|
|
61
|
+
* <li>
|
|
62
|
+
* <p>
|
|
63
|
+
* <a>DeleteStateMachineAlias</a>
|
|
64
|
+
* </p>
|
|
65
|
+
* </li>
|
|
66
|
+
* </ul>
|
|
67
|
+
* @example
|
|
68
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
69
|
+
* ```javascript
|
|
70
|
+
* import { SFNClient, CreateStateMachineAliasCommand } from "@aws-sdk/client-sfn"; // ES Modules import
|
|
71
|
+
* // const { SFNClient, CreateStateMachineAliasCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
|
|
72
|
+
* const client = new SFNClient(config);
|
|
73
|
+
* const input = { // CreateStateMachineAliasInput
|
|
74
|
+
* description: "STRING_VALUE",
|
|
75
|
+
* name: "STRING_VALUE", // required
|
|
76
|
+
* routingConfiguration: [ // RoutingConfigurationList // required
|
|
77
|
+
* { // RoutingConfigurationListItem
|
|
78
|
+
* stateMachineVersionArn: "STRING_VALUE", // required
|
|
79
|
+
* weight: Number("int"), // required
|
|
80
|
+
* },
|
|
81
|
+
* ],
|
|
82
|
+
* };
|
|
83
|
+
* const command = new CreateStateMachineAliasCommand(input);
|
|
84
|
+
* const response = await client.send(command);
|
|
85
|
+
* // { // CreateStateMachineAliasOutput
|
|
86
|
+
* // stateMachineAliasArn: "STRING_VALUE", // required
|
|
87
|
+
* // creationDate: new Date("TIMESTAMP"), // required
|
|
88
|
+
* // };
|
|
89
|
+
*
|
|
90
|
+
* ```
|
|
91
|
+
*
|
|
92
|
+
* @param CreateStateMachineAliasCommandInput - {@link CreateStateMachineAliasCommandInput}
|
|
93
|
+
* @returns {@link CreateStateMachineAliasCommandOutput}
|
|
94
|
+
* @see {@link CreateStateMachineAliasCommandInput} for command's `input` shape.
|
|
95
|
+
* @see {@link CreateStateMachineAliasCommandOutput} for command's `response` shape.
|
|
96
|
+
* @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link ConflictException} (client fault)
|
|
99
|
+
* <p>Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for <a>DeleteStateMachineVersion</a>, <a>PublishStateMachineVersion</a>, or <a>UpdateStateMachine</a> with the <code>publish</code> parameter set to <code>true</code>.</p>
|
|
100
|
+
* <p>HTTP Status Code: 409</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link InvalidArn} (client fault)
|
|
103
|
+
* <p>The provided Amazon Resource Name (ARN) is not valid.</p>
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link InvalidName} (client fault)
|
|
106
|
+
* <p>The provided name is not valid.</p>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link ResourceNotFound} (client fault)
|
|
109
|
+
* <p>Could not find the referenced resource.</p>
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
112
|
+
* <p>The request would cause a service quota to be exceeded.</p>
|
|
113
|
+
* <p>HTTP Status Code: 402</p>
|
|
114
|
+
*
|
|
115
|
+
* @throws {@link StateMachineDeleting} (client fault)
|
|
116
|
+
* <p>The specified state machine is being deleted.</p>
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link ValidationException} (client fault)
|
|
119
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
120
|
+
*
|
|
121
|
+
* @throws {@link SFNServiceException}
|
|
122
|
+
* <p>Base exception class for all service exceptions from SFN service.</p>
|
|
123
|
+
*
|
|
124
|
+
*/
|
|
125
|
+
export declare class CreateStateMachineAliasCommand extends $Command<CreateStateMachineAliasCommandInput, CreateStateMachineAliasCommandOutput, SFNClientResolvedConfig> {
|
|
126
|
+
readonly input: CreateStateMachineAliasCommandInput;
|
|
127
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
128
|
+
/**
|
|
129
|
+
* @public
|
|
130
|
+
*/
|
|
131
|
+
constructor(input: CreateStateMachineAliasCommandInput);
|
|
132
|
+
/**
|
|
133
|
+
* @internal
|
|
134
|
+
*/
|
|
135
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateStateMachineAliasCommandInput, CreateStateMachineAliasCommandOutput>;
|
|
136
|
+
/**
|
|
137
|
+
* @internal
|
|
138
|
+
*/
|
|
139
|
+
private serialize;
|
|
140
|
+
/**
|
|
141
|
+
* @internal
|
|
142
|
+
*/
|
|
143
|
+
private deserialize;
|
|
144
|
+
}
|
|
@@ -29,6 +29,8 @@ export interface CreateStateMachineCommandOutput extends CreateStateMachineOutpu
|
|
|
29
29
|
* and so on. State machines are specified using a JSON-based, structured language. For more
|
|
30
30
|
* information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States
|
|
31
31
|
* Language</a> in the Step Functions User Guide.</p>
|
|
32
|
+
* <p>If you set the <code>publish</code> parameter of this API action to <code>true</code>, it
|
|
33
|
+
* publishes version <code>1</code> as the first revision of the state machine.</p>
|
|
32
34
|
* <note>
|
|
33
35
|
* <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
|
|
34
36
|
* </note>
|
|
@@ -37,8 +39,8 @@ export interface CreateStateMachineCommandOutput extends CreateStateMachineOutpu
|
|
|
37
39
|
* <code>CreateStateMachine</code> is an idempotent API. Subsequent requests won’t create a
|
|
38
40
|
* duplicate resource if it was already created. <code>CreateStateMachine</code>'s idempotency
|
|
39
41
|
* check is based on the state machine <code>name</code>, <code>definition</code>,
|
|
40
|
-
* <code>type</code>, <code>LoggingConfiguration</code
|
|
41
|
-
* <code>TracingConfiguration</code>. If a following request has a different
|
|
42
|
+
* <code>type</code>, <code>LoggingConfiguration</code>, and
|
|
43
|
+
* <code>TracingConfiguration</code>. The check is also based on the <code>publish</code> and <code>versionDescription</code> parameters. If a following request has a different
|
|
42
44
|
* <code>roleArn</code> or <code>tags</code>, Step Functions will ignore these differences and treat
|
|
43
45
|
* it as an idempotent request of the previous. In this case, <code>roleArn</code> and
|
|
44
46
|
* <code>tags</code> will not be updated, even if they are different.</p>
|
|
@@ -74,12 +76,15 @@ export interface CreateStateMachineCommandOutput extends CreateStateMachineOutpu
|
|
|
74
76
|
* tracingConfiguration: { // TracingConfiguration
|
|
75
77
|
* enabled: true || false,
|
|
76
78
|
* },
|
|
79
|
+
* publish: true || false,
|
|
80
|
+
* versionDescription: "STRING_VALUE",
|
|
77
81
|
* };
|
|
78
82
|
* const command = new CreateStateMachineCommand(input);
|
|
79
83
|
* const response = await client.send(command);
|
|
80
84
|
* // { // CreateStateMachineOutput
|
|
81
85
|
* // stateMachineArn: "STRING_VALUE", // required
|
|
82
86
|
* // creationDate: new Date("TIMESTAMP"), // required
|
|
87
|
+
* // stateMachineVersionArn: "STRING_VALUE",
|
|
83
88
|
* // };
|
|
84
89
|
*
|
|
85
90
|
* ```
|
|
@@ -90,6 +95,10 @@ export interface CreateStateMachineCommandOutput extends CreateStateMachineOutpu
|
|
|
90
95
|
* @see {@link CreateStateMachineCommandOutput} for command's `response` shape.
|
|
91
96
|
* @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
|
|
92
97
|
*
|
|
98
|
+
* @throws {@link ConflictException} (client fault)
|
|
99
|
+
* <p>Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for <a>DeleteStateMachineVersion</a>, <a>PublishStateMachineVersion</a>, or <a>UpdateStateMachine</a> with the <code>publish</code> parameter set to <code>true</code>.</p>
|
|
100
|
+
* <p>HTTP Status Code: 409</p>
|
|
101
|
+
*
|
|
93
102
|
* @throws {@link InvalidArn} (client fault)
|
|
94
103
|
* <p>The provided Amazon Resource Name (ARN) is not valid.</p>
|
|
95
104
|
*
|
|
@@ -124,6 +133,9 @@ export interface CreateStateMachineCommandOutput extends CreateStateMachineOutpu
|
|
|
124
133
|
* <p>You've exceeded the number of tags allowed for a resource. See the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html"> Limits Topic</a> in the
|
|
125
134
|
* Step Functions Developer Guide.</p>
|
|
126
135
|
*
|
|
136
|
+
* @throws {@link ValidationException} (client fault)
|
|
137
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
138
|
+
*
|
|
127
139
|
* @throws {@link SFNServiceException}
|
|
128
140
|
* <p>Base exception class for all service exceptions from SFN service.</p>
|
|
129
141
|
*
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { DeleteStateMachineAliasInput, DeleteStateMachineAliasOutput } from "../models/models_0";
|
|
5
|
+
import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteStateMachineAliasCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteStateMachineAliasCommandInput extends DeleteStateMachineAliasInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteStateMachineAliasCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteStateMachineAliasCommandOutput extends DeleteStateMachineAliasOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Deletes a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a>.</p>
|
|
27
|
+
* <p>After you delete a state machine alias, you can't use it to start executions. When you
|
|
28
|
+
* delete a state machine alias, Step Functions doesn't delete the state machine versions
|
|
29
|
+
* that alias references.</p>
|
|
30
|
+
* <p>
|
|
31
|
+
* <b>Related operations:</b>
|
|
32
|
+
* </p>
|
|
33
|
+
* <ul>
|
|
34
|
+
* <li>
|
|
35
|
+
* <p>
|
|
36
|
+
* <a>CreateStateMachineAlias</a>
|
|
37
|
+
* </p>
|
|
38
|
+
* </li>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>
|
|
41
|
+
* <a>DescribeStateMachineAlias</a>
|
|
42
|
+
* </p>
|
|
43
|
+
* </li>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>
|
|
46
|
+
* <a>ListStateMachineAliases</a>
|
|
47
|
+
* </p>
|
|
48
|
+
* </li>
|
|
49
|
+
* <li>
|
|
50
|
+
* <p>
|
|
51
|
+
* <a>UpdateStateMachineAlias</a>
|
|
52
|
+
* </p>
|
|
53
|
+
* </li>
|
|
54
|
+
* </ul>
|
|
55
|
+
* @example
|
|
56
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
57
|
+
* ```javascript
|
|
58
|
+
* import { SFNClient, DeleteStateMachineAliasCommand } from "@aws-sdk/client-sfn"; // ES Modules import
|
|
59
|
+
* // const { SFNClient, DeleteStateMachineAliasCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
|
|
60
|
+
* const client = new SFNClient(config);
|
|
61
|
+
* const input = { // DeleteStateMachineAliasInput
|
|
62
|
+
* stateMachineAliasArn: "STRING_VALUE", // required
|
|
63
|
+
* };
|
|
64
|
+
* const command = new DeleteStateMachineAliasCommand(input);
|
|
65
|
+
* const response = await client.send(command);
|
|
66
|
+
* // {};
|
|
67
|
+
*
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
70
|
+
* @param DeleteStateMachineAliasCommandInput - {@link DeleteStateMachineAliasCommandInput}
|
|
71
|
+
* @returns {@link DeleteStateMachineAliasCommandOutput}
|
|
72
|
+
* @see {@link DeleteStateMachineAliasCommandInput} for command's `input` shape.
|
|
73
|
+
* @see {@link DeleteStateMachineAliasCommandOutput} for command's `response` shape.
|
|
74
|
+
* @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ConflictException} (client fault)
|
|
77
|
+
* <p>Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for <a>DeleteStateMachineVersion</a>, <a>PublishStateMachineVersion</a>, or <a>UpdateStateMachine</a> with the <code>publish</code> parameter set to <code>true</code>.</p>
|
|
78
|
+
* <p>HTTP Status Code: 409</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link InvalidArn} (client fault)
|
|
81
|
+
* <p>The provided Amazon Resource Name (ARN) is not valid.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ResourceNotFound} (client fault)
|
|
84
|
+
* <p>Could not find the referenced resource.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ValidationException} (client fault)
|
|
87
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link SFNServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from SFN service.</p>
|
|
91
|
+
*
|
|
92
|
+
*/
|
|
93
|
+
export declare class DeleteStateMachineAliasCommand extends $Command<DeleteStateMachineAliasCommandInput, DeleteStateMachineAliasCommandOutput, SFNClientResolvedConfig> {
|
|
94
|
+
readonly input: DeleteStateMachineAliasCommandInput;
|
|
95
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
96
|
+
/**
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
constructor(input: DeleteStateMachineAliasCommandInput);
|
|
100
|
+
/**
|
|
101
|
+
* @internal
|
|
102
|
+
*/
|
|
103
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteStateMachineAliasCommandInput, DeleteStateMachineAliasCommandOutput>;
|
|
104
|
+
/**
|
|
105
|
+
* @internal
|
|
106
|
+
*/
|
|
107
|
+
private serialize;
|
|
108
|
+
/**
|
|
109
|
+
* @internal
|
|
110
|
+
*/
|
|
111
|
+
private deserialize;
|
|
112
|
+
}
|
|
@@ -25,13 +25,28 @@ export interface DeleteStateMachineCommandOutput extends DeleteStateMachineOutpu
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Deletes a state machine. This is an asynchronous operation: It sets the state machine's
|
|
27
27
|
* status to <code>DELETING</code> and begins the deletion process. </p>
|
|
28
|
-
*
|
|
29
|
-
* <p>
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
28
|
+
* <p>A qualified state machine ARN can either refer to a <i>Distributed Map state</i> defined within a state machine, a version ARN, or an alias ARN.</p>
|
|
29
|
+
* <p>The following are some examples of qualified and unqualified state machine ARNs:</p>
|
|
30
|
+
* <ul>
|
|
31
|
+
* <li>
|
|
32
|
+
* <p>The following qualified state machine ARN refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in a state machine named <code>myStateMachine</code>.</p>
|
|
33
|
+
* <p>
|
|
34
|
+
* <code>arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel</code>
|
|
35
|
+
* </p>
|
|
36
|
+
* <note>
|
|
37
|
+
* <p>If you provide a qualified state machine ARN that refers to a <i>Distributed Map state</i>, the request fails with <code>ValidationException</code>.</p>
|
|
38
|
+
* </note>
|
|
39
|
+
* </li>
|
|
40
|
+
* <li>
|
|
41
|
+
* <p>The following unqualified state machine ARN refers to a state machine named <code>myStateMachine</code>.</p>
|
|
42
|
+
* <p>
|
|
43
|
+
* <code>arn:partition:states:region:account-id:stateMachine:myStateMachine</code>
|
|
44
|
+
* </p>
|
|
45
|
+
* </li>
|
|
46
|
+
* </ul>
|
|
47
|
+
* <p>This API action also deletes all <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">versions</a> and <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">aliases</a> associated with a state machine.</p>
|
|
33
48
|
* <note>
|
|
34
|
-
* <p>For <code>EXPRESS</code> state machines, the deletion
|
|
49
|
+
* <p>For <code>EXPRESS</code> state machines, the deletion happens eventually (usually in
|
|
35
50
|
* less than a minute). Running executions may emit logs after <code>DeleteStateMachine</code>
|
|
36
51
|
* API is called.</p>
|
|
37
52
|
* </note>
|