aws-sdk 2.1402.0 → 2.1403.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/CHANGELOG.md +7 -1
- package/README.md +1 -1
- package/apis/chime-sdk-identity-2021-04-20.min.json +67 -80
- package/apis/chime-sdk-messaging-2021-05-15.min.json +48 -30
- package/apis/kendra-2019-02-03.min.json +72 -14
- package/apis/states-2016-11-23.min.json +367 -89
- package/clients/chimesdkidentity.d.ts +38 -17
- package/clients/chimesdkmessaging.d.ts +47 -28
- package/clients/kendra.d.ts +104 -23
- package/clients/stepfunctions.d.ts +356 -25
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +5 -5
- package/dist/aws-sdk.js +3 -3
- package/dist/aws-sdk.min.js +2 -2
- package/lib/core.js +1 -1
- package/package.json +1 -1
@@ -20,13 +20,21 @@ declare class StepFunctions extends Service {
|
|
20
20
|
*/
|
21
21
|
createActivity(callback?: (err: AWSError, data: StepFunctions.Types.CreateActivityOutput) => void): Request<StepFunctions.Types.CreateActivityOutput, AWSError>;
|
22
22
|
/**
|
23
|
-
* Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration and TracingConfiguration. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.
|
23
|
+
* Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide. If you set the publish parameter of this API action to true, it publishes version 1 as the first revision of the state machine. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration, and TracingConfiguration. The check is also based on the publish and versionDescription parameters. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.
|
24
24
|
*/
|
25
25
|
createStateMachine(params: StepFunctions.Types.CreateStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.CreateStateMachineOutput) => void): Request<StepFunctions.Types.CreateStateMachineOutput, AWSError>;
|
26
26
|
/**
|
27
|
-
* Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration and TracingConfiguration. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.
|
27
|
+
* Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide. If you set the publish parameter of this API action to true, it publishes version 1 as the first revision of the state machine. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration, and TracingConfiguration. The check is also based on the publish and versionDescription parameters. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.
|
28
28
|
*/
|
29
29
|
createStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.CreateStateMachineOutput) => void): Request<StepFunctions.Types.CreateStateMachineOutput, AWSError>;
|
30
|
+
/**
|
31
|
+
* Creates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client's code. You can also map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second RoutingConfig object in the routingConfiguration parameter. You must also specify the percentage of execution run requests each version should receive in both RoutingConfig objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify. To create an alias that points to a single version, specify a single RoutingConfig object with a weight set to 100. You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action. CreateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineArn, description, name, and routingConfiguration parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource. Related operations: DescribeStateMachineAlias ListStateMachineAliases UpdateStateMachineAlias DeleteStateMachineAlias
|
32
|
+
*/
|
33
|
+
createStateMachineAlias(params: StepFunctions.Types.CreateStateMachineAliasInput, callback?: (err: AWSError, data: StepFunctions.Types.CreateStateMachineAliasOutput) => void): Request<StepFunctions.Types.CreateStateMachineAliasOutput, AWSError>;
|
34
|
+
/**
|
35
|
+
* Creates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client's code. You can also map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second RoutingConfig object in the routingConfiguration parameter. You must also specify the percentage of execution run requests each version should receive in both RoutingConfig objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify. To create an alias that points to a single version, specify a single RoutingConfig object with a weight set to 100. You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action. CreateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineArn, description, name, and routingConfiguration parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource. Related operations: DescribeStateMachineAlias ListStateMachineAliases UpdateStateMachineAlias DeleteStateMachineAlias
|
36
|
+
*/
|
37
|
+
createStateMachineAlias(callback?: (err: AWSError, data: StepFunctions.Types.CreateStateMachineAliasOutput) => void): Request<StepFunctions.Types.CreateStateMachineAliasOutput, AWSError>;
|
30
38
|
/**
|
31
39
|
* Deletes an activity.
|
32
40
|
*/
|
@@ -36,13 +44,29 @@ declare class StepFunctions extends Service {
|
|
36
44
|
*/
|
37
45
|
deleteActivity(callback?: (err: AWSError, data: StepFunctions.Types.DeleteActivityOutput) => void): Request<StepFunctions.Types.DeleteActivityOutput, AWSError>;
|
38
46
|
/**
|
39
|
-
* Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process.
|
47
|
+
* Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine This API action also deletes all versions and aliases associated with a state machine. For EXPRESS state machines, the deletion happens eventually (usually in less than a minute). Running executions may emit logs after DeleteStateMachine API is called.
|
40
48
|
*/
|
41
49
|
deleteStateMachine(params: StepFunctions.Types.DeleteStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.DeleteStateMachineOutput) => void): Request<StepFunctions.Types.DeleteStateMachineOutput, AWSError>;
|
42
50
|
/**
|
43
|
-
* Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process.
|
51
|
+
* Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine This API action also deletes all versions and aliases associated with a state machine. For EXPRESS state machines, the deletion happens eventually (usually in less than a minute). Running executions may emit logs after DeleteStateMachine API is called.
|
44
52
|
*/
|
45
53
|
deleteStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.DeleteStateMachineOutput) => void): Request<StepFunctions.Types.DeleteStateMachineOutput, AWSError>;
|
54
|
+
/**
|
55
|
+
* Deletes a state machine alias. After you delete a state machine alias, you can't use it to start executions. When you delete a state machine alias, Step Functions doesn't delete the state machine versions that alias references. Related operations: CreateStateMachineAlias DescribeStateMachineAlias ListStateMachineAliases UpdateStateMachineAlias
|
56
|
+
*/
|
57
|
+
deleteStateMachineAlias(params: StepFunctions.Types.DeleteStateMachineAliasInput, callback?: (err: AWSError, data: StepFunctions.Types.DeleteStateMachineAliasOutput) => void): Request<StepFunctions.Types.DeleteStateMachineAliasOutput, AWSError>;
|
58
|
+
/**
|
59
|
+
* Deletes a state machine alias. After you delete a state machine alias, you can't use it to start executions. When you delete a state machine alias, Step Functions doesn't delete the state machine versions that alias references. Related operations: CreateStateMachineAlias DescribeStateMachineAlias ListStateMachineAliases UpdateStateMachineAlias
|
60
|
+
*/
|
61
|
+
deleteStateMachineAlias(callback?: (err: AWSError, data: StepFunctions.Types.DeleteStateMachineAliasOutput) => void): Request<StepFunctions.Types.DeleteStateMachineAliasOutput, AWSError>;
|
62
|
+
/**
|
63
|
+
* Deletes a state machine version. After you delete a version, you can't call StartExecution using that version's ARN or use the version with a state machine alias. Deleting a state machine version won't terminate its in-progress executions. 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. Related operations: PublishStateMachineVersion ListStateMachineVersions
|
64
|
+
*/
|
65
|
+
deleteStateMachineVersion(params: StepFunctions.Types.DeleteStateMachineVersionInput, callback?: (err: AWSError, data: StepFunctions.Types.DeleteStateMachineVersionOutput) => void): Request<StepFunctions.Types.DeleteStateMachineVersionOutput, AWSError>;
|
66
|
+
/**
|
67
|
+
* Deletes a state machine version. After you delete a version, you can't call StartExecution using that version's ARN or use the version with a state machine alias. Deleting a state machine version won't terminate its in-progress executions. 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. Related operations: PublishStateMachineVersion ListStateMachineVersions
|
68
|
+
*/
|
69
|
+
deleteStateMachineVersion(callback?: (err: AWSError, data: StepFunctions.Types.DeleteStateMachineVersionOutput) => void): Request<StepFunctions.Types.DeleteStateMachineVersionOutput, AWSError>;
|
46
70
|
/**
|
47
71
|
* Describes an activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
|
48
72
|
*/
|
@@ -52,11 +76,11 @@ declare class StepFunctions extends Service {
|
|
52
76
|
*/
|
53
77
|
describeActivity(callback?: (err: AWSError, data: StepFunctions.Types.DescribeActivityOutput) => void): Request<StepFunctions.Types.DescribeActivityOutput, AWSError>;
|
54
78
|
/**
|
55
|
-
* Provides
|
79
|
+
* Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. Use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run. If you specify a version or alias ARN when you call the StartExecution API action, DescribeExecution returns that ARN. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. Executions of an EXPRESS state machinearen't supported by DescribeExecution unless a Map Run dispatched them.
|
56
80
|
*/
|
57
81
|
describeExecution(params: StepFunctions.Types.DescribeExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeExecutionOutput) => void): Request<StepFunctions.Types.DescribeExecutionOutput, AWSError>;
|
58
82
|
/**
|
59
|
-
* Provides
|
83
|
+
* Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. Use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run. If you specify a version or alias ARN when you call the StartExecution API action, DescribeExecution returns that ARN. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. Executions of an EXPRESS state machinearen't supported by DescribeExecution unless a Map Run dispatched them.
|
60
84
|
*/
|
61
85
|
describeExecution(callback?: (err: AWSError, data: StepFunctions.Types.DescribeExecutionOutput) => void): Request<StepFunctions.Types.DescribeExecutionOutput, AWSError>;
|
62
86
|
/**
|
@@ -68,19 +92,27 @@ declare class StepFunctions extends Service {
|
|
68
92
|
*/
|
69
93
|
describeMapRun(callback?: (err: AWSError, data: StepFunctions.Types.DescribeMapRunOutput) => void): Request<StepFunctions.Types.DescribeMapRunOutput, AWSError>;
|
70
94
|
/**
|
71
|
-
* Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.
|
95
|
+
* Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. The following qualified state machine ARN refers to an alias named PROD. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> 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. The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> This API action returns the details for a state machine version if the stateMachineArn you specify is a state machine version ARN. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
|
72
96
|
*/
|
73
97
|
describeStateMachine(params: StepFunctions.Types.DescribeStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineOutput) => void): Request<StepFunctions.Types.DescribeStateMachineOutput, AWSError>;
|
74
98
|
/**
|
75
|
-
* Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.
|
99
|
+
* Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. The following qualified state machine ARN refers to an alias named PROD. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> 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. The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> This API action returns the details for a state machine version if the stateMachineArn you specify is a state machine version ARN. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
|
76
100
|
*/
|
77
101
|
describeStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineOutput) => void): Request<StepFunctions.Types.DescribeStateMachineOutput, AWSError>;
|
78
102
|
/**
|
79
|
-
*
|
103
|
+
* Returns details about a state machine alias. Related operations: CreateStateMachineAlias ListStateMachineAliases UpdateStateMachineAlias DeleteStateMachineAlias
|
104
|
+
*/
|
105
|
+
describeStateMachineAlias(params: StepFunctions.Types.DescribeStateMachineAliasInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineAliasOutput) => void): Request<StepFunctions.Types.DescribeStateMachineAliasOutput, AWSError>;
|
106
|
+
/**
|
107
|
+
* Returns details about a state machine alias. Related operations: CreateStateMachineAlias ListStateMachineAliases UpdateStateMachineAlias DeleteStateMachineAlias
|
108
|
+
*/
|
109
|
+
describeStateMachineAlias(callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineAliasOutput) => void): Request<StepFunctions.Types.DescribeStateMachineAliasOutput, AWSError>;
|
110
|
+
/**
|
111
|
+
* Provides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. This API action is not supported by EXPRESS state machines.
|
80
112
|
*/
|
81
113
|
describeStateMachineForExecution(params: StepFunctions.Types.DescribeStateMachineForExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineForExecutionOutput) => void): Request<StepFunctions.Types.DescribeStateMachineForExecutionOutput, AWSError>;
|
82
114
|
/**
|
83
|
-
* Provides information about a state machine's definition, its execution role ARN, and configuration. If
|
115
|
+
* Provides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. This API action is not supported by EXPRESS state machines.
|
84
116
|
*/
|
85
117
|
describeStateMachineForExecution(callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineForExecutionOutput) => void): Request<StepFunctions.Types.DescribeStateMachineForExecutionOutput, AWSError>;
|
86
118
|
/**
|
@@ -108,11 +140,11 @@ declare class StepFunctions extends Service {
|
|
108
140
|
*/
|
109
141
|
listActivities(callback?: (err: AWSError, data: StepFunctions.Types.ListActivitiesOutput) => void): Request<StepFunctions.Types.ListActivitiesOutput, AWSError>;
|
110
142
|
/**
|
111
|
-
* 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. Results are sorted by time, with the most recent execution first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. 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 HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. This API action is not supported by EXPRESS state machines.
|
143
|
+
* 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. You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version. Results are sorted by time, with the most recent execution first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. 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 HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. This API action is not supported by EXPRESS state machines.
|
112
144
|
*/
|
113
145
|
listExecutions(params: StepFunctions.Types.ListExecutionsInput, callback?: (err: AWSError, data: StepFunctions.Types.ListExecutionsOutput) => void): Request<StepFunctions.Types.ListExecutionsOutput, AWSError>;
|
114
146
|
/**
|
115
|
-
* 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. Results are sorted by time, with the most recent execution first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. 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 HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. This API action is not supported by EXPRESS state machines.
|
147
|
+
* 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. You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version. Results are sorted by time, with the most recent execution first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. 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 HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. This API action is not supported by EXPRESS state machines.
|
116
148
|
*/
|
117
149
|
listExecutions(callback?: (err: AWSError, data: StepFunctions.Types.ListExecutionsOutput) => void): Request<StepFunctions.Types.ListExecutionsOutput, AWSError>;
|
118
150
|
/**
|
@@ -123,6 +155,22 @@ declare class StepFunctions extends Service {
|
|
123
155
|
* 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 DescribeMapRun to obtain more information, if needed.
|
124
156
|
*/
|
125
157
|
listMapRuns(callback?: (err: AWSError, data: StepFunctions.Types.ListMapRunsOutput) => void): Request<StepFunctions.Types.ListMapRunsOutput, AWSError>;
|
158
|
+
/**
|
159
|
+
* Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first. To list aliases that reference a state machine version, you can specify the version ARN in the stateMachineArn parameter. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. 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 HTTP 400 InvalidToken error. Related operations: CreateStateMachineAlias DescribeStateMachineAlias UpdateStateMachineAlias DeleteStateMachineAlias
|
160
|
+
*/
|
161
|
+
listStateMachineAliases(params: StepFunctions.Types.ListStateMachineAliasesInput, callback?: (err: AWSError, data: StepFunctions.Types.ListStateMachineAliasesOutput) => void): Request<StepFunctions.Types.ListStateMachineAliasesOutput, AWSError>;
|
162
|
+
/**
|
163
|
+
* Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first. To list aliases that reference a state machine version, you can specify the version ARN in the stateMachineArn parameter. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. 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 HTTP 400 InvalidToken error. Related operations: CreateStateMachineAlias DescribeStateMachineAlias UpdateStateMachineAlias DeleteStateMachineAlias
|
164
|
+
*/
|
165
|
+
listStateMachineAliases(callback?: (err: AWSError, data: StepFunctions.Types.ListStateMachineAliasesOutput) => void): Request<StepFunctions.Types.ListStateMachineAliasesOutput, AWSError>;
|
166
|
+
/**
|
167
|
+
* Lists versions for the specified state machine Amazon Resource Name (ARN). The results are sorted in descending order of the version creation time. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. 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 HTTP 400 InvalidToken error. Related operations: PublishStateMachineVersion DeleteStateMachineVersion
|
168
|
+
*/
|
169
|
+
listStateMachineVersions(params: StepFunctions.Types.ListStateMachineVersionsInput, callback?: (err: AWSError, data: StepFunctions.Types.ListStateMachineVersionsOutput) => void): Request<StepFunctions.Types.ListStateMachineVersionsOutput, AWSError>;
|
170
|
+
/**
|
171
|
+
* Lists versions for the specified state machine Amazon Resource Name (ARN). The results are sorted in descending order of the version creation time. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. 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 HTTP 400 InvalidToken error. Related operations: PublishStateMachineVersion DeleteStateMachineVersion
|
172
|
+
*/
|
173
|
+
listStateMachineVersions(callback?: (err: AWSError, data: StepFunctions.Types.ListStateMachineVersionsOutput) => void): Request<StepFunctions.Types.ListStateMachineVersionsOutput, AWSError>;
|
126
174
|
/**
|
127
175
|
* Lists the existing state machines. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. 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 HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
|
128
176
|
*/
|
@@ -139,6 +187,14 @@ declare class StepFunctions extends Service {
|
|
139
187
|
* List tags for a given resource. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
|
140
188
|
*/
|
141
189
|
listTagsForResource(callback?: (err: AWSError, data: StepFunctions.Types.ListTagsForResourceOutput) => void): Request<StepFunctions.Types.ListTagsForResourceOutput, AWSError>;
|
190
|
+
/**
|
191
|
+
* Creates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias. You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action. PublishStateMachineVersion is an idempotent API. It doesn't create a duplicate state machine version if it already exists for the current revision. Step Functions bases PublishStateMachineVersion's idempotency check on the stateMachineArn, name, and revisionId parameters. Requests with the same parameters return a successful idempotent response. If you don't specify a revisionId, Step Functions checks for a previously published version of the state machine's current revision. Related operations: DeleteStateMachineVersion ListStateMachineVersions
|
192
|
+
*/
|
193
|
+
publishStateMachineVersion(params: StepFunctions.Types.PublishStateMachineVersionInput, callback?: (err: AWSError, data: StepFunctions.Types.PublishStateMachineVersionOutput) => void): Request<StepFunctions.Types.PublishStateMachineVersionOutput, AWSError>;
|
194
|
+
/**
|
195
|
+
* Creates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias. You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action. PublishStateMachineVersion is an idempotent API. It doesn't create a duplicate state machine version if it already exists for the current revision. Step Functions bases PublishStateMachineVersion's idempotency check on the stateMachineArn, name, and revisionId parameters. Requests with the same parameters return a successful idempotent response. If you don't specify a revisionId, Step Functions checks for a previously published version of the state machine's current revision. Related operations: DeleteStateMachineVersion ListStateMachineVersions
|
196
|
+
*/
|
197
|
+
publishStateMachineVersion(callback?: (err: AWSError, data: StepFunctions.Types.PublishStateMachineVersionOutput) => void): Request<StepFunctions.Types.PublishStateMachineVersionOutput, AWSError>;
|
142
198
|
/**
|
143
199
|
* Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
|
144
200
|
*/
|
@@ -164,11 +220,11 @@ declare class StepFunctions extends Service {
|
|
164
220
|
*/
|
165
221
|
sendTaskSuccess(callback?: (err: AWSError, data: StepFunctions.Types.SendTaskSuccessOutput) => void): Request<StepFunctions.Types.SendTaskSuccessOutput, AWSError>;
|
166
222
|
/**
|
167
|
-
* Starts a state machine execution.
|
223
|
+
* Starts a state machine execution. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. The following qualified state machine ARN refers to an alias named PROD. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> 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. The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution. To start executions of a state machine version, call StartExecution and provide the version ARN or the ARN of an alias that points to the version. StartExecution is idempotent for STANDARD workflows. For a STANDARD workflow, if you call StartExecution with the same name and input as a running execution, the call succeeds and return the same response as the original request. If the execution is closed or if the input is different, it returns a 400 ExecutionAlreadyExists error. You can reuse names after 90 days. StartExecution isn't idempotent for EXPRESS workflows.
|
168
224
|
*/
|
169
225
|
startExecution(params: StepFunctions.Types.StartExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.StartExecutionOutput) => void): Request<StepFunctions.Types.StartExecutionOutput, AWSError>;
|
170
226
|
/**
|
171
|
-
* Starts a state machine execution.
|
227
|
+
* Starts a state machine execution. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. The following qualified state machine ARN refers to an alias named PROD. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> 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. The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution. To start executions of a state machine version, call StartExecution and provide the version ARN or the ARN of an alias that points to the version. StartExecution is idempotent for STANDARD workflows. For a STANDARD workflow, if you call StartExecution with the same name and input as a running execution, the call succeeds and return the same response as the original request. If the execution is closed or if the input is different, it returns a 400 ExecutionAlreadyExists error. You can reuse names after 90 days. StartExecution isn't idempotent for EXPRESS workflows.
|
172
228
|
*/
|
173
229
|
startExecution(callback?: (err: AWSError, data: StepFunctions.Types.StartExecutionOutput) => void): Request<StepFunctions.Types.StartExecutionOutput, AWSError>;
|
174
230
|
/**
|
@@ -212,13 +268,21 @@ declare class StepFunctions extends Service {
|
|
212
268
|
*/
|
213
269
|
updateMapRun(callback?: (err: AWSError, data: StepFunctions.Types.UpdateMapRunOutput) => void): Request<StepFunctions.Types.UpdateMapRunOutput, AWSError>;
|
214
270
|
/**
|
215
|
-
* Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.
|
271
|
+
* Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error. A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. The following qualified state machine ARN refers to an alias named PROD. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> 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. The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> After you update your state machine, you can set the publish parameter to true in the same action to publish a new version. This way, you can opt-in to strict versioning of your state machine. Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1. All StartExecution calls within a few seconds use the updated definition and roleArn. Executions started immediately after you call UpdateStateMachine may use the previous state machine definition and roleArn.
|
216
272
|
*/
|
217
273
|
updateStateMachine(params: StepFunctions.Types.UpdateStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.UpdateStateMachineOutput) => void): Request<StepFunctions.Types.UpdateStateMachineOutput, AWSError>;
|
218
274
|
/**
|
219
|
-
* Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.
|
275
|
+
* Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error. A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. The following qualified state machine ARN refers to an alias named PROD. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> 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. The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> After you update your state machine, you can set the publish parameter to true in the same action to publish a new version. This way, you can opt-in to strict versioning of your state machine. Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1. All StartExecution calls within a few seconds use the updated definition and roleArn. Executions started immediately after you call UpdateStateMachine may use the previous state machine definition and roleArn.
|
220
276
|
*/
|
221
277
|
updateStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.UpdateStateMachineOutput) => void): Request<StepFunctions.Types.UpdateStateMachineOutput, AWSError>;
|
278
|
+
/**
|
279
|
+
* Updates the configuration of an existing state machine alias by modifying its description or routingConfiguration. You must specify at least one of the description or routingConfiguration parameters to update a state machine alias. UpdateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineAliasArn, description, and routingConfiguration parameters. Requests with the same parameters return an idempotent response. This operation is eventually consistent. All StartExecution requests made within a few seconds use the latest alias configuration. Executions started immediately after calling UpdateStateMachineAlias may use the previous routing configuration. Related operations: CreateStateMachineAlias DescribeStateMachineAlias ListStateMachineAliases DeleteStateMachineAlias
|
280
|
+
*/
|
281
|
+
updateStateMachineAlias(params: StepFunctions.Types.UpdateStateMachineAliasInput, callback?: (err: AWSError, data: StepFunctions.Types.UpdateStateMachineAliasOutput) => void): Request<StepFunctions.Types.UpdateStateMachineAliasOutput, AWSError>;
|
282
|
+
/**
|
283
|
+
* Updates the configuration of an existing state machine alias by modifying its description or routingConfiguration. You must specify at least one of the description or routingConfiguration parameters to update a state machine alias. UpdateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineAliasArn, description, and routingConfiguration parameters. Requests with the same parameters return an idempotent response. This operation is eventually consistent. All StartExecution requests made within a few seconds use the latest alias configuration. Executions started immediately after calling UpdateStateMachineAlias may use the previous routing configuration. Related operations: CreateStateMachineAlias DescribeStateMachineAlias ListStateMachineAliases DeleteStateMachineAlias
|
284
|
+
*/
|
285
|
+
updateStateMachineAlias(callback?: (err: AWSError, data: StepFunctions.Types.UpdateStateMachineAliasOutput) => void): Request<StepFunctions.Types.UpdateStateMachineAliasOutput, AWSError>;
|
222
286
|
}
|
223
287
|
declare namespace StepFunctions {
|
224
288
|
export interface ActivityFailedEventDetails {
|
@@ -304,6 +368,7 @@ declare namespace StepFunctions {
|
|
304
368
|
*/
|
305
369
|
cause?: SensitiveCause;
|
306
370
|
}
|
371
|
+
export type AliasDescription = string;
|
307
372
|
export type Arn = string;
|
308
373
|
export type BilledDuration = number;
|
309
374
|
export type BilledMemoryUsed = number;
|
@@ -317,6 +382,7 @@ declare namespace StepFunctions {
|
|
317
382
|
*/
|
318
383
|
billedDurationInMilliseconds?: BilledDuration;
|
319
384
|
}
|
385
|
+
export type CharacterRestrictedName = string;
|
320
386
|
export interface CloudWatchEventsExecutionDataDetails {
|
321
387
|
/**
|
322
388
|
* Indicates whether input or output was included in the response. Always true for API calls.
|
@@ -350,6 +416,30 @@ declare namespace StepFunctions {
|
|
350
416
|
*/
|
351
417
|
creationDate: Timestamp;
|
352
418
|
}
|
419
|
+
export interface CreateStateMachineAliasInput {
|
420
|
+
/**
|
421
|
+
* A description for the state machine alias.
|
422
|
+
*/
|
423
|
+
description?: AliasDescription;
|
424
|
+
/**
|
425
|
+
* The name of the state machine alias. To avoid conflict with version ARNs, don't use an integer in the name of the alias.
|
426
|
+
*/
|
427
|
+
name: CharacterRestrictedName;
|
428
|
+
/**
|
429
|
+
* The routing configuration of a state machine alias. The routing configuration shifts execution traffic between two state machine versions. routingConfiguration contains an array of RoutingConfig objects that specify up to two state machine versions. Step Functions then randomly choses which version to run an execution with based on the weight assigned to each RoutingConfig.
|
430
|
+
*/
|
431
|
+
routingConfiguration: RoutingConfigurationList;
|
432
|
+
}
|
433
|
+
export interface CreateStateMachineAliasOutput {
|
434
|
+
/**
|
435
|
+
* The Amazon Resource Name (ARN) that identifies the created state machine alias.
|
436
|
+
*/
|
437
|
+
stateMachineAliasArn: Arn;
|
438
|
+
/**
|
439
|
+
* The date the state machine alias was created.
|
440
|
+
*/
|
441
|
+
creationDate: Timestamp;
|
442
|
+
}
|
353
443
|
export interface CreateStateMachineInput {
|
354
444
|
/**
|
355
445
|
* The name of the state machine. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
|
@@ -379,6 +469,14 @@ declare namespace StepFunctions {
|
|
379
469
|
* Selects whether X-Ray tracing is enabled.
|
380
470
|
*/
|
381
471
|
tracingConfiguration?: TracingConfiguration;
|
472
|
+
/**
|
473
|
+
* Set to true to publish the first version of the state machine during creation. The default is false.
|
474
|
+
*/
|
475
|
+
publish?: Publish;
|
476
|
+
/**
|
477
|
+
* Sets description about the state machine version. You can only set the description if the publish parameter is set to true. Otherwise, if you set versionDescription, but publish to false, this API action throws ValidationException.
|
478
|
+
*/
|
479
|
+
versionDescription?: VersionDescription;
|
382
480
|
}
|
383
481
|
export interface CreateStateMachineOutput {
|
384
482
|
/**
|
@@ -389,6 +487,10 @@ declare namespace StepFunctions {
|
|
389
487
|
* The date the state machine is created.
|
390
488
|
*/
|
391
489
|
creationDate: Timestamp;
|
490
|
+
/**
|
491
|
+
* The Amazon Resource Name (ARN) that identifies the created state machine version. If you do not set the publish parameter to true, this field returns null value.
|
492
|
+
*/
|
493
|
+
stateMachineVersionArn?: Arn;
|
392
494
|
}
|
393
495
|
export type Definition = string;
|
394
496
|
export interface DeleteActivityInput {
|
@@ -399,6 +501,14 @@ declare namespace StepFunctions {
|
|
399
501
|
}
|
400
502
|
export interface DeleteActivityOutput {
|
401
503
|
}
|
504
|
+
export interface DeleteStateMachineAliasInput {
|
505
|
+
/**
|
506
|
+
* The Amazon Resource Name (ARN) of the state machine alias to delete.
|
507
|
+
*/
|
508
|
+
stateMachineAliasArn: Arn;
|
509
|
+
}
|
510
|
+
export interface DeleteStateMachineAliasOutput {
|
511
|
+
}
|
402
512
|
export interface DeleteStateMachineInput {
|
403
513
|
/**
|
404
514
|
* The Amazon Resource Name (ARN) of the state machine to delete.
|
@@ -407,6 +517,14 @@ declare namespace StepFunctions {
|
|
407
517
|
}
|
408
518
|
export interface DeleteStateMachineOutput {
|
409
519
|
}
|
520
|
+
export interface DeleteStateMachineVersionInput {
|
521
|
+
/**
|
522
|
+
* The Amazon Resource Name (ARN) of the state machine version to delete.
|
523
|
+
*/
|
524
|
+
stateMachineVersionArn: LongArn;
|
525
|
+
}
|
526
|
+
export interface DeleteStateMachineVersionOutput {
|
527
|
+
}
|
410
528
|
export interface DescribeActivityInput {
|
411
529
|
/**
|
412
530
|
* The Amazon Resource Name (ARN) of the activity to describe.
|
@@ -455,7 +573,7 @@ declare namespace StepFunctions {
|
|
455
573
|
*/
|
456
574
|
startDate: Timestamp;
|
457
575
|
/**
|
458
|
-
* If the execution
|
576
|
+
* If the execution ended, the date the execution stopped.
|
459
577
|
*/
|
460
578
|
stopDate?: Timestamp;
|
461
579
|
/**
|
@@ -484,6 +602,14 @@ declare namespace StepFunctions {
|
|
484
602
|
* The cause string if the state machine execution failed.
|
485
603
|
*/
|
486
604
|
cause?: SensitiveCause;
|
605
|
+
/**
|
606
|
+
* The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1. If you start an execution from a StartExecution request without specifying a state machine version or alias ARN, Step Functions returns a null value.
|
607
|
+
*/
|
608
|
+
stateMachineVersionArn?: Arn;
|
609
|
+
/**
|
610
|
+
* The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD. If you start an execution from a StartExecution request with a state machine version ARN, this field will be null.
|
611
|
+
*/
|
612
|
+
stateMachineAliasArn?: Arn;
|
487
613
|
}
|
488
614
|
export interface DescribeMapRunInput {
|
489
615
|
/**
|
@@ -533,6 +659,38 @@ declare namespace StepFunctions {
|
|
533
659
|
*/
|
534
660
|
executionCounts: MapRunExecutionCounts;
|
535
661
|
}
|
662
|
+
export interface DescribeStateMachineAliasInput {
|
663
|
+
/**
|
664
|
+
* The Amazon Resource Name (ARN) of the state machine alias.
|
665
|
+
*/
|
666
|
+
stateMachineAliasArn: Arn;
|
667
|
+
}
|
668
|
+
export interface DescribeStateMachineAliasOutput {
|
669
|
+
/**
|
670
|
+
* The Amazon Resource Name (ARN) of the state machine alias.
|
671
|
+
*/
|
672
|
+
stateMachineAliasArn?: Arn;
|
673
|
+
/**
|
674
|
+
* The name of the state machine alias.
|
675
|
+
*/
|
676
|
+
name?: Name;
|
677
|
+
/**
|
678
|
+
* A description of the alias.
|
679
|
+
*/
|
680
|
+
description?: AliasDescription;
|
681
|
+
/**
|
682
|
+
* The routing configuration of the alias.
|
683
|
+
*/
|
684
|
+
routingConfiguration?: RoutingConfigurationList;
|
685
|
+
/**
|
686
|
+
* The date the state machine alias was created.
|
687
|
+
*/
|
688
|
+
creationDate?: Timestamp;
|
689
|
+
/**
|
690
|
+
* The date the state machine alias was last updated. For a newly created state machine, this is the same as the creation date.
|
691
|
+
*/
|
692
|
+
updateDate?: Timestamp;
|
693
|
+
}
|
536
694
|
export interface DescribeStateMachineForExecutionInput {
|
537
695
|
/**
|
538
696
|
* The Amazon Resource Name (ARN) of the execution you want state machine information for.
|
@@ -573,16 +731,20 @@ declare namespace StepFunctions {
|
|
573
731
|
* A user-defined or an auto-generated string that identifies a Map state. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.
|
574
732
|
*/
|
575
733
|
label?: MapRunLabel;
|
734
|
+
/**
|
735
|
+
* The revision identifier for the state machine. The first revision ID when you create the state machine is null. Use the state machine revisionId parameter to compare the revision of a state machine with the configuration of the state machine used for executions without performing a diff of the properties, such as definition and roleArn.
|
736
|
+
*/
|
737
|
+
revisionId?: RevisionId;
|
576
738
|
}
|
577
739
|
export interface DescribeStateMachineInput {
|
578
740
|
/**
|
579
|
-
* The Amazon Resource Name (ARN) of the state machine
|
741
|
+
* The Amazon Resource Name (ARN) of the state machine for which you want the information. If you specify a state machine version ARN, this API returns details about that version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.
|
580
742
|
*/
|
581
743
|
stateMachineArn: Arn;
|
582
744
|
}
|
583
745
|
export interface DescribeStateMachineOutput {
|
584
746
|
/**
|
585
|
-
* The Amazon Resource Name (ARN) that identifies the state machine.
|
747
|
+
* The Amazon Resource Name (ARN) that identifies the state machine. If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.
|
586
748
|
*/
|
587
749
|
stateMachineArn: Arn;
|
588
750
|
/**
|
@@ -606,7 +768,7 @@ declare namespace StepFunctions {
|
|
606
768
|
*/
|
607
769
|
type: StateMachineType;
|
608
770
|
/**
|
609
|
-
* The date the state machine is created.
|
771
|
+
* The date the state machine is created. For a state machine version, creationDate is the date the version was created.
|
610
772
|
*/
|
611
773
|
creationDate: Timestamp;
|
612
774
|
loggingConfiguration?: LoggingConfiguration;
|
@@ -618,6 +780,14 @@ declare namespace StepFunctions {
|
|
618
780
|
* A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN.
|
619
781
|
*/
|
620
782
|
label?: MapRunLabel;
|
783
|
+
/**
|
784
|
+
* The revision identifier for the state machine. Use the revisionId parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as definition and roleArn.
|
785
|
+
*/
|
786
|
+
revisionId?: RevisionId;
|
787
|
+
/**
|
788
|
+
* The description of the state machine version.
|
789
|
+
*/
|
790
|
+
description?: VersionDescription;
|
621
791
|
}
|
622
792
|
export type Enabled = boolean;
|
623
793
|
export type EventId = number;
|
@@ -648,7 +818,7 @@ declare namespace StepFunctions {
|
|
648
818
|
*/
|
649
819
|
executionArn: Arn;
|
650
820
|
/**
|
651
|
-
* The Amazon Resource Name (ARN) of the
|
821
|
+
* The Amazon Resource Name (ARN) of the state machine that ran the execution.
|
652
822
|
*/
|
653
823
|
stateMachineArn: Arn;
|
654
824
|
/**
|
@@ -675,6 +845,14 @@ declare namespace StepFunctions {
|
|
675
845
|
* The total number of items processed in a child workflow execution. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the itemCount field isn't returned.
|
676
846
|
*/
|
677
847
|
itemCount?: UnsignedInteger;
|
848
|
+
/**
|
849
|
+
* The Amazon Resource Name (ARN) of the state machine version associated with the execution. If the state machine execution was started with an unqualified ARN, it returns null. If the execution was started using a stateMachineAliasArn, both the stateMachineAliasArn and stateMachineVersionArn parameters contain the respective values.
|
850
|
+
*/
|
851
|
+
stateMachineVersionArn?: Arn;
|
852
|
+
/**
|
853
|
+
* The Amazon Resource Name (ARN) of the state machine alias used to start an execution. If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.
|
854
|
+
*/
|
855
|
+
stateMachineAliasArn?: Arn;
|
678
856
|
}
|
679
857
|
export interface ExecutionStartedEventDetails {
|
680
858
|
/**
|
@@ -689,6 +867,14 @@ declare namespace StepFunctions {
|
|
689
867
|
* The Amazon Resource Name (ARN) of the IAM role used for executing Lambda tasks.
|
690
868
|
*/
|
691
869
|
roleArn?: Arn;
|
870
|
+
/**
|
871
|
+
* The Amazon Resource Name (ARN) that identifies a state machine alias used for starting the state machine execution.
|
872
|
+
*/
|
873
|
+
stateMachineAliasArn?: Arn;
|
874
|
+
/**
|
875
|
+
* The Amazon Resource Name (ARN) that identifies a state machine version used for starting the state machine execution.
|
876
|
+
*/
|
877
|
+
stateMachineVersionArn?: Arn;
|
692
878
|
}
|
693
879
|
export type ExecutionStatus = "RUNNING"|"SUCCEEDED"|"FAILED"|"TIMED_OUT"|"ABORTED"|string;
|
694
880
|
export interface ExecutionSucceededEventDetails {
|
@@ -974,7 +1160,7 @@ declare namespace StepFunctions {
|
|
974
1160
|
}
|
975
1161
|
export interface ListExecutionsInput {
|
976
1162
|
/**
|
977
|
-
* The Amazon Resource Name (ARN) of the state machine whose executions is listed. You can specify either a mapRunArn or a stateMachineArn, but not both.
|
1163
|
+
* The Amazon Resource Name (ARN) of the state machine whose executions is listed. You can specify either a mapRunArn or a stateMachineArn, but not both. You can also return a list of executions associated with a specific alias or version, by specifying an alias ARN or a version ARN in the stateMachineArn parameter.
|
978
1164
|
*/
|
979
1165
|
stateMachineArn?: Arn;
|
980
1166
|
/**
|
@@ -1029,6 +1215,54 @@ declare namespace StepFunctions {
|
|
1029
1215
|
*/
|
1030
1216
|
nextToken?: PageToken;
|
1031
1217
|
}
|
1218
|
+
export interface ListStateMachineAliasesInput {
|
1219
|
+
/**
|
1220
|
+
* The Amazon Resource Name (ARN) of the state machine for which you want to list aliases. If you specify a state machine version ARN, this API returns a list of aliases for that version.
|
1221
|
+
*/
|
1222
|
+
stateMachineArn: Arn;
|
1223
|
+
/**
|
1224
|
+
* If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. 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 HTTP 400 InvalidToken error.
|
1225
|
+
*/
|
1226
|
+
nextToken?: PageToken;
|
1227
|
+
/**
|
1228
|
+
* The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
|
1229
|
+
*/
|
1230
|
+
maxResults?: PageSize;
|
1231
|
+
}
|
1232
|
+
export interface ListStateMachineAliasesOutput {
|
1233
|
+
/**
|
1234
|
+
* Aliases for the state machine.
|
1235
|
+
*/
|
1236
|
+
stateMachineAliases: StateMachineAliasList;
|
1237
|
+
/**
|
1238
|
+
* If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. 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 HTTP 400 InvalidToken error.
|
1239
|
+
*/
|
1240
|
+
nextToken?: PageToken;
|
1241
|
+
}
|
1242
|
+
export interface ListStateMachineVersionsInput {
|
1243
|
+
/**
|
1244
|
+
* The Amazon Resource Name (ARN) of the state machine.
|
1245
|
+
*/
|
1246
|
+
stateMachineArn: Arn;
|
1247
|
+
/**
|
1248
|
+
* If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. 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 HTTP 400 InvalidToken error.
|
1249
|
+
*/
|
1250
|
+
nextToken?: PageToken;
|
1251
|
+
/**
|
1252
|
+
* The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
|
1253
|
+
*/
|
1254
|
+
maxResults?: PageSize;
|
1255
|
+
}
|
1256
|
+
export interface ListStateMachineVersionsOutput {
|
1257
|
+
/**
|
1258
|
+
* Versions for the state machine.
|
1259
|
+
*/
|
1260
|
+
stateMachineVersions: StateMachineVersionList;
|
1261
|
+
/**
|
1262
|
+
* If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. 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 HTTP 400 InvalidToken error.
|
1263
|
+
*/
|
1264
|
+
nextToken?: PageToken;
|
1265
|
+
}
|
1032
1266
|
export interface ListStateMachinesInput {
|
1033
1267
|
/**
|
1034
1268
|
* The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
|
@@ -1210,7 +1444,44 @@ declare namespace StepFunctions {
|
|
1210
1444
|
export type Name = string;
|
1211
1445
|
export type PageSize = number;
|
1212
1446
|
export type PageToken = string;
|
1447
|
+
export type Publish = boolean;
|
1448
|
+
export interface PublishStateMachineVersionInput {
|
1449
|
+
/**
|
1450
|
+
* The Amazon Resource Name (ARN) of the state machine.
|
1451
|
+
*/
|
1452
|
+
stateMachineArn: Arn;
|
1453
|
+
/**
|
1454
|
+
* Only publish the state machine version if the current state machine's revision ID matches the specified ID. Use this option to avoid publishing a version if the state machine changed since you last updated it. If the specified revision ID doesn't match the state machine's current revision ID, the API returns ConflictException. To specify an initial revision ID for a state machine with no revision ID assigned, specify the string INITIAL for the revisionId parameter. For example, you can specify a revisionID of INITIAL when you create a state machine using the CreateStateMachine API action.
|
1455
|
+
*/
|
1456
|
+
revisionId?: RevisionId;
|
1457
|
+
/**
|
1458
|
+
* An optional description of the state machine version.
|
1459
|
+
*/
|
1460
|
+
description?: VersionDescription;
|
1461
|
+
}
|
1462
|
+
export interface PublishStateMachineVersionOutput {
|
1463
|
+
/**
|
1464
|
+
* The date the version was created.
|
1465
|
+
*/
|
1466
|
+
creationDate: Timestamp;
|
1467
|
+
/**
|
1468
|
+
* The Amazon Resource Name (ARN) (ARN) that identifies the state machine version.
|
1469
|
+
*/
|
1470
|
+
stateMachineVersionArn: Arn;
|
1471
|
+
}
|
1213
1472
|
export type ReverseOrder = boolean;
|
1473
|
+
export type RevisionId = string;
|
1474
|
+
export type RoutingConfigurationList = RoutingConfigurationListItem[];
|
1475
|
+
export interface RoutingConfigurationListItem {
|
1476
|
+
/**
|
1477
|
+
* The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration. If you specify the ARN of a second version, it must belong to the same state machine as the first version.
|
1478
|
+
*/
|
1479
|
+
stateMachineVersionArn: Arn;
|
1480
|
+
/**
|
1481
|
+
* The percentage of traffic you want to route to the second state machine version. The sum of the weights in the routing configuration must be equal to 100.
|
1482
|
+
*/
|
1483
|
+
weight: VersionWeight;
|
1484
|
+
}
|
1214
1485
|
export interface SendTaskFailureInput {
|
1215
1486
|
/**
|
1216
1487
|
* The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
|
@@ -1253,11 +1524,11 @@ declare namespace StepFunctions {
|
|
1253
1524
|
export type SensitiveError = string;
|
1254
1525
|
export interface StartExecutionInput {
|
1255
1526
|
/**
|
1256
|
-
* The Amazon Resource Name (ARN) of the state machine to execute.
|
1527
|
+
* The Amazon Resource Name (ARN) of the state machine to execute. The stateMachineArn parameter accepts one of the following inputs: An unqualified state machine ARN – Refers to a state machine ARN that isn't qualified with a version or alias ARN. The following is an example of an unqualified state machine ARN. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> Step Functions doesn't associate state machine executions that you start with an unqualified ARN with a version. This is true even if that version uses the same revision that the execution used. A state machine version ARN – Refers to a version ARN, which is a combination of state machine ARN and the version number separated by a colon (:). The following is an example of the ARN for version 10. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10 Step Functions doesn't associate executions that you start with a version ARN with any aliases that point to that version. A state machine alias ARN – Refers to an alias ARN, which is a combination of state machine ARN and the alias name separated by a colon (:). The following is an example of the ARN for an alias named PROD. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> Step Functions associates executions that you start with an alias ARN with that alias and the state machine version used for that execution.
|
1257
1528
|
*/
|
1258
1529
|
stateMachineArn: Arn;
|
1259
1530
|
/**
|
1260
|
-
*
|
1531
|
+
* Optional name of the execution. This name must be unique for your Amazon Web Services account, Region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the Step Functions Developer Guide. A name must not contain: white space brackets < > { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F) To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
|
1261
1532
|
*/
|
1262
1533
|
name?: Name;
|
1263
1534
|
/**
|
@@ -1377,6 +1648,17 @@ declare namespace StepFunctions {
|
|
1377
1648
|
*/
|
1378
1649
|
outputDetails?: HistoryEventExecutionDataDetails;
|
1379
1650
|
}
|
1651
|
+
export type StateMachineAliasList = StateMachineAliasListItem[];
|
1652
|
+
export interface StateMachineAliasListItem {
|
1653
|
+
/**
|
1654
|
+
* The Amazon Resource Name (ARN) that identifies a state machine alias. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.
|
1655
|
+
*/
|
1656
|
+
stateMachineAliasArn: LongArn;
|
1657
|
+
/**
|
1658
|
+
* The creation date of a state machine alias.
|
1659
|
+
*/
|
1660
|
+
creationDate: Timestamp;
|
1661
|
+
}
|
1380
1662
|
export type StateMachineList = StateMachineListItem[];
|
1381
1663
|
export interface StateMachineListItem {
|
1382
1664
|
/**
|
@@ -1398,6 +1680,17 @@ declare namespace StepFunctions {
|
|
1398
1680
|
}
|
1399
1681
|
export type StateMachineStatus = "ACTIVE"|"DELETING"|string;
|
1400
1682
|
export type StateMachineType = "STANDARD"|"EXPRESS"|string;
|
1683
|
+
export type StateMachineVersionList = StateMachineVersionListItem[];
|
1684
|
+
export interface StateMachineVersionListItem {
|
1685
|
+
/**
|
1686
|
+
* The Amazon Resource Name (ARN) that identifies a state machine version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.
|
1687
|
+
*/
|
1688
|
+
stateMachineVersionArn: LongArn;
|
1689
|
+
/**
|
1690
|
+
* The creation date of a state machine version.
|
1691
|
+
*/
|
1692
|
+
creationDate: Timestamp;
|
1693
|
+
}
|
1401
1694
|
export interface StopExecutionInput {
|
1402
1695
|
/**
|
1403
1696
|
* The Amazon Resource Name (ARN) of the execution to stop.
|
@@ -1645,6 +1938,26 @@ declare namespace StepFunctions {
|
|
1645
1938
|
}
|
1646
1939
|
export interface UpdateMapRunOutput {
|
1647
1940
|
}
|
1941
|
+
export interface UpdateStateMachineAliasInput {
|
1942
|
+
/**
|
1943
|
+
* The Amazon Resource Name (ARN) of the state machine alias.
|
1944
|
+
*/
|
1945
|
+
stateMachineAliasArn: Arn;
|
1946
|
+
/**
|
1947
|
+
* A description of the state machine alias.
|
1948
|
+
*/
|
1949
|
+
description?: AliasDescription;
|
1950
|
+
/**
|
1951
|
+
* The routing configuration of the state machine alias. An array of RoutingConfig objects that specifies up to two state machine versions that the alias starts executions for.
|
1952
|
+
*/
|
1953
|
+
routingConfiguration?: RoutingConfigurationList;
|
1954
|
+
}
|
1955
|
+
export interface UpdateStateMachineAliasOutput {
|
1956
|
+
/**
|
1957
|
+
* The date and time the state machine alias was updated.
|
1958
|
+
*/
|
1959
|
+
updateDate: Timestamp;
|
1960
|
+
}
|
1648
1961
|
export interface UpdateStateMachineInput {
|
1649
1962
|
/**
|
1650
1963
|
* The Amazon Resource Name (ARN) of the state machine.
|
@@ -1659,20 +1972,38 @@ declare namespace StepFunctions {
|
|
1659
1972
|
*/
|
1660
1973
|
roleArn?: Arn;
|
1661
1974
|
/**
|
1662
|
-
*
|
1975
|
+
* Use the LoggingConfiguration data type to set CloudWatch Logs options.
|
1663
1976
|
*/
|
1664
1977
|
loggingConfiguration?: LoggingConfiguration;
|
1665
1978
|
/**
|
1666
1979
|
* Selects whether X-Ray tracing is enabled.
|
1667
1980
|
*/
|
1668
1981
|
tracingConfiguration?: TracingConfiguration;
|
1982
|
+
/**
|
1983
|
+
* Specifies whether the state machine version is published. The default is false. To publish a version after updating the state machine, set publish to true.
|
1984
|
+
*/
|
1985
|
+
publish?: Publish;
|
1986
|
+
/**
|
1987
|
+
* An optional description of the state machine version to publish. You can only specify the versionDescription parameter if you've set publish to true.
|
1988
|
+
*/
|
1989
|
+
versionDescription?: VersionDescription;
|
1669
1990
|
}
|
1670
1991
|
export interface UpdateStateMachineOutput {
|
1671
1992
|
/**
|
1672
1993
|
* The date and time the state machine was updated.
|
1673
1994
|
*/
|
1674
1995
|
updateDate: Timestamp;
|
1996
|
+
/**
|
1997
|
+
* The revision identifier for the updated state machine.
|
1998
|
+
*/
|
1999
|
+
revisionId?: RevisionId;
|
2000
|
+
/**
|
2001
|
+
* The Amazon Resource Name (ARN) of the published state machine version. If the publish parameter isn't set to true, this field returns null.
|
2002
|
+
*/
|
2003
|
+
stateMachineVersionArn?: Arn;
|
1675
2004
|
}
|
2005
|
+
export type VersionDescription = string;
|
2006
|
+
export type VersionWeight = number;
|
1676
2007
|
export type includedDetails = boolean;
|
1677
2008
|
export type truncated = boolean;
|
1678
2009
|
/**
|