@aws-sdk/client-sfn 3.36.0 → 3.39.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.
Files changed (81) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/dist-cjs/SFN.js +0 -18
  3. package/dist-cjs/SFNClient.js +0 -23
  4. package/dist-cjs/commands/CreateActivityCommand.js +0 -40
  5. package/dist-cjs/commands/CreateStateMachineCommand.js +0 -42
  6. package/dist-cjs/commands/DeleteActivityCommand.js +0 -24
  7. package/dist-cjs/commands/DeleteStateMachineCommand.js +0 -30
  8. package/dist-cjs/commands/DescribeActivityCommand.js +0 -27
  9. package/dist-cjs/commands/DescribeExecutionCommand.js +0 -28
  10. package/dist-cjs/commands/DescribeStateMachineCommand.js +0 -27
  11. package/dist-cjs/commands/DescribeStateMachineForExecutionCommand.js +0 -28
  12. package/dist-cjs/commands/GetActivityTaskCommand.js +0 -36
  13. package/dist-cjs/commands/GetExecutionHistoryCommand.js +0 -29
  14. package/dist-cjs/commands/ListActivitiesCommand.js +0 -29
  15. package/dist-cjs/commands/ListExecutionsCommand.js +0 -31
  16. package/dist-cjs/commands/ListStateMachinesCommand.js +0 -29
  17. package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -25
  18. package/dist-cjs/commands/SendTaskFailureCommand.js +0 -25
  19. package/dist-cjs/commands/SendTaskHeartbeatCommand.js +0 -38
  20. package/dist-cjs/commands/SendTaskSuccessCommand.js +0 -26
  21. package/dist-cjs/commands/StartExecutionCommand.js +0 -32
  22. package/dist-cjs/commands/StartSyncExecutionCommand.js +0 -24
  23. package/dist-cjs/commands/StopExecutionCommand.js +0 -25
  24. package/dist-cjs/commands/TagResourceCommand.js +0 -29
  25. package/dist-cjs/commands/UntagResourceCommand.js +0 -24
  26. package/dist-cjs/commands/UpdateStateMachineCommand.js +0 -34
  27. package/dist-cjs/commands/index.js +26 -0
  28. package/dist-cjs/endpoints.js +6 -1
  29. package/dist-cjs/index.js +4 -30
  30. package/dist-cjs/models/models_0.js +0 -333
  31. package/dist-cjs/pagination/GetExecutionHistoryPaginator.js +0 -10
  32. package/dist-cjs/pagination/ListActivitiesPaginator.js +0 -10
  33. package/dist-cjs/pagination/ListExecutionsPaginator.js +0 -10
  34. package/dist-cjs/pagination/ListStateMachinesPaginator.js +0 -10
  35. package/dist-cjs/pagination/index.js +8 -0
  36. package/dist-cjs/protocols/Aws_json1_0.js +0 -5
  37. package/dist-cjs/runtimeConfig.browser.js +1 -5
  38. package/dist-cjs/runtimeConfig.js +1 -5
  39. package/dist-cjs/runtimeConfig.native.js +0 -3
  40. package/dist-cjs/runtimeConfig.shared.js +0 -3
  41. package/dist-es/commands/index.js +23 -0
  42. package/dist-es/endpoints.js +6 -1
  43. package/dist-es/index.js +4 -30
  44. package/dist-es/pagination/index.js +5 -0
  45. package/dist-types/commands/index.d.ts +23 -0
  46. package/dist-types/index.d.ts +4 -30
  47. package/dist-types/pagination/index.d.ts +5 -0
  48. package/dist-types/ts3.4/SFN.d.ts +24 -217
  49. package/dist-types/ts3.4/SFNClient.d.ts +24 -104
  50. package/dist-types/ts3.4/commands/CreateActivityCommand.d.ts +2 -36
  51. package/dist-types/ts3.4/commands/CreateStateMachineCommand.d.ts +2 -38
  52. package/dist-types/ts3.4/commands/DeleteActivityCommand.d.ts +2 -20
  53. package/dist-types/ts3.4/commands/DeleteStateMachineCommand.d.ts +2 -26
  54. package/dist-types/ts3.4/commands/DescribeActivityCommand.d.ts +2 -23
  55. package/dist-types/ts3.4/commands/DescribeExecutionCommand.d.ts +2 -24
  56. package/dist-types/ts3.4/commands/DescribeStateMachineCommand.d.ts +2 -23
  57. package/dist-types/ts3.4/commands/DescribeStateMachineForExecutionCommand.d.ts +2 -24
  58. package/dist-types/ts3.4/commands/GetActivityTaskCommand.d.ts +2 -32
  59. package/dist-types/ts3.4/commands/GetExecutionHistoryCommand.d.ts +2 -25
  60. package/dist-types/ts3.4/commands/ListActivitiesCommand.d.ts +2 -25
  61. package/dist-types/ts3.4/commands/ListExecutionsCommand.d.ts +2 -27
  62. package/dist-types/ts3.4/commands/ListStateMachinesCommand.d.ts +2 -25
  63. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -21
  64. package/dist-types/ts3.4/commands/SendTaskFailureCommand.d.ts +2 -21
  65. package/dist-types/ts3.4/commands/SendTaskHeartbeatCommand.d.ts +2 -34
  66. package/dist-types/ts3.4/commands/SendTaskSuccessCommand.d.ts +2 -22
  67. package/dist-types/ts3.4/commands/StartExecutionCommand.d.ts +2 -28
  68. package/dist-types/ts3.4/commands/StartSyncExecutionCommand.d.ts +2 -20
  69. package/dist-types/ts3.4/commands/StopExecutionCommand.d.ts +2 -21
  70. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -25
  71. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -20
  72. package/dist-types/ts3.4/commands/UpdateStateMachineCommand.d.ts +2 -30
  73. package/dist-types/ts3.4/commands/index.d.ts +23 -0
  74. package/dist-types/ts3.4/index.d.ts +4 -30
  75. package/dist-types/ts3.4/models/models_0.d.ts +434 -1643
  76. package/dist-types/ts3.4/pagination/index.d.ts +5 -0
  77. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  78. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  79. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  80. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  81. package/package.json +32 -32
