@aws-sdk/client-sfn 3.357.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 +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
|
@@ -0,0 +1,106 @@
|
|
|
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 { DeleteStateMachineVersionInput, DeleteStateMachineVersionOutput } 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 DeleteStateMachineVersionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteStateMachineVersionCommandInput extends DeleteStateMachineVersionInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteStateMachineVersionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteStateMachineVersionCommandOutput extends DeleteStateMachineVersionOutput, __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-version.html">version</a>. After
|
|
27
|
+
* you delete a version, you can't call <a>StartExecution</a> using that version's ARN
|
|
28
|
+
* or use
|
|
29
|
+
* the
|
|
30
|
+
* version with a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a>.</p>
|
|
31
|
+
* <note>
|
|
32
|
+
* <p>Deleting a state machine version won't terminate its in-progress executions.</p>
|
|
33
|
+
* </note>
|
|
34
|
+
* <note>
|
|
35
|
+
* <p>You can't delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version.</p>
|
|
36
|
+
* </note>
|
|
37
|
+
* <p>
|
|
38
|
+
* <b>Related operations:</b>
|
|
39
|
+
* </p>
|
|
40
|
+
* <ul>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>
|
|
43
|
+
* <a>PublishStateMachineVersion</a>
|
|
44
|
+
* </p>
|
|
45
|
+
* </li>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>
|
|
48
|
+
* <a>ListStateMachineVersions</a>
|
|
49
|
+
* </p>
|
|
50
|
+
* </li>
|
|
51
|
+
* </ul>
|
|
52
|
+
* @example
|
|
53
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
54
|
+
* ```javascript
|
|
55
|
+
* import { SFNClient, DeleteStateMachineVersionCommand } from "@aws-sdk/client-sfn"; // ES Modules import
|
|
56
|
+
* // const { SFNClient, DeleteStateMachineVersionCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
|
|
57
|
+
* const client = new SFNClient(config);
|
|
58
|
+
* const input = { // DeleteStateMachineVersionInput
|
|
59
|
+
* stateMachineVersionArn: "STRING_VALUE", // required
|
|
60
|
+
* };
|
|
61
|
+
* const command = new DeleteStateMachineVersionCommand(input);
|
|
62
|
+
* const response = await client.send(command);
|
|
63
|
+
* // {};
|
|
64
|
+
*
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
67
|
+
* @param DeleteStateMachineVersionCommandInput - {@link DeleteStateMachineVersionCommandInput}
|
|
68
|
+
* @returns {@link DeleteStateMachineVersionCommandOutput}
|
|
69
|
+
* @see {@link DeleteStateMachineVersionCommandInput} for command's `input` shape.
|
|
70
|
+
* @see {@link DeleteStateMachineVersionCommandOutput} for command's `response` shape.
|
|
71
|
+
* @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ConflictException} (client fault)
|
|
74
|
+
* <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>
|
|
75
|
+
* <p>HTTP Status Code: 409</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link InvalidArn} (client fault)
|
|
78
|
+
* <p>The provided Amazon Resource Name (ARN) is not valid.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ValidationException} (client fault)
|
|
81
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link SFNServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from SFN service.</p>
|
|
85
|
+
*
|
|
86
|
+
*/
|
|
87
|
+
export declare class DeleteStateMachineVersionCommand extends $Command<DeleteStateMachineVersionCommandInput, DeleteStateMachineVersionCommandOutput, SFNClientResolvedConfig> {
|
|
88
|
+
readonly input: DeleteStateMachineVersionCommandInput;
|
|
89
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
90
|
+
/**
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
constructor(input: DeleteStateMachineVersionCommandInput);
|
|
94
|
+
/**
|
|
95
|
+
* @internal
|
|
96
|
+
*/
|
|
97
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteStateMachineVersionCommandInput, DeleteStateMachineVersionCommandOutput>;
|
|
98
|
+
/**
|
|
99
|
+
* @internal
|
|
100
|
+
*/
|
|
101
|
+
private serialize;
|
|
102
|
+
/**
|
|
103
|
+
* @internal
|
|
104
|
+
*/
|
|
105
|
+
private deserialize;
|
|
106
|
+
}
|
|
@@ -23,11 +23,16 @@ export interface DescribeExecutionCommandOutput extends DescribeExecutionOutput,
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Provides
|
|
26
|
+
* <p>Provides information about a state machine execution, such as the state machine
|
|
27
|
+
* associated with the execution, the execution input and output, and relevant execution
|
|
28
|
+
* metadata. Use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was
|
|
29
|
+
* dispatched by a Map Run.</p>
|
|
30
|
+
* <p>If you specify a version or alias ARN when you call the <a>StartExecution</a>
|
|
31
|
+
* API action, <code>DescribeExecution</code> returns that ARN.</p>
|
|
27
32
|
* <note>
|
|
28
33
|
* <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
|
|
29
34
|
* </note>
|
|
30
|
-
* <p>
|
|
35
|
+
* <p>Executions of an <code>EXPRESS</code> state machinearen't supported by <code>DescribeExecution</code> unless a Map Run dispatched them.</p>
|
|
31
36
|
* @example
|
|
32
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
38
|
* ```javascript
|
|
@@ -58,6 +63,8 @@ export interface DescribeExecutionCommandOutput extends DescribeExecutionOutput,
|
|
|
58
63
|
* // mapRunArn: "STRING_VALUE",
|
|
59
64
|
* // error: "STRING_VALUE",
|
|
60
65
|
* // cause: "STRING_VALUE",
|
|
66
|
+
* // stateMachineVersionArn: "STRING_VALUE",
|
|
67
|
+
* // stateMachineAliasArn: "STRING_VALUE",
|
|
61
68
|
* // };
|
|
62
69
|
*
|
|
63
70
|
* ```
|
|
@@ -78,8 +78,7 @@ export interface DescribeMapRunCommandOutput extends DescribeMapRunOutput, __Met
|
|
|
78
78
|
* <p>The provided Amazon Resource Name (ARN) is not valid.</p>
|
|
79
79
|
*
|
|
80
80
|
* @throws {@link ResourceNotFound} (client fault)
|
|
81
|
-
* <p>Could not find the referenced resource
|
|
82
|
-
* supported.</p>
|
|
81
|
+
* <p>Could not find the referenced resource.</p>
|
|
83
82
|
*
|
|
84
83
|
* @throws {@link SFNServiceException}
|
|
85
84
|
* <p>Base exception class for all service exceptions from SFN service.</p>
|
|
@@ -0,0 +1,117 @@
|
|
|
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 { DescribeStateMachineAliasInput, DescribeStateMachineAliasOutput } 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 DescribeStateMachineAliasCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeStateMachineAliasCommandInput extends DescribeStateMachineAliasInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeStateMachineAliasCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeStateMachineAliasCommandOutput extends DescribeStateMachineAliasOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Returns details about a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a>.</p>
|
|
27
|
+
* <p>
|
|
28
|
+
* <b>Related operations:</b>
|
|
29
|
+
* </p>
|
|
30
|
+
* <ul>
|
|
31
|
+
* <li>
|
|
32
|
+
* <p>
|
|
33
|
+
* <a>CreateStateMachineAlias</a>
|
|
34
|
+
* </p>
|
|
35
|
+
* </li>
|
|
36
|
+
* <li>
|
|
37
|
+
* <p>
|
|
38
|
+
* <a>ListStateMachineAliases</a>
|
|
39
|
+
* </p>
|
|
40
|
+
* </li>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>
|
|
43
|
+
* <a>UpdateStateMachineAlias</a>
|
|
44
|
+
* </p>
|
|
45
|
+
* </li>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>
|
|
48
|
+
* <a>DeleteStateMachineAlias</a>
|
|
49
|
+
* </p>
|
|
50
|
+
* </li>
|
|
51
|
+
* </ul>
|
|
52
|
+
* @example
|
|
53
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
54
|
+
* ```javascript
|
|
55
|
+
* import { SFNClient, DescribeStateMachineAliasCommand } from "@aws-sdk/client-sfn"; // ES Modules import
|
|
56
|
+
* // const { SFNClient, DescribeStateMachineAliasCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
|
|
57
|
+
* const client = new SFNClient(config);
|
|
58
|
+
* const input = { // DescribeStateMachineAliasInput
|
|
59
|
+
* stateMachineAliasArn: "STRING_VALUE", // required
|
|
60
|
+
* };
|
|
61
|
+
* const command = new DescribeStateMachineAliasCommand(input);
|
|
62
|
+
* const response = await client.send(command);
|
|
63
|
+
* // { // DescribeStateMachineAliasOutput
|
|
64
|
+
* // stateMachineAliasArn: "STRING_VALUE",
|
|
65
|
+
* // name: "STRING_VALUE",
|
|
66
|
+
* // description: "STRING_VALUE",
|
|
67
|
+
* // routingConfiguration: [ // RoutingConfigurationList
|
|
68
|
+
* // { // RoutingConfigurationListItem
|
|
69
|
+
* // stateMachineVersionArn: "STRING_VALUE", // required
|
|
70
|
+
* // weight: Number("int"), // required
|
|
71
|
+
* // },
|
|
72
|
+
* // ],
|
|
73
|
+
* // creationDate: new Date("TIMESTAMP"),
|
|
74
|
+
* // updateDate: new Date("TIMESTAMP"),
|
|
75
|
+
* // };
|
|
76
|
+
*
|
|
77
|
+
* ```
|
|
78
|
+
*
|
|
79
|
+
* @param DescribeStateMachineAliasCommandInput - {@link DescribeStateMachineAliasCommandInput}
|
|
80
|
+
* @returns {@link DescribeStateMachineAliasCommandOutput}
|
|
81
|
+
* @see {@link DescribeStateMachineAliasCommandInput} for command's `input` shape.
|
|
82
|
+
* @see {@link DescribeStateMachineAliasCommandOutput} for command's `response` shape.
|
|
83
|
+
* @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link InvalidArn} (client fault)
|
|
86
|
+
* <p>The provided Amazon Resource Name (ARN) is not valid.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ResourceNotFound} (client fault)
|
|
89
|
+
* <p>Could not find the referenced resource.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ValidationException} (client fault)
|
|
92
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link SFNServiceException}
|
|
95
|
+
* <p>Base exception class for all service exceptions from SFN service.</p>
|
|
96
|
+
*
|
|
97
|
+
*/
|
|
98
|
+
export declare class DescribeStateMachineAliasCommand extends $Command<DescribeStateMachineAliasCommandInput, DescribeStateMachineAliasCommandOutput, SFNClientResolvedConfig> {
|
|
99
|
+
readonly input: DescribeStateMachineAliasCommandInput;
|
|
100
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
101
|
+
/**
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
constructor(input: DescribeStateMachineAliasCommandInput);
|
|
105
|
+
/**
|
|
106
|
+
* @internal
|
|
107
|
+
*/
|
|
108
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeStateMachineAliasCommandInput, DescribeStateMachineAliasCommandOutput>;
|
|
109
|
+
/**
|
|
110
|
+
* @internal
|
|
111
|
+
*/
|
|
112
|
+
private serialize;
|
|
113
|
+
/**
|
|
114
|
+
* @internal
|
|
115
|
+
*/
|
|
116
|
+
private deserialize;
|
|
117
|
+
}
|
|
@@ -23,10 +23,37 @@ export interface DescribeStateMachineCommandOutput extends DescribeStateMachineO
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration
|
|
27
|
-
*
|
|
28
|
-
* <p>
|
|
29
|
-
*
|
|
26
|
+
* <p>Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.</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>This API action returns the details for a state machine version if the
|
|
56
|
+
* <code>stateMachineArn</code> you specify is a state machine version ARN.</p>
|
|
30
57
|
* <note>
|
|
31
58
|
* <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
|
|
32
59
|
* </note>
|
|
@@ -64,6 +91,8 @@ export interface DescribeStateMachineCommandOutput extends DescribeStateMachineO
|
|
|
64
91
|
* // enabled: true || false,
|
|
65
92
|
* // },
|
|
66
93
|
* // label: "STRING_VALUE",
|
|
94
|
+
* // revisionId: "STRING_VALUE",
|
|
95
|
+
* // description: "STRING_VALUE",
|
|
67
96
|
* // };
|
|
68
97
|
*
|
|
69
98
|
* ```
|
|
@@ -23,7 +23,12 @@ export interface DescribeStateMachineForExecutionCommandOutput extends DescribeS
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Provides information about a state machine's definition, its execution role ARN, and
|
|
26
|
+
* <p>Provides information about a state machine's definition, its execution role ARN, and
|
|
27
|
+
* configuration. If a Map Run dispatched the execution, this action returns the Map Run
|
|
28
|
+
* Amazon Resource Name (ARN) in the response.
|
|
29
|
+
* The
|
|
30
|
+
* state machine returned is the state machine associated with the
|
|
31
|
+
* Map Run.</p>
|
|
27
32
|
* <note>
|
|
28
33
|
* <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
|
|
29
34
|
* </note>
|
|
@@ -61,6 +66,7 @@ export interface DescribeStateMachineForExecutionCommandOutput extends DescribeS
|
|
|
61
66
|
* // },
|
|
62
67
|
* // mapRunArn: "STRING_VALUE",
|
|
63
68
|
* // label: "STRING_VALUE",
|
|
69
|
+
* // revisionId: "STRING_VALUE",
|
|
64
70
|
* // };
|
|
65
71
|
*
|
|
66
72
|
* ```
|
|
@@ -29,11 +29,9 @@ export interface GetActivityTaskCommandOutput extends GetActivityTaskOutput, __M
|
|
|
29
29
|
* an execution of a task of this type is needed.) The maximum time the service holds on to the
|
|
30
30
|
* request before responding is 60 seconds. If no task is available within 60 seconds, the poll
|
|
31
31
|
* returns a <code>taskToken</code> with a null string.</p>
|
|
32
|
-
*
|
|
33
32
|
* <note>
|
|
34
33
|
* <p>This API action isn't logged in CloudTrail.</p>
|
|
35
34
|
* </note>
|
|
36
|
-
*
|
|
37
35
|
* <important>
|
|
38
36
|
* <p>Workers should set their client side socket timeout to at least 65 seconds (5 seconds
|
|
39
37
|
* higher than the maximum time the service may hold the poll request).</p>
|
|
@@ -146,6 +146,8 @@ export interface GetExecutionHistoryCommandOutput extends GetExecutionHistoryOut
|
|
|
146
146
|
* // truncated: true || false,
|
|
147
147
|
* // },
|
|
148
148
|
* // roleArn: "STRING_VALUE",
|
|
149
|
+
* // stateMachineAliasArn: "STRING_VALUE",
|
|
150
|
+
* // stateMachineVersionArn: "STRING_VALUE",
|
|
149
151
|
* // },
|
|
150
152
|
* // executionSucceededEventDetails: { // ExecutionSucceededEventDetails
|
|
151
153
|
* // output: "STRING_VALUE",
|
|
@@ -24,6 +24,7 @@ export interface ListExecutionsCommandOutput extends ListExecutionsOutput, __Met
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.</p>
|
|
27
|
+
* <p>You can also provide a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> ARN or <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a> ARN to list the executions associated with a specific alias or version.</p>
|
|
27
28
|
* <p>Results are
|
|
28
29
|
* sorted by time, with the most recent execution first.</p>
|
|
29
30
|
* <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
@@ -58,6 +59,8 @@ export interface ListExecutionsCommandOutput extends ListExecutionsOutput, __Met
|
|
|
58
59
|
* // stopDate: new Date("TIMESTAMP"),
|
|
59
60
|
* // mapRunArn: "STRING_VALUE",
|
|
60
61
|
* // itemCount: Number("int"),
|
|
62
|
+
* // stateMachineVersionArn: "STRING_VALUE",
|
|
63
|
+
* // stateMachineAliasArn: "STRING_VALUE",
|
|
61
64
|
* // },
|
|
62
65
|
* // ],
|
|
63
66
|
* // nextToken: "STRING_VALUE",
|
|
@@ -78,8 +81,7 @@ export interface ListExecutionsCommandOutput extends ListExecutionsOutput, __Met
|
|
|
78
81
|
* <p>The provided token is not valid.</p>
|
|
79
82
|
*
|
|
80
83
|
* @throws {@link ResourceNotFound} (client fault)
|
|
81
|
-
* <p>Could not find the referenced resource
|
|
82
|
-
* supported.</p>
|
|
84
|
+
* <p>Could not find the referenced resource.</p>
|
|
83
85
|
*
|
|
84
86
|
* @throws {@link StateMachineDoesNotExist} (client fault)
|
|
85
87
|
* <p>The specified state machine does not exist.</p>
|
|
@@ -0,0 +1,124 @@
|
|
|
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 { ListStateMachineAliasesInput, ListStateMachineAliasesOutput } 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 ListStateMachineAliasesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListStateMachineAliasesCommandInput extends ListStateMachineAliasesInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListStateMachineAliasesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListStateMachineAliasesCommandOutput extends ListStateMachineAliasesOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Lists <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">aliases</a> for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first. </p>
|
|
27
|
+
* <p>To list aliases that reference a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>, you can specify the version ARN in the <code>stateMachineArn</code> parameter.</p>
|
|
28
|
+
* <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
29
|
+
* Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</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>UpdateStateMachineAlias</a>
|
|
47
|
+
* </p>
|
|
48
|
+
* </li>
|
|
49
|
+
* <li>
|
|
50
|
+
* <p>
|
|
51
|
+
* <a>DeleteStateMachineAlias</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, ListStateMachineAliasesCommand } from "@aws-sdk/client-sfn"; // ES Modules import
|
|
59
|
+
* // const { SFNClient, ListStateMachineAliasesCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
|
|
60
|
+
* const client = new SFNClient(config);
|
|
61
|
+
* const input = { // ListStateMachineAliasesInput
|
|
62
|
+
* stateMachineArn: "STRING_VALUE", // required
|
|
63
|
+
* nextToken: "STRING_VALUE",
|
|
64
|
+
* maxResults: Number("int"),
|
|
65
|
+
* };
|
|
66
|
+
* const command = new ListStateMachineAliasesCommand(input);
|
|
67
|
+
* const response = await client.send(command);
|
|
68
|
+
* // { // ListStateMachineAliasesOutput
|
|
69
|
+
* // stateMachineAliases: [ // StateMachineAliasList // required
|
|
70
|
+
* // { // StateMachineAliasListItem
|
|
71
|
+
* // stateMachineAliasArn: "STRING_VALUE", // required
|
|
72
|
+
* // creationDate: new Date("TIMESTAMP"), // required
|
|
73
|
+
* // },
|
|
74
|
+
* // ],
|
|
75
|
+
* // nextToken: "STRING_VALUE",
|
|
76
|
+
* // };
|
|
77
|
+
*
|
|
78
|
+
* ```
|
|
79
|
+
*
|
|
80
|
+
* @param ListStateMachineAliasesCommandInput - {@link ListStateMachineAliasesCommandInput}
|
|
81
|
+
* @returns {@link ListStateMachineAliasesCommandOutput}
|
|
82
|
+
* @see {@link ListStateMachineAliasesCommandInput} for command's `input` shape.
|
|
83
|
+
* @see {@link ListStateMachineAliasesCommandOutput} for command's `response` shape.
|
|
84
|
+
* @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link InvalidArn} (client fault)
|
|
87
|
+
* <p>The provided Amazon Resource Name (ARN) is not valid.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link InvalidToken} (client fault)
|
|
90
|
+
* <p>The provided token is not valid.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ResourceNotFound} (client fault)
|
|
93
|
+
* <p>Could not find the referenced resource.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link StateMachineDeleting} (client fault)
|
|
96
|
+
* <p>The specified state machine is being deleted.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link StateMachineDoesNotExist} (client fault)
|
|
99
|
+
* <p>The specified state machine does not exist.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link SFNServiceException}
|
|
102
|
+
* <p>Base exception class for all service exceptions from SFN service.</p>
|
|
103
|
+
*
|
|
104
|
+
*/
|
|
105
|
+
export declare class ListStateMachineAliasesCommand extends $Command<ListStateMachineAliasesCommandInput, ListStateMachineAliasesCommandOutput, SFNClientResolvedConfig> {
|
|
106
|
+
readonly input: ListStateMachineAliasesCommandInput;
|
|
107
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
108
|
+
/**
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
constructor(input: ListStateMachineAliasesCommandInput);
|
|
112
|
+
/**
|
|
113
|
+
* @internal
|
|
114
|
+
*/
|
|
115
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListStateMachineAliasesCommandInput, ListStateMachineAliasesCommandOutput>;
|
|
116
|
+
/**
|
|
117
|
+
* @internal
|
|
118
|
+
*/
|
|
119
|
+
private serialize;
|
|
120
|
+
/**
|
|
121
|
+
* @internal
|
|
122
|
+
*/
|
|
123
|
+
private deserialize;
|
|
124
|
+
}
|
|
@@ -0,0 +1,108 @@
|
|
|
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 { ListStateMachineVersionsInput, ListStateMachineVersionsOutput } 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 ListStateMachineVersionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListStateMachineVersionsCommandInput extends ListStateMachineVersionsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListStateMachineVersionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListStateMachineVersionsCommandOutput extends ListStateMachineVersionsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Lists <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">versions</a> for the specified state machine Amazon Resource Name (ARN).</p>
|
|
27
|
+
* <p>The results are sorted in descending order of the version creation time.</p>
|
|
28
|
+
* <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page.
|
|
29
|
+
* Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</p>
|
|
30
|
+
* <p>
|
|
31
|
+
* <b>Related operations:</b>
|
|
32
|
+
* </p>
|
|
33
|
+
* <ul>
|
|
34
|
+
* <li>
|
|
35
|
+
* <p>
|
|
36
|
+
* <a>PublishStateMachineVersion</a>
|
|
37
|
+
* </p>
|
|
38
|
+
* </li>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>
|
|
41
|
+
* <a>DeleteStateMachineVersion</a>
|
|
42
|
+
* </p>
|
|
43
|
+
* </li>
|
|
44
|
+
* </ul>
|
|
45
|
+
* @example
|
|
46
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
47
|
+
* ```javascript
|
|
48
|
+
* import { SFNClient, ListStateMachineVersionsCommand } from "@aws-sdk/client-sfn"; // ES Modules import
|
|
49
|
+
* // const { SFNClient, ListStateMachineVersionsCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
|
|
50
|
+
* const client = new SFNClient(config);
|
|
51
|
+
* const input = { // ListStateMachineVersionsInput
|
|
52
|
+
* stateMachineArn: "STRING_VALUE", // required
|
|
53
|
+
* nextToken: "STRING_VALUE",
|
|
54
|
+
* maxResults: Number("int"),
|
|
55
|
+
* };
|
|
56
|
+
* const command = new ListStateMachineVersionsCommand(input);
|
|
57
|
+
* const response = await client.send(command);
|
|
58
|
+
* // { // ListStateMachineVersionsOutput
|
|
59
|
+
* // stateMachineVersions: [ // StateMachineVersionList // required
|
|
60
|
+
* // { // StateMachineVersionListItem
|
|
61
|
+
* // stateMachineVersionArn: "STRING_VALUE", // required
|
|
62
|
+
* // creationDate: new Date("TIMESTAMP"), // required
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // nextToken: "STRING_VALUE",
|
|
66
|
+
* // };
|
|
67
|
+
*
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
70
|
+
* @param ListStateMachineVersionsCommandInput - {@link ListStateMachineVersionsCommandInput}
|
|
71
|
+
* @returns {@link ListStateMachineVersionsCommandOutput}
|
|
72
|
+
* @see {@link ListStateMachineVersionsCommandInput} for command's `input` shape.
|
|
73
|
+
* @see {@link ListStateMachineVersionsCommandOutput} for command's `response` shape.
|
|
74
|
+
* @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link InvalidArn} (client fault)
|
|
77
|
+
* <p>The provided Amazon Resource Name (ARN) is not valid.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link InvalidToken} (client fault)
|
|
80
|
+
* <p>The provided token is not valid.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ValidationException} (client fault)
|
|
83
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link SFNServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from SFN service.</p>
|
|
87
|
+
*
|
|
88
|
+
*/
|
|
89
|
+
export declare class ListStateMachineVersionsCommand extends $Command<ListStateMachineVersionsCommandInput, ListStateMachineVersionsCommandOutput, SFNClientResolvedConfig> {
|
|
90
|
+
readonly input: ListStateMachineVersionsCommandInput;
|
|
91
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
92
|
+
/**
|
|
93
|
+
* @public
|
|
94
|
+
*/
|
|
95
|
+
constructor(input: ListStateMachineVersionsCommandInput);
|
|
96
|
+
/**
|
|
97
|
+
* @internal
|
|
98
|
+
*/
|
|
99
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListStateMachineVersionsCommandInput, ListStateMachineVersionsCommandOutput>;
|
|
100
|
+
/**
|
|
101
|
+
* @internal
|
|
102
|
+
*/
|
|
103
|
+
private serialize;
|
|
104
|
+
/**
|
|
105
|
+
* @internal
|
|
106
|
+
*/
|
|
107
|
+
private deserialize;
|
|
108
|
+
}
|
|
@@ -57,8 +57,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
|
|
|
57
57
|
* <p>The provided Amazon Resource Name (ARN) is not valid.</p>
|
|
58
58
|
*
|
|
59
59
|
* @throws {@link ResourceNotFound} (client fault)
|
|
60
|
-
* <p>Could not find the referenced resource
|
|
61
|
-
* supported.</p>
|
|
60
|
+
* <p>Could not find the referenced resource.</p>
|
|
62
61
|
*
|
|
63
62
|
* @throws {@link SFNServiceException}
|
|
64
63
|
* <p>Base exception class for all service exceptions from SFN service.</p>
|