Skip to content

Commit d933717

Browse files
Update generated code (#1460)
* update generated code * Update src/Service/StepFunctions/CHANGELOG.md --------- Co-authored-by: Jérémy Derussé <[email protected]>
1 parent 8496395 commit d933717

File tree

4 files changed

+71
-13
lines changed

4 files changed

+71
-13
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
## NOT RELEASED
44

5+
### Added
6+
7+
- AWS api-change: Adding `INVALID_ROUTING_CONFIGURATION` reason to ValidationExceptionReason enum
8+
59
## 1.1.0
610

711
### Added

src/Enum/ValidationExceptionReason.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@ final class ValidationExceptionReason
66
{
77
public const API_DOES_NOT_SUPPORT_LABELED_ARNS = 'API_DOES_NOT_SUPPORT_LABELED_ARNS';
88
public const CANNOT_UPDATE_COMPLETED_MAP_RUN = 'CANNOT_UPDATE_COMPLETED_MAP_RUN';
9+
public const INVALID_ROUTING_CONFIGURATION = 'INVALID_ROUTING_CONFIGURATION';
910
public const MISSING_REQUIRED_PARAMETER = 'MISSING_REQUIRED_PARAMETER';
1011

1112
public static function exists(string $value): bool
1213
{
1314
return isset([
1415
self::API_DOES_NOT_SUPPORT_LABELED_ARNS => true,
1516
self::CANNOT_UPDATE_COMPLETED_MAP_RUN => true,
17+
self::INVALID_ROUTING_CONFIGURATION => true,
1618
self::MISSING_REQUIRED_PARAMETER => true,
1719
][$value]);
1820
}

src/Input/StartExecutionInput.php

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,40 @@ final class StartExecutionInput extends Input
1212
/**
1313
* The Amazon Resource Name (ARN) of the state machine to execute.
1414
*
15+
* The `stateMachineArn` parameter accepts one of the following inputs:
16+
*
17+
* - **An unqualified state machine ARN** – Refers to a state machine ARN that isn't qualified with a version or alias
18+
* ARN. The following is an example of an unqualified state machine ARN.
19+
*
20+
* `arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>`
21+
*
22+
* Step Functions doesn't associate state machine executions that you start with an unqualified ARN with a version.
23+
* This is true even if that version uses the same revision that the execution used.
24+
* - **A state machine version ARN** – Refers to a version ARN, which is a combination of state machine ARN and the
25+
* version number separated by a colon (:). The following is an example of the ARN for version 10.
26+
*
27+
* `arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10`
28+
*
29+
* Step Functions doesn't associate executions that you start with a version ARN with any aliases that point to that
30+
* version.
31+
* - **A state machine alias ARN** – Refers to an alias ARN, which is a combination of state machine ARN and the alias
32+
* name separated by a colon (:). The following is an example of the ARN for an alias named `PROD`.
33+
*
34+
* `arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>`
35+
*
36+
* Step Functions associates executions that you start with an alias ARN with that alias and the state machine version
37+
* used for that execution.
38+
*
1539
* @required
1640
*
1741
* @var string|null
1842
*/
1943
private $stateMachineArn;
2044

2145
/**
22-
* The name of the execution. This name must be unique for your Amazon Web Services account, region, and state machine
23-
* for 90 days. For more information, see Limits Related to State Machine Executions [^1] in the *Step Functions
24-
* Developer Guide*.
46+
* Optional name of the execution. This name must be unique for your Amazon Web Services account, Region, and state
47+
* machine for 90 days. For more information, see Limits Related to State Machine Executions [^1] in the *Step
48+
* Functions Developer Guide*.
2549
*
2650
* A name must *not* contain:
2751
*

src/StepFunctionsClient.php

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -142,19 +142,47 @@ public function sendTaskSuccess($input): SendTaskSuccessOutput
142142
}
143143

144144
/**
145-
* Starts a state machine execution. If the given state machine Amazon Resource Name (ARN) is a qualified state machine
146-
* ARN, it will fail with ValidationException.
145+
* Starts a state machine execution.
147146
*
148-
* A qualified state machine ARN refers to a *Distributed Map state* defined within a state machine. For example, the
149-
* qualified state machine ARN `arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel`
150-
* refers to a *Distributed Map state* with a label `mapStateLabel` in the state machine named `stateMachineName`.
147+
* A qualified state machine ARN can either refer to a *Distributed Map state* defined within a state machine, a version
148+
* ARN, or an alias ARN.
151149
*
152-
* > `StartExecution` is idempotent for `STANDARD` workflows. For a `STANDARD` workflow, if `StartExecution` is called
153-
* > with the same name and input as a running execution, the call will succeed and return the same response as the
154-
* > original request. If the execution is closed or if the input is different, it will return a `400
155-
* > ExecutionAlreadyExists` error. Names can be reused after 90 days.
150+
* The following are some examples of qualified and unqualified state machine ARNs:
151+
*
152+
* - The following qualified state machine ARN refers to a *Distributed Map state* with a label `mapStateLabel` in a
153+
* state machine named `myStateMachine`.
154+
*
155+
* `arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel`
156+
*
157+
* > If you provide a qualified state machine ARN that refers to a *Distributed Map state*, the request fails with
158+
* > `ValidationException`.
159+
*
160+
* - The following qualified state machine ARN refers to an alias named `PROD`.
161+
*
162+
* `arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>`
163+
*
164+
* > If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts
165+
* > execution for that version or alias.
166+
*
167+
* - The following unqualified state machine ARN refers to a state machine named `myStateMachine`.
168+
*
169+
* `arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>`
170+
*
171+
* If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state
172+
* machine for the execution.
173+
*
174+
* To start executions of a state machine version [^1], call `StartExecution` and provide the version ARN or the ARN of
175+
* an alias [^2] that points to the version.
176+
*
177+
* > `StartExecution` is idempotent for `STANDARD` workflows. For a `STANDARD` workflow, if you call `StartExecution`
178+
* > with the same name and input as a running execution, the call succeeds and return the same response as the original
179+
* > request. If the execution is closed or if the input is different, it returns a `400 ExecutionAlreadyExists` error.
180+
* > You can reuse names after 90 days.
156181
* >
157-
* > `StartExecution` is not idempotent for `EXPRESS` workflows.
182+
* > `StartExecution` isn't idempotent for `EXPRESS` workflows.
183+
*
184+
* [^1]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html
185+
* [^2]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html
158186
*
159187
* @see https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html
160188
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-states-2016-11-23.html#startexecution

0 commit comments

Comments
 (0)