@aws-sdk/client-sfn 3.295.0 → 3.297.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 (37) hide show
  1. package/dist-types/SFN.d.ts +27 -0
  2. package/dist-types/SFNClient.d.ts +24 -4
  3. package/dist-types/commands/CreateActivityCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateStateMachineCommand.d.ts +16 -0
  5. package/dist-types/commands/DeleteActivityCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteStateMachineCommand.d.ts +16 -0
  7. package/dist-types/commands/DescribeActivityCommand.d.ts +16 -0
  8. package/dist-types/commands/DescribeExecutionCommand.d.ts +16 -0
  9. package/dist-types/commands/DescribeMapRunCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeStateMachineCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeStateMachineForExecutionCommand.d.ts +16 -0
  12. package/dist-types/commands/GetActivityTaskCommand.d.ts +16 -0
  13. package/dist-types/commands/GetExecutionHistoryCommand.d.ts +16 -0
  14. package/dist-types/commands/ListActivitiesCommand.d.ts +16 -0
  15. package/dist-types/commands/ListExecutionsCommand.d.ts +16 -0
  16. package/dist-types/commands/ListMapRunsCommand.d.ts +16 -0
  17. package/dist-types/commands/ListStateMachinesCommand.d.ts +16 -0
  18. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  19. package/dist-types/commands/SendTaskFailureCommand.d.ts +16 -0
  20. package/dist-types/commands/SendTaskHeartbeatCommand.d.ts +16 -0
  21. package/dist-types/commands/SendTaskSuccessCommand.d.ts +16 -0
  22. package/dist-types/commands/StartExecutionCommand.d.ts +16 -0
  23. package/dist-types/commands/StartSyncExecutionCommand.d.ts +16 -0
  24. package/dist-types/commands/StopExecutionCommand.d.ts +16 -0
  25. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  26. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  27. package/dist-types/commands/UpdateMapRunCommand.d.ts +16 -0
  28. package/dist-types/commands/UpdateStateMachineCommand.d.ts +16 -0
  29. package/dist-types/models/SFNServiceException.d.ts +2 -0
  30. package/dist-types/models/models_0.d.ts +270 -14
  31. package/dist-types/pagination/GetExecutionHistoryPaginator.d.ts +3 -0
  32. package/dist-types/pagination/Interfaces.d.ts +3 -0
  33. package/dist-types/pagination/ListActivitiesPaginator.d.ts +3 -0
  34. package/dist-types/pagination/ListExecutionsPaginator.d.ts +3 -0
  35. package/dist-types/pagination/ListMapRunsPaginator.d.ts +3 -0
  36. package/dist-types/pagination/ListStateMachinesPaginator.d.ts +3 -0
  37. package/package.json +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeStateMachineInput, DescribeStateMachineOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeStateMachineCommand}.
8
10
  */
9
11
  export interface DescribeStateMachineCommandInput extends DescribeStateMachineInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeStateMachineCommand}.
13
17
  */
14
18
  export interface DescribeStateMachineCommandOutput extends DescribeStateMachineOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration. If the state machine ARN is a qualified state machine ARN, the response returned includes the <code>Map</code> state's label.</p>
18
23
  *
19
24
  * <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>
@@ -31,6 +36,8 @@ export interface DescribeStateMachineCommandOutput extends DescribeStateMachineO
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param DescribeStateMachineCommandInput - {@link DescribeStateMachineCommandInput}
40
+ * @returns {@link DescribeStateMachineCommandOutput}
34
41
  * @see {@link DescribeStateMachineCommandInput} for command's `input` shape.
35
42
  * @see {@link DescribeStateMachineCommandOutput} for command's `response` shape.
36
43
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DescribeStateMachineCommandOutput extends DescribeStateMachineO
46
53
  export declare class DescribeStateMachineCommand extends $Command<DescribeStateMachineCommandInput, DescribeStateMachineCommandOutput, SFNClientResolvedConfig> {
47
54
  readonly input: DescribeStateMachineCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DescribeStateMachineCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeStateMachineCommandInput, DescribeStateMachineCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeStateMachineForExecutionInput, DescribeStateMachineForExecutionOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeStateMachineForExecutionCommand}.
8
10
  */
9
11
  export interface DescribeStateMachineForExecutionCommandInput extends DescribeStateMachineForExecutionInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeStateMachineForExecutionCommand}.
13
17
  */
14
18
  export interface DescribeStateMachineForExecutionCommandOutput extends DescribeStateMachineForExecutionOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Provides information about a state machine's definition, its execution role ARN, and configuration. If an execution was dispatched by a Map Run, the Map Run is returned in the response. Additionally, the state machine returned will be the state machine associated with the Map Run.</p>
