@aws-sdk/client-sfn 3.354.0 → 3.358.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 +511 -9
- 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 +494 -8
- package/dist-types/SFN.d.ts +56 -0
- package/dist-types/SFNClient.d.ts +11 -3
- 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 +28 -28
|
@@ -0,0 +1,122 @@
|
|
|
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 { PublishStateMachineVersionInput, PublishStateMachineVersionOutput } 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 PublishStateMachineVersionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface PublishStateMachineVersionCommandInput extends PublishStateMachineVersionInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link PublishStateMachineVersionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface PublishStateMachineVersionCommandOutput extends PublishStateMachineVersionOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Creates a <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a> from the
|
|
27
|
+
* current revision of a state machine. Use versions to create immutable snapshots of your state
|
|
28
|
+
* machine. You can start executions from versions either directly or with an alias. To create an
|
|
29
|
+
* alias, use <a>CreateStateMachineAlias</a>.</p>
|
|
30
|
+
* <p>You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the <a>DeleteStateMachineVersion</a> API action.</p>
|
|
31
|
+
* <p>
|
|
32
|
+
* <code>PublishStateMachineVersion</code> is an idempotent API. It doesn't create a
|
|
33
|
+
* duplicate state machine version if it already exists for the current revision. Step Functions bases <code>PublishStateMachineVersion</code>'s idempotency check on the
|
|
34
|
+
* <code>stateMachineArn</code>, <code>name</code>, and <code>revisionId</code> parameters.
|
|
35
|
+
* Requests with the same parameters return a successful idempotent response. If you don't
|
|
36
|
+
* specify a <code>revisionId</code>, Step Functions checks for a previously published
|
|
37
|
+
* version of the state machine's current revision.</p>
|
|
38
|
+
* <p>
|
|
39
|
+
* <b>Related operations:</b>
|
|
40
|
+
* </p>
|
|
41
|
+
* <ul>
|
|
42
|
+
* <li>
|
|
43
|
+
* <p>
|
|
44
|
+
* <a>DeleteStateMachineVersion</a>
|
|
45
|
+
* </p>
|
|
46
|
+
* </li>
|
|
47
|
+
* <li>
|
|
48
|
+
* <p>
|
|
49
|
+
* <a>ListStateMachineVersions</a>
|
|
50
|
+
* </p>
|
|
51
|
+
* </li>
|
|
52
|
+
* </ul>
|
|
53
|
+
* @example
|
|
54
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
55
|
+
* ```javascript
|
|
56
|
+
* import { SFNClient, PublishStateMachineVersionCommand } from "@aws-sdk/client-sfn"; // ES Modules import
|
|
57
|
+
* // const { SFNClient, PublishStateMachineVersionCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
|
|
58
|
+
* const client = new SFNClient(config);
|
|
59
|
+
* const input = { // PublishStateMachineVersionInput
|
|
60
|
+
* stateMachineArn: "STRING_VALUE", // required
|
|
61
|
+
* revisionId: "STRING_VALUE",
|
|
62
|
+
* description: "STRING_VALUE",
|
|
63
|
+
* };
|
|
64
|
+
* const command = new PublishStateMachineVersionCommand(input);
|
|
65
|
+
* const response = await client.send(command);
|
|
66
|
+
* // { // PublishStateMachineVersionOutput
|
|
67
|
+
* // creationDate: new Date("TIMESTAMP"), // required
|
|
68
|
+
* // stateMachineVersionArn: "STRING_VALUE", // required
|
|
69
|
+
* // };
|
|
70
|
+
*
|
|
71
|
+
* ```
|
|
72
|
+
*
|
|
73
|
+
* @param PublishStateMachineVersionCommandInput - {@link PublishStateMachineVersionCommandInput}
|
|
74
|
+
* @returns {@link PublishStateMachineVersionCommandOutput}
|
|
75
|
+
* @see {@link PublishStateMachineVersionCommandInput} for command's `input` shape.
|
|
76
|
+
* @see {@link PublishStateMachineVersionCommandOutput} for command's `response` shape.
|
|
77
|
+
* @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ConflictException} (client fault)
|
|
80
|
+
* <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>
|
|
81
|
+
* <p>HTTP Status Code: 409</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InvalidArn} (client fault)
|
|
84
|
+
* <p>The provided Amazon Resource Name (ARN) is not valid.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
87
|
+
* <p>The request would cause a service quota to be exceeded.</p>
|
|
88
|
+
* <p>HTTP Status Code: 402</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link StateMachineDeleting} (client fault)
|
|
91
|
+
* <p>The specified state machine is being deleted.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link StateMachineDoesNotExist} (client fault)
|
|
94
|
+
* <p>The specified state machine does not exist.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link ValidationException} (client fault)
|
|
97
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link SFNServiceException}
|
|
100
|
+
* <p>Base exception class for all service exceptions from SFN service.</p>
|
|
101
|
+
*
|
|
102
|
+
*/
|
|
103
|
+
export declare class PublishStateMachineVersionCommand extends $Command<PublishStateMachineVersionCommandInput, PublishStateMachineVersionCommandOutput, SFNClientResolvedConfig> {
|
|
104
|
+
readonly input: PublishStateMachineVersionCommandInput;
|
|
105
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
106
|
+
/**
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
constructor(input: PublishStateMachineVersionCommandInput);
|
|
110
|
+
/**
|
|
111
|
+
* @internal
|
|
112
|
+
*/
|
|
113
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PublishStateMachineVersionCommandInput, PublishStateMachineVersionCommandOutput>;
|
|
114
|
+
/**
|
|
115
|
+
* @internal
|
|
116
|
+
*/
|
|
117
|
+
private serialize;
|
|
118
|
+
/**
|
|
119
|
+
* @internal
|
|
120
|
+
*/
|
|
121
|
+
private deserialize;
|
|
122
|
+
}
|
|
@@ -23,19 +23,47 @@ export interface StartExecutionCommandOutput extends StartExecutionOutput, __Met
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Starts a state machine execution
|
|
27
|
-
*
|
|
28
|
-
* <p>
|
|
29
|
-
*
|
|
26
|
+
* <p>Starts a state machine execution.</p>
|
|
27
|
+
* <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>
|
|
28
|
+
* <p>The following are some examples of qualified and unqualified state machine ARNs:</p>
|
|
29
|
+
* <ul>
|
|
30
|
+
* <li>
|
|
31
|
+
* <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>
|
|
32
|
+
* <p>
|
|
33
|
+
* <code>arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel</code>
|
|
34
|
+
* </p>
|
|
35
|
+
* <note>
|
|
36
|
+
* <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>
|
|
37
|
+
* </note>
|
|
38
|
+
* </li>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>The following qualified state machine ARN refers to an alias named <code>PROD</code>.</p>
|
|
41
|
+
* <p>
|
|
42
|
+
* <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD></code>
|
|
43
|
+
* </p>
|
|
44
|
+
* <note>
|
|
45
|
+
* <p>If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.</p>
|
|
46
|
+
* </note>
|
|
47
|
+
* </li>
|
|
48
|
+
* <li>
|
|
49
|
+
* <p>The following unqualified state machine ARN refers to a state machine named <code>myStateMachine</code>.</p>
|
|
50
|
+
* <p>
|
|
51
|
+
* <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine></code>
|
|
52
|
+
* </p>
|
|
53
|
+
* </li>
|
|
54
|
+
* </ul>
|
|
55
|
+
* <p>If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution.</p>
|
|
56
|
+
* <p>To start executions of a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>, call
|
|
57
|
+
* <code>StartExecution</code> and provide the version ARN or the ARN of an <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> that points to the version.</p>
|
|
30
58
|
* <note>
|
|
31
59
|
* <p>
|
|
32
60
|
* <code>StartExecution</code> is idempotent for <code>STANDARD</code> workflows. For a
|
|
33
|
-
* <code>STANDARD</code> workflow, if <code>StartExecution</code>
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
61
|
+
* <code>STANDARD</code> workflow, if you call <code>StartExecution</code> with the same name
|
|
62
|
+
* and input as a running execution, the call succeeds and return the same response as the
|
|
63
|
+
* original request. If the execution is closed or if the input is different, it returns a
|
|
64
|
+
* <code>400 ExecutionAlreadyExists</code> error. You can reuse names after 90 days. </p>
|
|
37
65
|
* <p>
|
|
38
|
-
* <code>StartExecution</code>
|
|
66
|
+
* <code>StartExecution</code> isn't idempotent for <code>EXPRESS</code> workflows. </p>
|
|
39
67
|
* </note>
|
|
40
68
|
* @example
|
|
41
69
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -60,8 +60,7 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
|
|
|
60
60
|
* <p>The provided Amazon Resource Name (ARN) is not valid.</p>
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link ResourceNotFound} (client fault)
|
|
63
|
-
* <p>Could not find the referenced resource
|
|
64
|
-
* supported.</p>
|
|
63
|
+
* <p>Could not find the referenced resource.</p>
|
|
65
64
|
*
|
|
66
65
|
* @throws {@link TooManyTags} (client fault)
|
|
67
66
|
* <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
|
|
@@ -52,8 +52,7 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
|
|
|
52
52
|
* <p>The provided Amazon Resource Name (ARN) is not valid.</p>
|
|
53
53
|
*
|
|
54
54
|
* @throws {@link ResourceNotFound} (client fault)
|
|
55
|
-
* <p>Could not find the referenced resource
|
|
56
|
-
* supported.</p>
|
|
55
|
+
* <p>Could not find the referenced resource.</p>
|
|
57
56
|
*
|
|
58
57
|
* @throws {@link SFNServiceException}
|
|
59
58
|
* <p>Base exception class for all service exceptions from SFN service.</p>
|
|
@@ -52,8 +52,7 @@ export interface UpdateMapRunCommandOutput extends UpdateMapRunOutput, __Metadat
|
|
|
52
52
|
* <p>The provided Amazon Resource Name (ARN) is not valid.</p>
|
|
53
53
|
*
|
|
54
54
|
* @throws {@link ResourceNotFound} (client fault)
|
|
55
|
-
* <p>Could not find the referenced resource
|
|
56
|
-
* supported.</p>
|
|
55
|
+
* <p>Could not find the referenced resource.</p>
|
|
57
56
|
*
|
|
58
57
|
* @throws {@link ValidationException} (client fault)
|
|
59
58
|
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
@@ -0,0 +1,132 @@
|
|
|
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 { UpdateStateMachineAliasInput, UpdateStateMachineAliasOutput } 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 UpdateStateMachineAliasCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateStateMachineAliasCommandInput extends UpdateStateMachineAliasInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateStateMachineAliasCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateStateMachineAliasCommandOutput extends UpdateStateMachineAliasOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Updates the configuration of an existing state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> by modifying its <code>description</code> or <code>routingConfiguration</code>.</p>
|
|
27
|
+
* <p>You must specify at least one of the <code>description</code> or <code>routingConfiguration</code> parameters to update a state machine alias.</p>
|
|
28
|
+
* <note>
|
|
29
|
+
* <p>
|
|
30
|
+
* <code>UpdateStateMachineAlias</code> is an idempotent API. Step Functions bases the
|
|
31
|
+
* idempotency check on the <code>stateMachineAliasArn</code>, <code>description</code>, and
|
|
32
|
+
* <code>routingConfiguration</code> parameters. Requests with the same parameters return an
|
|
33
|
+
* idempotent response.</p>
|
|
34
|
+
* </note>
|
|
35
|
+
* <note>
|
|
36
|
+
* <p>This operation is eventually consistent. All <a>StartExecution</a> requests
|
|
37
|
+
* made within a few seconds use the latest alias configuration. Executions started immediately
|
|
38
|
+
* after calling <code>UpdateStateMachineAlias</code> may use the previous routing
|
|
39
|
+
* configuration.</p>
|
|
40
|
+
* </note>
|
|
41
|
+
* <p>
|
|
42
|
+
* <b>Related operations:</b>
|
|
43
|
+
* </p>
|
|
44
|
+
* <ul>
|
|
45
|
+
* <li>
|
|
46
|
+
* <p>
|
|
47
|
+
* <a>CreateStateMachineAlias</a>
|
|
48
|
+
* </p>
|
|
49
|
+
* </li>
|
|
50
|
+
* <li>
|
|
51
|
+
* <p>
|
|
52
|
+
* <a>DescribeStateMachineAlias</a>
|
|
53
|
+
* </p>
|
|
54
|
+
* </li>
|
|
55
|
+
* <li>
|
|
56
|
+
* <p>
|
|
57
|
+
* <a>ListStateMachineAliases</a>
|
|
58
|
+
* </p>
|
|
59
|
+
* </li>
|
|
60
|
+
* <li>
|
|
61
|
+
* <p>
|
|
62
|
+
* <a>DeleteStateMachineAlias</a>
|
|
63
|
+
* </p>
|
|
64
|
+
* </li>
|
|
65
|
+
* </ul>
|
|
66
|
+
* @example
|
|
67
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
68
|
+
* ```javascript
|
|
69
|
+
* import { SFNClient, UpdateStateMachineAliasCommand } from "@aws-sdk/client-sfn"; // ES Modules import
|
|
70
|
+
* // const { SFNClient, UpdateStateMachineAliasCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
|
|
71
|
+
* const client = new SFNClient(config);
|
|
72
|
+
* const input = { // UpdateStateMachineAliasInput
|
|
73
|
+
* stateMachineAliasArn: "STRING_VALUE", // required
|
|
74
|
+
* description: "STRING_VALUE",
|
|
75
|
+
* routingConfiguration: [ // RoutingConfigurationList
|
|
76
|
+
* { // RoutingConfigurationListItem
|
|
77
|
+
* stateMachineVersionArn: "STRING_VALUE", // required
|
|
78
|
+
* weight: Number("int"), // required
|
|
79
|
+
* },
|
|
80
|
+
* ],
|
|
81
|
+
* };
|
|
82
|
+
* const command = new UpdateStateMachineAliasCommand(input);
|
|
83
|
+
* const response = await client.send(command);
|
|
84
|
+
* // { // UpdateStateMachineAliasOutput
|
|
85
|
+
* // updateDate: new Date("TIMESTAMP"), // required
|
|
86
|
+
* // };
|
|
87
|
+
*
|
|
88
|
+
* ```
|
|
89
|
+
*
|
|
90
|
+
* @param UpdateStateMachineAliasCommandInput - {@link UpdateStateMachineAliasCommandInput}
|
|
91
|
+
* @returns {@link UpdateStateMachineAliasCommandOutput}
|
|
92
|
+
* @see {@link UpdateStateMachineAliasCommandInput} for command's `input` shape.
|
|
93
|
+
* @see {@link UpdateStateMachineAliasCommandOutput} for command's `response` shape.
|
|
94
|
+
* @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link ConflictException} (client fault)
|
|
97
|
+
* <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>
|
|
98
|
+
* <p>HTTP Status Code: 409</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link InvalidArn} (client fault)
|
|
101
|
+
* <p>The provided Amazon Resource Name (ARN) is not valid.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link ResourceNotFound} (client fault)
|
|
104
|
+
* <p>Could not find the referenced resource.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link ValidationException} (client fault)
|
|
107
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link SFNServiceException}
|
|
110
|
+
* <p>Base exception class for all service exceptions from SFN service.</p>
|
|
111
|
+
*
|
|
112
|
+
*/
|
|
113
|
+
export declare class UpdateStateMachineAliasCommand extends $Command<UpdateStateMachineAliasCommandInput, UpdateStateMachineAliasCommandOutput, SFNClientResolvedConfig> {
|
|
114
|
+
readonly input: UpdateStateMachineAliasCommandInput;
|
|
115
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
116
|
+
/**
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
constructor(input: UpdateStateMachineAliasCommandInput);
|
|
120
|
+
/**
|
|
121
|
+
* @internal
|
|
122
|
+
*/
|
|
123
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateStateMachineAliasCommandInput, UpdateStateMachineAliasCommandOutput>;
|
|
124
|
+
/**
|
|
125
|
+
* @internal
|
|
126
|
+
*/
|
|
127
|
+
private serialize;
|
|
128
|
+
/**
|
|
129
|
+
* @internal
|
|
130
|
+
*/
|
|
131
|
+
private deserialize;
|
|
132
|
+
}
|
|
@@ -28,15 +28,45 @@ export interface UpdateStateMachineCommandOutput extends UpdateStateMachineOutpu
|
|
|
28
28
|
* to use the previous <code>definition</code> and <code>roleArn</code>. You must include at
|
|
29
29
|
* least one of <code>definition</code> or <code>roleArn</code> or you will receive a
|
|
30
30
|
* <code>MissingRequiredParameter</code> error.</p>
|
|
31
|
-
*
|
|
32
|
-
* <p>If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.</p>
|
|
33
|
-
*
|
|
34
31
|
* <p>A qualified state machine ARN refers to a <i>Distributed Map state</i> defined within a state machine. For example, the qualified state machine ARN <code>arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel</code> refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in the state machine named <code>stateMachineName</code>.</p>
|
|
35
|
-
*
|
|
32
|
+
* <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>
|
|
33
|
+
* <p>The following are some examples of qualified and unqualified state machine ARNs:</p>
|
|
34
|
+
* <ul>
|
|
35
|
+
* <li>
|
|
36
|
+
* <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>
|
|
37
|
+
* <p>
|
|
38
|
+
* <code>arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel</code>
|
|
39
|
+
* </p>
|
|
40
|
+
* <note>
|
|
41
|
+
* <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>
|
|
42
|
+
* </note>
|
|
43
|
+
* </li>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>The following qualified state machine ARN refers to an alias named <code>PROD</code>.</p>
|
|
46
|
+
* <p>
|
|
47
|
+
* <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD></code>
|
|
48
|
+
* </p>
|
|
49
|
+
* <note>
|
|
50
|
+
* <p>If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.</p>
|
|
51
|
+
* </note>
|
|
52
|
+
* </li>
|
|
53
|
+
* <li>
|
|
54
|
+
* <p>The following unqualified state machine ARN refers to a state machine named <code>myStateMachine</code>.</p>
|
|
55
|
+
* <p>
|
|
56
|
+
* <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine></code>
|
|
57
|
+
* </p>
|
|
58
|
+
* </li>
|
|
59
|
+
* </ul>
|
|
60
|
+
* <p>After you update your state machine, you can set the <code>publish</code> parameter to
|
|
61
|
+
* <code>true</code> in the same action to publish a new <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>. This
|
|
62
|
+
* way, you can opt-in to strict versioning of your state machine.</p>
|
|
36
63
|
* <note>
|
|
37
|
-
* <p>
|
|
38
|
-
*
|
|
39
|
-
*
|
|
64
|
+
* <p>Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.</p>
|
|
65
|
+
* </note>
|
|
66
|
+
* <note>
|
|
67
|
+
* <p>All <code>StartExecution</code> calls within a few seconds use the updated
|
|
68
|
+
* <code>definition</code> and <code>roleArn</code>. Executions started immediately after you
|
|
69
|
+
* call <code>UpdateStateMachine</code> may use the previous state machine
|
|
40
70
|
* <code>definition</code> and <code>roleArn</code>. </p>
|
|
41
71
|
* </note>
|
|
42
72
|
* @example
|
|
@@ -63,11 +93,15 @@ export interface UpdateStateMachineCommandOutput extends UpdateStateMachineOutpu
|
|
|
63
93
|
* tracingConfiguration: { // TracingConfiguration
|
|
64
94
|
* enabled: true || false,
|
|
65
95
|
* },
|
|
96
|
+
* publish: true || false,
|
|
97
|
+
* versionDescription: "STRING_VALUE",
|
|
66
98
|
* };
|
|
67
99
|
* const command = new UpdateStateMachineCommand(input);
|
|
68
100
|
* const response = await client.send(command);
|
|
69
101
|
* // { // UpdateStateMachineOutput
|
|
70
102
|
* // updateDate: new Date("TIMESTAMP"), // required
|
|
103
|
+
* // revisionId: "STRING_VALUE",
|
|
104
|
+
* // stateMachineVersionArn: "STRING_VALUE",
|
|
71
105
|
* // };
|
|
72
106
|
*
|
|
73
107
|
* ```
|
|
@@ -78,6 +112,10 @@ export interface UpdateStateMachineCommandOutput extends UpdateStateMachineOutpu
|
|
|
78
112
|
* @see {@link UpdateStateMachineCommandOutput} for command's `response` shape.
|
|
79
113
|
* @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
|
|
80
114
|
*
|
|
115
|
+
* @throws {@link ConflictException} (client fault)
|
|
116
|
+
* <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>
|
|
117
|
+
* <p>HTTP Status Code: 409</p>
|
|
118
|
+
*
|
|
81
119
|
* @throws {@link InvalidArn} (client fault)
|
|
82
120
|
* <p>The provided Amazon Resource Name (ARN) is not valid.</p>
|
|
83
121
|
*
|
|
@@ -95,6 +133,10 @@ export interface UpdateStateMachineCommandOutput extends UpdateStateMachineOutpu
|
|
|
95
133
|
* <p>Request is missing a required parameter. This error occurs if both <code>definition</code>
|
|
96
134
|
* and <code>roleArn</code> are not specified.</p>
|
|
97
135
|
*
|
|
136
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
137
|
+
* <p>The request would cause a service quota to be exceeded.</p>
|
|
138
|
+
* <p>HTTP Status Code: 402</p>
|
|
139
|
+
*
|
|
98
140
|
* @throws {@link StateMachineDeleting} (client fault)
|
|
99
141
|
* <p>The specified state machine is being deleted.</p>
|
|
100
142
|
*
|
|
@@ -1,10 +1,14 @@
|
|
|
1
1
|
export * from "./CreateActivityCommand";
|
|
2
|
+
export * from "./CreateStateMachineAliasCommand";
|
|
2
3
|
export * from "./CreateStateMachineCommand";
|
|
3
4
|
export * from "./DeleteActivityCommand";
|
|
5
|
+
export * from "./DeleteStateMachineAliasCommand";
|
|
4
6
|
export * from "./DeleteStateMachineCommand";
|
|
7
|
+
export * from "./DeleteStateMachineVersionCommand";
|
|
5
8
|
export * from "./DescribeActivityCommand";
|
|
6
9
|
export * from "./DescribeExecutionCommand";
|
|
7
10
|
export * from "./DescribeMapRunCommand";
|
|
11
|
+
export * from "./DescribeStateMachineAliasCommand";
|
|
8
12
|
export * from "./DescribeStateMachineCommand";
|
|
9
13
|
export * from "./DescribeStateMachineForExecutionCommand";
|
|
10
14
|
export * from "./GetActivityTaskCommand";
|
|
@@ -12,8 +16,11 @@ export * from "./GetExecutionHistoryCommand";
|
|
|
12
16
|
export * from "./ListActivitiesCommand";
|
|
13
17
|
export * from "./ListExecutionsCommand";
|
|
14
18
|
export * from "./ListMapRunsCommand";
|
|
19
|
+
export * from "./ListStateMachineAliasesCommand";
|
|
20
|
+
export * from "./ListStateMachineVersionsCommand";
|
|
15
21
|
export * from "./ListStateMachinesCommand";
|
|
16
22
|
export * from "./ListTagsForResourceCommand";
|
|
23
|
+
export * from "./PublishStateMachineVersionCommand";
|
|
17
24
|
export * from "./SendTaskFailureCommand";
|
|
18
25
|
export * from "./SendTaskHeartbeatCommand";
|
|
19
26
|
export * from "./SendTaskSuccessCommand";
|
|
@@ -23,4 +30,5 @@ export * from "./StopExecutionCommand";
|
|
|
23
30
|
export * from "./TagResourceCommand";
|
|
24
31
|
export * from "./UntagResourceCommand";
|
|
25
32
|
export * from "./UpdateMapRunCommand";
|
|
33
|
+
export * from "./UpdateStateMachineAliasCommand";
|
|
26
34
|
export * from "./UpdateStateMachineCommand";
|
|
@@ -13,7 +13,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
|
|
|
13
13
|
defaultSigningName: string;
|
|
14
14
|
};
|
|
15
15
|
export interface EndpointParameters extends __EndpointParameters {
|
|
16
|
-
Region
|
|
16
|
+
Region?: string;
|
|
17
17
|
UseDualStack?: boolean;
|
|
18
18
|
UseFIPS?: boolean;
|
|
19
19
|
Endpoint?: string;
|