@@ -6,35 +6,11 @@ export interface DeleteStateMachineCommandInput extends DeleteStateMachineInput
6
6
  }
7
7
  export interface DeleteStateMachineCommandOutput extends DeleteStateMachineOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Deletes a state machine. This is an asynchronous operation: It sets the state machine's
11
- * status to <code>DELETING</code> and begins the deletion process. </p>
12
- * <note>
13
- * <p>For <code>EXPRESS</code>state machines, the deletion will happen eventually (usually
14
- * less than a minute). Running executions may emit logs after <code>DeleteStateMachine</code>
15
- * API is called.</p>
16
- * </note>
17
- * @example
18
- * Use a bare-bones client and the command you need to make an API call.
19
- * ```javascript
20
- * import { SFNClient, DeleteStateMachineCommand } from "@aws-sdk/client-sfn"; // ES Modules import
21
- * // const { SFNClient, DeleteStateMachineCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
22
- * const client = new SFNClient(config);
23
- * const command = new DeleteStateMachineCommand(input);
24
- * const response = await client.send(command);
25
- * ```
26
- *
27
- * @see {@link DeleteStateMachineCommandInput} for command's `input` shape.
28
- * @see {@link DeleteStateMachineCommandOutput} for command's `response` shape.
29
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
30
- *
31
- */
9
+
32
10
  export declare class DeleteStateMachineCommand extends $Command<DeleteStateMachineCommandInput, DeleteStateMachineCommandOutput, SFNClientResolvedConfig> {
33
11
  readonly input: DeleteStateMachineCommandInput;
34
12
  constructor(input: DeleteStateMachineCommandInput);
35
- /**
36
- * @internal
37
- */
13
+
38
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteStateMachineCommandInput, DeleteStateMachineCommandOutput>;
39
15
  private serialize;
40
16
  private deserialize;
@@ -6,32 +6,11 @@ export interface DescribeActivityCommandInput extends DescribeActivityInput {
6
6
  }
7
7
  export interface DescribeActivityCommandOutput extends DescribeActivityOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Describes an activity.</p>
11
- * <note>
12
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
13
- * </note>
14
- * @example
15
- * Use a bare-bones client and the command you need to make an API call.
16
- * ```javascript
17
- * import { SFNClient, DescribeActivityCommand } from "@aws-sdk/client-sfn"; // ES Modules import
18
- * // const { SFNClient, DescribeActivityCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
19
- * const client = new SFNClient(config);
20
- * const command = new DescribeActivityCommand(input);
21
- * const response = await client.send(command);
22
- * ```
23
- *
24
- * @see {@link DescribeActivityCommandInput} for command's `input` shape.
25
- * @see {@link DescribeActivityCommandOutput} for command's `response` shape.
26
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
27
- *
28
- */
9
+
29
10
  export declare class DescribeActivityCommand extends $Command<DescribeActivityCommandInput, DescribeActivityCommandOutput, SFNClientResolvedConfig> {
30
11
  readonly input: DescribeActivityCommandInput;
31
12
  constructor(input: DescribeActivityCommandInput);
32
- /**
33
- * @internal
34
- */
13
+
35
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeActivityCommandInput, DescribeActivityCommandOutput>;
36
15
  private serialize;
37
16
  private deserialize;
@@ -6,33 +6,11 @@ export interface DescribeExecutionCommandInput extends DescribeExecutionInput {
6
6
  }
7
7
  export interface DescribeExecutionCommandOutput extends DescribeExecutionOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Describes an execution.</p>
11
- * <note>
12
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
13
- * </note>
14
- * <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>
15
- * @example
16
- * Use a bare-bones client and the command you need to make an API call.
17
- * ```javascript
18
- * import { SFNClient, DescribeExecutionCommand } from "@aws-sdk/client-sfn"; // ES Modules import
19
- * // const { SFNClient, DescribeExecutionCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
20
- * const client = new SFNClient(config);
21
- * const command = new DescribeExecutionCommand(input);
22
- * const response = await client.send(command);
23
- * ```
24
- *
25
- * @see {@link DescribeExecutionCommandInput} for command's `input` shape.
26
- * @see {@link DescribeExecutionCommandOutput} for command's `response` shape.
27
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
28
- *
29
- */
9
+
30
10
  export declare class DescribeExecutionCommand extends $Command<DescribeExecutionCommandInput, DescribeExecutionCommandOutput, SFNClientResolvedConfig> {
31
11
  readonly input: DescribeExecutionCommandInput;
32
12
  constructor(input: DescribeExecutionCommandInput);
33
- /**
34
- * @internal
35
- */
13
+
36
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeExecutionCommandInput, DescribeExecutionCommandOutput>;
37
15
  private serialize;
38
16
  private deserialize;
@@ -6,32 +6,11 @@ export interface DescribeStateMachineCommandInput extends DescribeStateMachineIn
6
6
  }
7
7
  export interface DescribeStateMachineCommandOutput extends DescribeStateMachineOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Describes a state machine.</p>
11
- * <note>
12
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
13
- * </note>
14
- * @example
15
- * Use a bare-bones client and the command you need to make an API call.
16
- * ```javascript
17
- * import { SFNClient, DescribeStateMachineCommand } from "@aws-sdk/client-sfn"; // ES Modules import
18
- * // const { SFNClient, DescribeStateMachineCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
19
- * const client = new SFNClient(config);
20
- * const command = new DescribeStateMachineCommand(input);
21
- * const response = await client.send(command);
22
- * ```
23
- *
24
- * @see {@link DescribeStateMachineCommandInput} for command's `input` shape.
25
- * @see {@link DescribeStateMachineCommandOutput} for command's `response` shape.
26
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
27
- *
28
- */
9
+
29
10
  export declare class DescribeStateMachineCommand extends $Command<DescribeStateMachineCommandInput, DescribeStateMachineCommandOutput, SFNClientResolvedConfig> {
30
11
  readonly input: DescribeStateMachineCommandInput;
31
12
  constructor(input: DescribeStateMachineCommandInput);
32
- /**
33
- * @internal
34
- */
13
+
35
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeStateMachineCommandInput, DescribeStateMachineCommandOutput>;
36
15
  private serialize;
37
16
  private deserialize;
@@ -6,33 +6,11 @@ export interface DescribeStateMachineForExecutionCommandInput extends DescribeSt
6
6
  }
7
7
  export interface DescribeStateMachineForExecutionCommandOutput extends DescribeStateMachineForExecutionOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Describes the state machine associated with a specific execution.</p>
11
- * <note>
12
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
13
- * </note>
14
- * <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>
15
- * @example
16
- * Use a bare-bones client and the command you need to make an API call.
17
- * ```javascript
18
- * import { SFNClient, DescribeStateMachineForExecutionCommand } from "@aws-sdk/client-sfn"; // ES Modules import
19
- * // const { SFNClient, DescribeStateMachineForExecutionCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
20
- * const client = new SFNClient(config);
21
- * const command = new DescribeStateMachineForExecutionCommand(input);
22
- * const response = await client.send(command);
23
- * ```
24
- *
25
- * @see {@link DescribeStateMachineForExecutionCommandInput} for command's `input` shape.
26
- * @see {@link DescribeStateMachineForExecutionCommandOutput} for command's `response` shape.
27
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
28
- *
29
- */
9
+
30
10
  export declare class DescribeStateMachineForExecutionCommand extends $Command<DescribeStateMachineForExecutionCommandInput, DescribeStateMachineForExecutionCommandOutput, SFNClientResolvedConfig> {
31
11
  readonly input: DescribeStateMachineForExecutionCommandInput;
32
12
  constructor(input: DescribeStateMachineForExecutionCommandInput);
33
- /**
34
- * @internal
35
- */
13
+
36
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeStateMachineForExecutionCommandInput, DescribeStateMachineForExecutionCommandOutput>;
37
15
  private serialize;
38
16
  private deserialize;
@@ -6,41 +6,11 @@ export interface GetActivityTaskCommandInput extends GetActivityTaskInput {
6
6
  }
7
7
  export interface GetActivityTaskCommandOutput extends GetActivityTaskOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Used by workers to retrieve a task (with the specified activity ARN) which has been
11
- * scheduled for execution by a running state machine. This initiates a long poll, where the
12
- * service holds the HTTP connection open and responds as soon as a task becomes available (i.e.
13
- * an execution of a task of this type is needed.) The maximum time the service holds on to the
14
- * request before responding is 60 seconds. If no task is available within 60 seconds, the poll
15
- * returns a <code>taskToken</code> with a null string.</p>
16
- * <important>
17
- * <p>Workers should set their client side socket timeout to at least 65 seconds (5 seconds
18
- * higher than the maximum time the service may hold the poll request).</p>
19
- * <p>Polling with <code>GetActivityTask</code> can cause latency in some implementations. See
20
- * <a href="https://docs.aws.amazon.com/step-functions/latest/dg/bp-activity-pollers.html">Avoid
21
- * Latency When Polling for Activity Tasks</a> in the Step Functions Developer Guide.</p>
22
- * </important>
23
- * @example
24
- * Use a bare-bones client and the command you need to make an API call.
25
- * ```javascript
26
- * import { SFNClient, GetActivityTaskCommand } from "@aws-sdk/client-sfn"; // ES Modules import
27
- * // const { SFNClient, GetActivityTaskCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
28
- * const client = new SFNClient(config);
29
- * const command = new GetActivityTaskCommand(input);
30
- * const response = await client.send(command);
31
- * ```
32
- *
33
- * @see {@link GetActivityTaskCommandInput} for command's `input` shape.
34
- * @see {@link GetActivityTaskCommandOutput} for command's `response` shape.
35
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
36
- *
37
- */
9
+
38
10
  export declare class GetActivityTaskCommand extends $Command<GetActivityTaskCommandInput, GetActivityTaskCommandOutput, SFNClientResolvedConfig> {
39
11
  readonly input: GetActivityTaskCommandInput;
40
12
  constructor(input: GetActivityTaskCommandInput);
41
- /**
42
- * @internal
43
- */
13
+
44
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetActivityTaskCommandInput, GetActivityTaskCommandOutput>;
45
15
  private serialize;
46
16
  private deserialize;
@@ -6,34 +6,11 @@ export interface GetExecutionHistoryCommandInput extends GetExecutionHistoryInpu
6
6
  }
7
7
  export interface GetExecutionHistoryCommandOutput extends GetExecutionHistoryOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Returns the history of the specified execution as a list of events. By default, the
11
- * results are returned in ascending order of the <code>timeStamp</code> of the events. Use the
12
- * <code>reverseOrder</code> parameter to get the latest events first.</p>
13
- * <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.
14
- * 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>
15
- * <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>
16
- * @example
17
- * Use a bare-bones client and the command you need to make an API call.
18
- * ```javascript
19
- * import { SFNClient, GetExecutionHistoryCommand } from "@aws-sdk/client-sfn"; // ES Modules import
20
- * // const { SFNClient, GetExecutionHistoryCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
21
- * const client = new SFNClient(config);
22
- * const command = new GetExecutionHistoryCommand(input);
23
- * const response = await client.send(command);
24
- * ```
25
- *
26
- * @see {@link GetExecutionHistoryCommandInput} for command's `input` shape.
27
- * @see {@link GetExecutionHistoryCommandOutput} for command's `response` shape.
28
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
29
- *
30
- */
9
+
31
10
  export declare class GetExecutionHistoryCommand extends $Command<GetExecutionHistoryCommandInput, GetExecutionHistoryCommandOutput, SFNClientResolvedConfig> {
32
11
  readonly input: GetExecutionHistoryCommandInput;
33
12
  constructor(input: GetExecutionHistoryCommandInput);
34
- /**
35
- * @internal
36
- */
13
+
37
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetExecutionHistoryCommandInput, GetExecutionHistoryCommandOutput>;
38
15
  private serialize;
39
16
  private deserialize;
@@ -6,34 +6,11 @@ export interface ListActivitiesCommandInput extends ListActivitiesInput {
6
6
  }
7
7
  export interface ListActivitiesCommandOutput extends ListActivitiesOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Lists the existing activities.</p>
11
- * <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.
12
- * 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>
13
- * <note>
14
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
15
- * </note>
16
- * @example
17
- * Use a bare-bones client and the command you need to make an API call.
18
- * ```javascript
19
- * import { SFNClient, ListActivitiesCommand } from "@aws-sdk/client-sfn"; // ES Modules import
20
- * // const { SFNClient, ListActivitiesCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
21
- * const client = new SFNClient(config);
22
- * const command = new ListActivitiesCommand(input);
23
- * const response = await client.send(command);
24
- * ```
25
- *
26
- * @see {@link ListActivitiesCommandInput} for command's `input` shape.
27
- * @see {@link ListActivitiesCommandOutput} for command's `response` shape.
28
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
29
- *
30
- */
9
+
31
10
  export declare class ListActivitiesCommand extends $Command<ListActivitiesCommandInput, ListActivitiesCommandOutput, SFNClientResolvedConfig> {
32
11
  readonly input: ListActivitiesCommandInput;
33
12
  constructor(input: ListActivitiesCommandInput);
34
- /**
35
- * @internal
36
- */
13
+
37
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListActivitiesCommandInput, ListActivitiesCommandOutput>;
38
15
  private serialize;
39
16
  private deserialize;
@@ -6,36 +6,11 @@ export interface ListExecutionsCommandInput extends ListExecutionsInput {
6
6
  }
7
7
  export interface ListExecutionsCommandOutput extends ListExecutionsOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Lists the executions of a state machine that meet the filtering criteria. Results are
11
- * sorted by time, with the most recent execution first.</p>
12
- * <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.
13
- * 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>
14
- * <note>
15
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
16
- * </note>
17
- * <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>
18
- * @example
19
- * Use a bare-bones client and the command you need to make an API call.
20
- * ```javascript
21
- * import { SFNClient, ListExecutionsCommand } from "@aws-sdk/client-sfn"; // ES Modules import
22
- * // const { SFNClient, ListExecutionsCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
23
- * const client = new SFNClient(config);
24
- * const command = new ListExecutionsCommand(input);
25
- * const response = await client.send(command);
26
- * ```
27
- *
28
- * @see {@link ListExecutionsCommandInput} for command's `input` shape.
29
- * @see {@link ListExecutionsCommandOutput} for command's `response` shape.
30
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
31
- *
32
- */
9
+
33
10
  export declare class ListExecutionsCommand extends $Command<ListExecutionsCommandInput, ListExecutionsCommandOutput, SFNClientResolvedConfig> {
34
11
  readonly input: ListExecutionsCommandInput;
35
12
  constructor(input: ListExecutionsCommandInput);
36
- /**
37
- * @internal
38
- */
13
+
39
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListExecutionsCommandInput, ListExecutionsCommandOutput>;
40
15
  private serialize;
41
16
  private deserialize;
@@ -6,34 +6,11 @@ export interface ListStateMachinesCommandInput extends ListStateMachinesInput {
6
6
  }
7
7
  export interface ListStateMachinesCommandOutput extends ListStateMachinesOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Lists the existing state machines.</p>
11
- * <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.
12
- * 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>
13
- * <note>
14
- * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
15
- * </note>
16
- * @example
17
- * Use a bare-bones client and the command you need to make an API call.
18
- * ```javascript
19
- * import { SFNClient, ListStateMachinesCommand } from "@aws-sdk/client-sfn"; // ES Modules import
20
- * // const { SFNClient, ListStateMachinesCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
21
- * const client = new SFNClient(config);
22
- * const command = new ListStateMachinesCommand(input);
23
- * const response = await client.send(command);
24
- * ```
25
- *
26
- * @see {@link ListStateMachinesCommandInput} for command's `input` shape.
27
- * @see {@link ListStateMachinesCommandOutput} for command's `response` shape.
28
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
29
- *
30
- */
9
+
31
10
  export declare class ListStateMachinesCommand extends $Command<ListStateMachinesCommandInput, ListStateMachinesCommandOutput, SFNClientResolvedConfig> {
32
11
  readonly input: ListStateMachinesCommandInput;
33
12
  constructor(input: ListStateMachinesCommandInput);
34
- /**
35
- * @internal
36
- */
13
+
37
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListStateMachinesCommandInput, ListStateMachinesCommandOutput>;
38
15
  private serialize;
39
16
  private deserialize;
@@ -6,30 +6,11 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceInpu
6
6
  }
7
7
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>List tags for a given resource.</p>
11
- * <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
12
- * @example
13
- * Use a bare-bones client and the command you need to make an API call.
14
- * ```javascript
15
- * import { SFNClient, ListTagsForResourceCommand } from "@aws-sdk/client-sfn"; // ES Modules import
16
- * // const { SFNClient, ListTagsForResourceCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
17
- * const client = new SFNClient(config);
18
- * const command = new ListTagsForResourceCommand(input);
19
- * const response = await client.send(command);
20
- * ```
21
- *
22
- * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
23
- * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
24
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
25
- *
26
- */
9
+
27
10
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, SFNClientResolvedConfig> {
28
11
  readonly input: ListTagsForResourceCommandInput;
29
12
  constructor(input: ListTagsForResourceCommandInput);
30
- /**
31
- * @internal
32
- */
13
+
33
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
34
15
  private serialize;
35
16
  private deserialize;
@@ -6,30 +6,11 @@ export interface SendTaskFailureCommandInput extends SendTaskFailureInput {
6
6
  }
7
7
  export interface SendTaskFailureCommandOutput extends SendTaskFailureOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Used by activity workers and task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a>
11
- * pattern to report that the task identified by the <code>taskToken</code> failed.</p>
12
- * @example
13
- * Use a bare-bones client and the command you need to make an API call.
14
- * ```javascript
15
- * import { SFNClient, SendTaskFailureCommand } from "@aws-sdk/client-sfn"; // ES Modules import
16
- * // const { SFNClient, SendTaskFailureCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
17
- * const client = new SFNClient(config);
18
- * const command = new SendTaskFailureCommand(input);
19
- * const response = await client.send(command);
20
- * ```
21
- *
22
- * @see {@link SendTaskFailureCommandInput} for command's `input` shape.
23
- * @see {@link SendTaskFailureCommandOutput} for command's `response` shape.
24
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
25
- *
26
- */
9
+
27
10
  export declare class SendTaskFailureCommand extends $Command<SendTaskFailureCommandInput, SendTaskFailureCommandOutput, SFNClientResolvedConfig> {
28
11
  readonly input: SendTaskFailureCommandInput;
29
12
  constructor(input: SendTaskFailureCommandInput);
30
- /**
31
- * @internal
32
- */
13
+
33
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendTaskFailureCommandInput, SendTaskFailureCommandOutput>;
34
15
  private serialize;
35
16
  private deserialize;
@@ -6,43 +6,11 @@ export interface SendTaskHeartbeatCommandInput extends SendTaskHeartbeatInput {
6
6
  }
7
7
  export interface SendTaskHeartbeatCommandOutput extends SendTaskHeartbeatOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Used by activity workers and task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a>
11
- * pattern to report to Step Functions that the task represented by the specified
12
- * <code>taskToken</code> is still making progress. This action resets the
13
- * <code>Heartbeat</code> clock. The <code>Heartbeat</code> threshold is specified in the state
14
- * machine's Amazon States Language definition (<code>HeartbeatSeconds</code>). This action does not in itself
15
- * create an event in the execution history. However, if the task times out, the execution
16
- * history contains an <code>ActivityTimedOut</code> entry for activities, or a
17
- * <code>TaskTimedOut</code> entry for for tasks using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync">job run</a> or
18
- * <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a>
19
- * pattern.</p>
20
- * <note>
21
- * <p>The <code>Timeout</code> of a task, defined in the state machine's Amazon States Language definition, is
22
- * its maximum allowed duration, regardless of the number of <a>SendTaskHeartbeat</a> requests received. Use <code>HeartbeatSeconds</code> to configure the timeout interval
23
- * for heartbeats.</p>
24
- * </note>
25
- * @example
26
- * Use a bare-bones client and the command you need to make an API call.
27
- * ```javascript
28
- * import { SFNClient, SendTaskHeartbeatCommand } from "@aws-sdk/client-sfn"; // ES Modules import
29
- * // const { SFNClient, SendTaskHeartbeatCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
30
- * const client = new SFNClient(config);
31
- * const command = new SendTaskHeartbeatCommand(input);
32
- * const response = await client.send(command);
33
- * ```
34
- *
35
- * @see {@link SendTaskHeartbeatCommandInput} for command's `input` shape.
36
- * @see {@link SendTaskHeartbeatCommandOutput} for command's `response` shape.
37
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
38
- *
39
- */
9
+
40
10
  export declare class SendTaskHeartbeatCommand extends $Command<SendTaskHeartbeatCommandInput, SendTaskHeartbeatCommandOutput, SFNClientResolvedConfig> {
41
11
  readonly input: SendTaskHeartbeatCommandInput;
42
12
  constructor(input: SendTaskHeartbeatCommandInput);
43
- /**
44
- * @internal
45
- */
13
+
46
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendTaskHeartbeatCommandInput, SendTaskHeartbeatCommandOutput>;
47
15
  private serialize;
48
16
  private deserialize;
@@ -6,31 +6,11 @@ export interface SendTaskSuccessCommandInput extends SendTaskSuccessInput {
6
6
  }
7
7
  export interface SendTaskSuccessCommandOutput extends SendTaskSuccessOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Used by activity workers and task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a>
11
- * pattern to report that the task identified by the <code>taskToken</code> completed
12
- * successfully.</p>
13
- * @example
14
- * Use a bare-bones client and the command you need to make an API call.
15
- * ```javascript
16
- * import { SFNClient, SendTaskSuccessCommand } from "@aws-sdk/client-sfn"; // ES Modules import
17
- * // const { SFNClient, SendTaskSuccessCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
18
- * const client = new SFNClient(config);
19
- * const command = new SendTaskSuccessCommand(input);
20
- * const response = await client.send(command);
21
- * ```
22
- *
23
- * @see {@link SendTaskSuccessCommandInput} for command's `input` shape.
24
- * @see {@link SendTaskSuccessCommandOutput} for command's `response` shape.
25
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
26
- *
27
- */
9
+
28
10
  export declare class SendTaskSuccessCommand extends $Command<SendTaskSuccessCommandInput, SendTaskSuccessCommandOutput, SFNClientResolvedConfig> {
29
11
  readonly input: SendTaskSuccessCommandInput;
30
12
  constructor(input: SendTaskSuccessCommandInput);
31
- /**
32
- * @internal
33
- */
13
+
34
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendTaskSuccessCommandInput, SendTaskSuccessCommandOutput>;
35
15
  private serialize;
36
16
  private deserialize;
@@ -6,37 +6,11 @@ export interface StartExecutionCommandInput extends StartExecutionInput {
6
6
  }
7
7
  export interface StartExecutionCommandOutput extends StartExecutionOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Starts a state machine execution.</p>
11
- * <note>
12
- * <p>
13
- * <code>StartExecution</code> is idempotent. If <code>StartExecution</code> is called with
14
- * the same name and input as a running execution, the call will succeed and return the same
15
- * response as the original request. If the execution is closed or if the input is different,
16
- * it will return a 400 <code>ExecutionAlreadyExists</code> error. Names can be reused after 90
17
- * days. </p>
18
- * </note>
19
- * @example
20
- * Use a bare-bones client and the command you need to make an API call.
21
- * ```javascript
22
- * import { SFNClient, StartExecutionCommand } from "@aws-sdk/client-sfn"; // ES Modules import
23
- * // const { SFNClient, StartExecutionCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
24
- * const client = new SFNClient(config);
25
- * const command = new StartExecutionCommand(input);
26
- * const response = await client.send(command);
27
- * ```
28
- *
29
- * @see {@link StartExecutionCommandInput} for command's `input` shape.
30
- * @see {@link StartExecutionCommandOutput} for command's `response` shape.
31
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
32
- *
33
- */
9
+
34
10
  export declare class StartExecutionCommand extends $Command<StartExecutionCommandInput, StartExecutionCommandOutput, SFNClientResolvedConfig> {
35
11
  readonly input: StartExecutionCommandInput;
36
12
  constructor(input: StartExecutionCommandInput);
37
- /**
38
- * @internal
39
- */
13
+
40
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartExecutionCommandInput, StartExecutionCommandOutput>;
41
15
  private serialize;
42
16
  private deserialize;
@@ -6,29 +6,11 @@ export interface StartSyncExecutionCommandInput extends StartSyncExecutionInput
6
6
  }
7
7
  export interface StartSyncExecutionCommandOutput extends StartSyncExecutionOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Starts a Synchronous Express state machine execution.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { SFNClient, StartSyncExecutionCommand } from "@aws-sdk/client-sfn"; // ES Modules import
15
- * // const { SFNClient, StartSyncExecutionCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
16
- * const client = new SFNClient(config);
17
- * const command = new StartSyncExecutionCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link StartSyncExecutionCommandInput} for command's `input` shape.
22
- * @see {@link StartSyncExecutionCommandOutput} for command's `response` shape.
23
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
9
+
26
10
  export declare class StartSyncExecutionCommand extends $Command<StartSyncExecutionCommandInput, StartSyncExecutionCommandOutput, SFNClientResolvedConfig> {
27
11
  readonly input: StartSyncExecutionCommandInput;
28
12
  constructor(input: StartSyncExecutionCommandInput);
29
- /**
30
- * @internal
31
- */
13
+
32
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartSyncExecutionCommandInput, StartSyncExecutionCommandOutput>;
33
15
  private serialize;
34
16
  private deserialize;
@@ -6,30 +6,11 @@ export interface StopExecutionCommandInput extends StopExecutionInput {
6
6
  }
7
7
  export interface StopExecutionCommandOutput extends StopExecutionOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Stops an execution.</p>
11
- * <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>
12
- * @example
13
- * Use a bare-bones client and the command you need to make an API call.
14
- * ```javascript
15
- * import { SFNClient, StopExecutionCommand } from "@aws-sdk/client-sfn"; // ES Modules import
16
- * // const { SFNClient, StopExecutionCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
17
- * const client = new SFNClient(config);
18
- * const command = new StopExecutionCommand(input);
19
- * const response = await client.send(command);
20
- * ```
21
- *
22
- * @see {@link StopExecutionCommandInput} for command's `input` shape.
23
- * @see {@link StopExecutionCommandOutput} for command's `response` shape.
24
- * @see {@link SFNClientResolvedConfig | config} for command's `input` shape.
25
- *
26
- */
9
+
27
10
  export declare class StopExecutionCommand extends $Command<StopExecutionCommandInput, StopExecutionCommandOutput, SFNClientResolvedConfig> {
28
11
  readonly input: StopExecutionCommandInput;
29
12
  constructor(input: StopExecutionCommandInput);
30
- /**
31
- * @internal
32
- */
13
+
33
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopExecutionCommandInput, StopExecutionCommandOutput>;
34
15
  private serialize;
35
16
  private deserialize;