18
23
  * <note>
19
24
  * <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
@@ -29,6 +34,8 @@ export interface DescribeStateMachineForExecutionCommandOutput extends DescribeS
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DescribeStateMachineForExecutionCommandInput - {@link DescribeStateMachineForExecutionCommandInput}
38
+ * @returns {@link DescribeStateMachineForExecutionCommandOutput}
32
39
  * @see {@link DescribeStateMachineForExecutionCommandInput} for command's `input` shape.
33
40
  * @see {@link DescribeStateMachineForExecutionCommandOutput} for command's `response` shape.
34
41
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -44,11 +51,20 @@ export interface DescribeStateMachineForExecutionCommandOutput extends DescribeS
44
51
  export declare class DescribeStateMachineForExecutionCommand extends $Command<DescribeStateMachineForExecutionCommandInput, DescribeStateMachineForExecutionCommandOutput, SFNClientResolvedConfig> {
45
52
  readonly input: DescribeStateMachineForExecutionCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: DescribeStateMachineForExecutionCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeStateMachineForExecutionCommandInput, DescribeStateMachineForExecutionCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetActivityTaskInput, GetActivityTaskOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetActivityTaskCommand}.
8
10
  */
9
11
  export interface GetActivityTaskCommandInput extends GetActivityTaskInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetActivityTaskCommand}.
13
17
  */
14
18
  export interface GetActivityTaskCommandOutput extends GetActivityTaskOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Used by workers to retrieve a task (with the specified activity ARN) which has been
18
23
  * scheduled for execution by a running state machine. This initiates a long poll, where the
19
24
  * service holds the HTTP connection open and responds as soon as a task becomes available (i.e.
@@ -42,6 +47,8 @@ export interface GetActivityTaskCommandOutput extends GetActivityTaskOutput, __M
42
47
  * const response = await client.send(command);
43
48
  * ```
44
49
  *
50
+ * @param GetActivityTaskCommandInput - {@link GetActivityTaskCommandInput}
51
+ * @returns {@link GetActivityTaskCommandOutput}
45
52
  * @see {@link GetActivityTaskCommandInput} for command's `input` shape.
46
53
  * @see {@link GetActivityTaskCommandOutput} for command's `response` shape.
47
54
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -61,11 +68,20 @@ export interface GetActivityTaskCommandOutput extends GetActivityTaskOutput, __M
61
68
  export declare class GetActivityTaskCommand extends $Command<GetActivityTaskCommandInput, GetActivityTaskCommandOutput, SFNClientResolvedConfig> {
62
69
  readonly input: GetActivityTaskCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: GetActivityTaskCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetActivityTaskCommandInput, GetActivityTaskCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetExecutionHistoryInput, GetExecutionHistoryOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetExecutionHistoryCommand}.
8
10
  */
9
11
  export interface GetExecutionHistoryCommandInput extends GetExecutionHistoryInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetExecutionHistoryCommand}.
13
17
  */
14
18
  export interface GetExecutionHistoryCommandOutput extends GetExecutionHistoryOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the history of the specified execution as a list of events. By default, the
18
23
  * results are returned in ascending order of the <code>timeStamp</code> of the events. Use the
19
24
  * <code>reverseOrder</code> parameter to get the latest events first.</p>
@@ -30,6 +35,8 @@ export interface GetExecutionHistoryCommandOutput extends GetExecutionHistoryOut
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param GetExecutionHistoryCommandInput - {@link GetExecutionHistoryCommandInput}
39
+ * @returns {@link GetExecutionHistoryCommandOutput}
33
40
  * @see {@link GetExecutionHistoryCommandInput} for command's `input` shape.
34
41
  * @see {@link GetExecutionHistoryCommandOutput} for command's `response` shape.
35
42
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -48,11 +55,20 @@ export interface GetExecutionHistoryCommandOutput extends GetExecutionHistoryOut
48
55
  export declare class GetExecutionHistoryCommand extends $Command<GetExecutionHistoryCommandInput, GetExecutionHistoryCommandOutput, SFNClientResolvedConfig> {
49
56
  readonly input: GetExecutionHistoryCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: GetExecutionHistoryCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetExecutionHistoryCommandInput, GetExecutionHistoryCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListActivitiesInput, ListActivitiesOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListActivitiesCommand}.
8
10
  */
9
11
  export interface ListActivitiesCommandInput extends ListActivitiesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListActivitiesCommand}.
13
17
  */
14
18
  export interface ListActivitiesCommandOutput extends ListActivitiesOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the existing activities.</p>
18
23
  * <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.
19
24
  * 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,6 +35,8 @@ export interface ListActivitiesCommandOutput extends ListActivitiesOutput, __Met
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param ListActivitiesCommandInput - {@link ListActivitiesCommandInput}
39
+ * @returns {@link ListActivitiesCommandOutput}
33
40
  * @see {@link ListActivitiesCommandInput} for command's `input` shape.
34
41
  * @see {@link ListActivitiesCommandOutput} for command's `response` shape.
35
42
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -42,11 +49,20 @@ export interface ListActivitiesCommandOutput extends ListActivitiesOutput, __Met
42
49
  export declare class ListActivitiesCommand extends $Command<ListActivitiesCommandInput, ListActivitiesCommandOutput, SFNClientResolvedConfig> {
43
50
  readonly input: ListActivitiesCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: ListActivitiesCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListActivitiesCommandInput, ListActivitiesCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListExecutionsInput, ListExecutionsOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListExecutionsCommand}.
8
10
  */
9
11
  export interface ListExecutionsCommandInput extends ListExecutionsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListExecutionsCommand}.
13
17
  */
14
18
  export interface ListExecutionsCommandOutput extends ListExecutionsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * <p>Results are
19
24
  * sorted by time, with the most recent execution first.</p>
@@ -33,6 +38,8 @@ export interface ListExecutionsCommandOutput extends ListExecutionsOutput, __Met
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param ListExecutionsCommandInput - {@link ListExecutionsCommandInput}
42
+ * @returns {@link ListExecutionsCommandOutput}
36
43
  * @see {@link ListExecutionsCommandInput} for command's `input` shape.
37
44
  * @see {@link ListExecutionsCommandOutput} for command's `response` shape.
38
45
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -61,11 +68,20 @@ export interface ListExecutionsCommandOutput extends ListExecutionsOutput, __Met
61
68
  export declare class ListExecutionsCommand extends $Command<ListExecutionsCommandInput, ListExecutionsCommandOutput, SFNClientResolvedConfig> {
62
69
  readonly input: ListExecutionsCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: ListExecutionsCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListExecutionsCommandInput, ListExecutionsCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListMapRunsInput, ListMapRunsOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListMapRunsCommand}.
8
10
  */
9
11
  export interface ListMapRunsCommandInput extends ListMapRunsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListMapRunsCommand}.
13
17
  */
14
18
  export interface ListMapRunsCommandOutput extends ListMapRunsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call <code>DescribeMapRun</code> to obtain more information, if needed.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListMapRunsCommandOutput extends ListMapRunsOutput, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListMapRunsCommandInput - {@link ListMapRunsCommandInput}
34
+ * @returns {@link ListMapRunsCommandOutput}
28
35
  * @see {@link ListMapRunsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListMapRunsCommandOutput} for command's `response` shape.
30
37
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -43,11 +50,20 @@ export interface ListMapRunsCommandOutput extends ListMapRunsOutput, __MetadataB
43
50
  export declare class ListMapRunsCommand extends $Command<ListMapRunsCommandInput, ListMapRunsCommandOutput, SFNClientResolvedConfig> {
44
51
  readonly input: ListMapRunsCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: ListMapRunsCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListMapRunsCommandInput, ListMapRunsCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListStateMachinesInput, ListStateMachinesOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListStateMachinesCommand}.
8
10
  */
9
11
  export interface ListStateMachinesCommandInput extends ListStateMachinesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListStateMachinesCommand}.
13
17
  */
14
18
  export interface ListStateMachinesCommandOutput extends ListStateMachinesOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the existing state machines.</p>
18
23
  * <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.
19
24
  * 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,6 +35,8 @@ export interface ListStateMachinesCommandOutput extends ListStateMachinesOutput,
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param ListStateMachinesCommandInput - {@link ListStateMachinesCommandInput}
39
+ * @returns {@link ListStateMachinesCommandOutput}
33
40
  * @see {@link ListStateMachinesCommandInput} for command's `input` shape.
34
41
  * @see {@link ListStateMachinesCommandOutput} for command's `response` shape.
35
42
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -42,11 +49,20 @@ export interface ListStateMachinesCommandOutput extends ListStateMachinesOutput,
42
49
  export declare class ListStateMachinesCommand extends $Command<ListStateMachinesCommandInput, ListStateMachinesCommandOutput, SFNClientResolvedConfig> {
43
50
  readonly input: ListStateMachinesCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: ListStateMachinesCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListStateMachinesCommandInput, ListStateMachinesCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListTagsForResourceInput, ListTagsForResourceOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>List tags for a given resource.</p>
18
23
  * <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
35
+ * @returns {@link ListTagsForResourceCommandOutput}
29
36
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
30
37
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
31
38
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -42,11 +49,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
42
49
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, SFNClientResolvedConfig> {
43
50
  readonly input: ListTagsForResourceCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: ListTagsForResourceCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { SendTaskFailureInput, SendTaskFailureOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SendTaskFailureCommand}.
8
10
  */
9
11
  export interface SendTaskFailureCommandInput extends SendTaskFailureInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SendTaskFailureCommand}.
13
17
  */
14
18
  export interface SendTaskFailureCommandOutput extends SendTaskFailureOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * pattern to report that the task identified by the <code>taskToken</code> failed.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface SendTaskFailureCommandOutput extends SendTaskFailureOutput, __M
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param SendTaskFailureCommandInput - {@link SendTaskFailureCommandInput}
35
+ * @returns {@link SendTaskFailureCommandOutput}
29
36
  * @see {@link SendTaskFailureCommandInput} for command's `input` shape.
30
37
  * @see {@link SendTaskFailureCommandOutput} for command's `response` shape.
31
38
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -42,11 +49,20 @@ export interface SendTaskFailureCommandOutput extends SendTaskFailureOutput, __M
42
49
  export declare class SendTaskFailureCommand extends $Command<SendTaskFailureCommandInput, SendTaskFailureCommandOutput, SFNClientResolvedConfig> {
43
50
  readonly input: SendTaskFailureCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: SendTaskFailureCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendTaskFailureCommandInput, SendTaskFailureCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { SendTaskHeartbeatInput, SendTaskHeartbeatOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SendTaskHeartbeatCommand}.
8
10
  */
9
11
  export interface SendTaskHeartbeatCommandInput extends SendTaskHeartbeatInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SendTaskHeartbeatCommand}.
13
17
  */
14
18
  export interface SendTaskHeartbeatCommandOutput extends SendTaskHeartbeatOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * pattern to report to Step Functions that the task represented by the specified
19
24
  * <code>taskToken</code> is still making progress. This action resets the
@@ -39,6 +44,8 @@ export interface SendTaskHeartbeatCommandOutput extends SendTaskHeartbeatOutput,
39
44
  * const response = await client.send(command);
40
45
  * ```
41
46
  *
47
+ * @param SendTaskHeartbeatCommandInput - {@link SendTaskHeartbeatCommandInput}
48
+ * @returns {@link SendTaskHeartbeatCommandOutput}
42
49
  * @see {@link SendTaskHeartbeatCommandInput} for command's `input` shape.
43
50
  * @see {@link SendTaskHeartbeatCommandOutput} for command's `response` shape.
44
51
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -55,11 +62,20 @@ export interface SendTaskHeartbeatCommandOutput extends SendTaskHeartbeatOutput,
55
62
  export declare class SendTaskHeartbeatCommand extends $Command<SendTaskHeartbeatCommandInput, SendTaskHeartbeatCommandOutput, SFNClientResolvedConfig> {
56
63
  readonly input: SendTaskHeartbeatCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: SendTaskHeartbeatCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendTaskHeartbeatCommandInput, SendTaskHeartbeatCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { SendTaskSuccessInput, SendTaskSuccessOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SendTaskSuccessCommand}.
8
10
  */
9
11
  export interface SendTaskSuccessCommandInput extends SendTaskSuccessInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SendTaskSuccessCommand}.
13
17
  */
14
18
  export interface SendTaskSuccessCommandOutput extends SendTaskSuccessOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
18
23
  * pattern to report that the task identified by the <code>taskToken</code> completed
19
24
  * successfully.</p>
@@ -27,6 +32,8 @@ export interface SendTaskSuccessCommandOutput extends SendTaskSuccessOutput, __M
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param SendTaskSuccessCommandInput - {@link SendTaskSuccessCommandInput}
36
+ * @returns {@link SendTaskSuccessCommandOutput}
30
37
  * @see {@link SendTaskSuccessCommandInput} for command's `input` shape.
31
38
  * @see {@link SendTaskSuccessCommandOutput} for command's `response` shape.
32
39
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -46,11 +53,20 @@ export interface SendTaskSuccessCommandOutput extends SendTaskSuccessOutput, __M
46
53
  export declare class SendTaskSuccessCommand extends $Command<SendTaskSuccessCommandInput, SendTaskSuccessCommandOutput, SFNClientResolvedConfig> {
47
54
  readonly input: SendTaskSuccessCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: SendTaskSuccessCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendTaskSuccessCommandInput, SendTaskSuccessCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }