Comments (3)
lmmx
commented on September 26, 2024
Succeeded.
I suspect the differences arise from the differing versions of the SDK (the botocore was explicitly tied to v1.29.90 whereas JS SDK may be later? Though I expected they'd match because the 2016-11-23 date was the same...).
Some example observations:
ConflictExceptionin JS, not in boto (one of the error responses to CreateStateMachine, on 491, or on 485 to CreateStateMachineAlias, suggesting it's related to state machine aliases in the older version of boto)TaskDoesNotExistdestubbed in botoInvalidOutputdestubbed in botoValidationExceptionReasonin boto, not in JS
Click to show full diff:
171c171
< description: '<p>Creates a state machine. A state machine consists of a collection of states that can do work (<code>Task</code> states), determine to which states to transition next (<code>Choice</code> states), stop an execution with an error (<code>Fail</code> states), and so on. State machines are specified using a JSON-based, structured language. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a> in the Step Functions User Guide.</p> <p>If you set the <code>publish</code> parameter of this API action to <code>true</code>, it publishes version <code>1</code> as the first revision of the state machine.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <note> <p> <code>CreateStateMachine</code> is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. <code>CreateStateMachine</code>''s idempotency check is based on the state machine <code>name</code>, <code>definition</code>, <code>type</code>, <code>LoggingConfiguration</code>, and <code>TracingConfiguration</code>. The check is also based on the <code>publish</code> and <code>versionDescription</code> parameters. If a following request has a different <code>roleArn</code> or <code>tags</code>, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, <code>roleArn</code> and <code>tags</code> will not be updated, even if they are different.</p> </note>'
---
> description: '<p>Creates a state machine. A state machine consists of a collection of states that can do work (<code>Task</code> states), determine to which states to transition next (<code>Choice</code> states), stop an execution with an error (<code>Fail</code> states), and so on. State machines are specified using a JSON-based, structured language. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a> in the Step Functions User Guide.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <note> <p> <code>CreateStateMachine</code> is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. <code>CreateStateMachine</code>''s idempotency check is based on the state machine <code>name</code>, <code>definition</code>, <code>type</code>, <code>LoggingConfiguration</code> and <code>TracingConfiguration</code>. If a following request has a different <code>roleArn</code> or <code>tags</code>, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, <code>roleArn</code> and <code>tags</code> will not be updated, even if they are different.</p> </note>'
239,250d238
< '490':
< description: ValidationException
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ValidationException'
< '491':
< description: ConflictException
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ConflictException'
273,347d260
< /#X-Amz-Target=AWSStepFunctions.CreateStateMachineAlias:
< post:
< operationId: CreateStateMachineAlias
< description: '<p>Creates an <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> for a state machine that points to one or two <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">versions</a> of the same state machine. You can set your application to call <a>StartExecution</a> with an alias and update the version the alias uses without changing the client''s code.</p> <p>You can also map an alias to split <a>StartExecution</a> requests between two versions of a state machine. To do this, add a second <code>RoutingConfig</code> object in the <code>routingConfiguration</code> parameter. You must also specify the percentage of execution run requests each version should receive in both <code>RoutingConfig</code> objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify.</p> <p>To create an alias that points to a single version, specify a single <code>RoutingConfig</code> object with a <code>weight</code> set to 100.</p> <p>You can create up to 100 aliases for each state machine. You must delete unused aliases using the <a>DeleteStateMachineAlias</a> API action.</p> <p> <code>CreateStateMachineAlias</code> is an idempotent API. Step Functions bases the idempotency check on the <code>stateMachineArn</code>, <code>description</code>, <code>name</code>, and <code>routingConfiguration</code> parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>DescribeStateMachineAlias</a> </p> </li> <li> <p> <a>ListStateMachineAliases</a> </p> </li> <li> <p> <a>UpdateStateMachineAlias</a> </p> </li> <li> <p> <a>DeleteStateMachineAlias</a> </p> </li> </ul>'
< responses:
< '200':
< description: Success
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/CreateStateMachineAliasOutput'
< '480':
< description: InvalidArn
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/InvalidArn'
< '481':
< description: InvalidName
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/InvalidName'
< '482':
< description: ValidationException
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ValidationException'
< '483':
< description: StateMachineDeleting
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/StateMachineDeleting'
< '484':
< description: ResourceNotFound
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ResourceNotFound'
< '485':
< description: ConflictException
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ConflictException'
< '486':
< description: ServiceQuotaExceededException
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ServiceQuotaExceededException'
< requestBody:
< required: true
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/CreateStateMachineAliasInput'
< parameters:
< - name: X-Amz-Target
< in: header
< required: true
< schema:
< type: string
< enum:
< - AWSStepFunctions.CreateStateMachineAlias
< parameters:
< - $ref: '#/components/parameters/X-Amz-Content-Sha256'
< - $ref: '#/components/parameters/X-Amz-Date'
< - $ref: '#/components/parameters/X-Amz-Algorithm'
< - $ref: '#/components/parameters/X-Amz-Credential'
< - $ref: '#/components/parameters/X-Amz-Security-Token'
< - $ref: '#/components/parameters/X-Amz-Signature'
< - $ref: '#/components/parameters/X-Amz-SignedHeaders'
390c303
< description: '<p>Deletes a state machine. This is an asynchronous operation: It sets the state machine''s status to <code>DELETING</code> and begins the deletion process. </p> <p>A qualified state machine ARN can either refer to a <i>Distributed Map state</i> defined within a state machine, a version ARN, or an alias ARN.</p> <p>The following are some examples of qualified and unqualified state machine ARNs:</p> <ul> <li> <p>The following qualified state machine ARN refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in a state machine named <code>myStateMachine</code>.</p> <p> <code>arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel</code> </p> <note> <p>If you provide a qualified state machine ARN that refers to a <i>Distributed Map state</i>, the request fails with <code>ValidationException</code>.</p> </note> </li> <li> <p>The following unqualified state machine ARN refers to a state machine named <code>myStateMachine</code>.</p> <p> <code>arn:partition:states:region:account-id:stateMachine:myStateMachine</code> </p> </li> </ul> <p>This API action also deletes all <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">versions</a> and <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">aliases</a> associated with a state machine.</p> <note> <p>For <code>EXPRESS</code> state machines, the deletion happens eventually (usually in less than a minute). Running executions may emit logs after <code>DeleteStateMachine</code> API is called.</p> </note>'
---
> description: '<p>Deletes a state machine. This is an asynchronous operation: It sets the state machine''s status to <code>DELETING</code> and begins the deletion process. </p> <p>If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.</p> <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> <note> <p>For <code>EXPRESS</code> state machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after <code>DeleteStateMachine</code> API is called.</p> </note>'
432,539d344
< /#X-Amz-Target=AWSStepFunctions.DeleteStateMachineAlias:
< post:
< operationId: DeleteStateMachineAlias
< description: '<p>Deletes a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a>.</p> <p>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.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateStateMachineAlias</a> </p> </li> <li> <p> <a>DescribeStateMachineAlias</a> </p> </li> <li> <p> <a>ListStateMachineAliases</a> </p> </li> <li> <p> <a>UpdateStateMachineAlias</a> </p> </li> </ul>'
< responses:
< '200':
< description: Success
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/DeleteStateMachineAliasOutput'
< '480':
< description: ValidationException
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ValidationException'
< '481':
< description: InvalidArn
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/InvalidArn'
< '482':
< description: ResourceNotFound
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ResourceNotFound'
< '483':
< description: ConflictException
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ConflictException'
< requestBody:
< required: true
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/DeleteStateMachineAliasInput'
< parameters:
< - name: X-Amz-Target
< in: header
< required: true
< schema:
< type: string
< enum:
< - AWSStepFunctions.DeleteStateMachineAlias
< parameters:
< - $ref: '#/components/parameters/X-Amz-Content-Sha256'
< - $ref: '#/components/parameters/X-Amz-Date'
< - $ref: '#/components/parameters/X-Amz-Algorithm'
< - $ref: '#/components/parameters/X-Amz-Credential'
< - $ref: '#/components/parameters/X-Amz-Security-Token'
< - $ref: '#/components/parameters/X-Amz-Signature'
< - $ref: '#/components/parameters/X-Amz-SignedHeaders'
< /#X-Amz-Target=AWSStepFunctions.DeleteStateMachineVersion:
< post:
< operationId: DeleteStateMachineVersion
< description: '<p>Deletes a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>. After you delete a version, you can''t call <a>StartExecution</a> using that version''s ARN or use the version with a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a>.</p> <note> <p>Deleting a state machine version won''t terminate its in-progress executions.</p> </note> <note> <p>You can''t delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version.</p> </note> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>PublishStateMachineVersion</a> </p> </li> <li> <p> <a>ListStateMachineVersions</a> </p> </li> </ul>'
< responses:
< '200':
< description: Success
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/DeleteStateMachineVersionOutput'
< '480':
< description: ValidationException
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ValidationException'
< '481':
< description: InvalidArn
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/InvalidArn'
< '482':
< description: ConflictException
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ConflictException'
< requestBody:
< required: true
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/DeleteStateMachineVersionInput'
< parameters:
< - name: X-Amz-Target
< in: header
< required: true
< schema:
< type: string
< enum:
< - AWSStepFunctions.DeleteStateMachineVersion
< parameters:
< - $ref: '#/components/parameters/X-Amz-Content-Sha256'
< - $ref: '#/components/parameters/X-Amz-Date'
< - $ref: '#/components/parameters/X-Amz-Algorithm'
< - $ref: '#/components/parameters/X-Amz-Credential'
< - $ref: '#/components/parameters/X-Amz-Security-Token'
< - $ref: '#/components/parameters/X-Amz-Signature'
< - $ref: '#/components/parameters/X-Amz-SignedHeaders'
588c393
< description: '<p>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.</p> <p>If you specify a version or alias ARN when you call the <a>StartExecution</a> API action, <code>DescribeExecution</code> returns that ARN.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <p>Executions of an <code>EXPRESS</code> state machinearen''t supported by <code>DescribeExecution</code> unless a Map Run dispatched them.</p>'
---
> description: '<p>Provides all 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 ARN if the execution was dispatched by a Map Run.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <p>This API action is not supported by <code>EXPRESS</code> state machine executions unless they were dispatched by a Map Run.</p>'
678c483
< description: '<p>Provides information about a state machine''s definition, its IAM role Amazon Resource Name (ARN), and configuration.</p> <p>A qualified state machine ARN can either refer to a <i>Distributed Map state</i> defined within a state machine, a version ARN, or an alias ARN.</p> <p>The following are some examples of qualified and unqualified state machine ARNs:</p> <ul> <li> <p>The following qualified state machine ARN refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in a state machine named <code>myStateMachine</code>.</p> <p> <code>arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel</code> </p> <note> <p>If you provide a qualified state machine ARN that refers to a <i>Distributed Map state</i>, the request fails with <code>ValidationException</code>.</p> </note> </li> <li> <p>The following qualified state machine ARN refers to an alias named <code>PROD</code>.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD></code> </p> <note> <p>If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.</p> </note> </li> <li> <p>The following unqualified state machine ARN refers to a state machine named <code>myStateMachine</code>.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine></code> </p> </li> </ul> <p>This API action returns the details for a state machine version if the <code>stateMachineArn</code> you specify is a state machine version ARN.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note>'
---
> description: '<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> <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> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note>'
720,770d524
< /#X-Amz-Target=AWSStepFunctions.DescribeStateMachineAlias:
< post:
< operationId: DescribeStateMachineAlias
< description: '<p>Returns details about a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a>.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateStateMachineAlias</a> </p> </li> <li> <p> <a>ListStateMachineAliases</a> </p> </li> <li> <p> <a>UpdateStateMachineAlias</a> </p> </li> <li> <p> <a>DeleteStateMachineAlias</a> </p> </li> </ul>'
< responses:
< '200':
< description: Success
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/DescribeStateMachineAliasOutput'
< '480':
< description: ValidationException
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ValidationException'
< '481':
< description: InvalidArn
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/InvalidArn'
< '482':
< description: ResourceNotFound
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ResourceNotFound'
< requestBody:
< required: true
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/DescribeStateMachineAliasInput'
< parameters:
< - name: X-Amz-Target
< in: header
< required: true
< schema:
< type: string
< enum:
< - AWSStepFunctions.DescribeStateMachineAlias
< parameters:
< - $ref: '#/components/parameters/X-Amz-Content-Sha256'
< - $ref: '#/components/parameters/X-Amz-Date'
< - $ref: '#/components/parameters/X-Amz-Algorithm'
< - $ref: '#/components/parameters/X-Amz-Credential'
< - $ref: '#/components/parameters/X-Amz-Security-Token'
< - $ref: '#/components/parameters/X-Amz-Signature'
< - $ref: '#/components/parameters/X-Amz-SignedHeaders'
774c528
< description: '<p>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.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>'
---
> description: '<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> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>'
984c738
< description: '<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> <p>You can also provide a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> ARN or <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a> ARN to list the executions associated with a specific alias or version.</p> <p>Results are sorted by time, with the most recent execution first.</p> <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. 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> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>'
---
> description: '<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> <p>Results are sorted by time, with the most recent execution first.</p> <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. 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> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>'
1125,1238d878
< /#X-Amz-Target=AWSStepFunctions.ListStateMachineAliases:
< post:
< operationId: ListStateMachineAliases
< description: '<p>Lists <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">aliases</a> for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first. </p> <p>To list aliases that reference a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>, you can specify the version ARN in the <code>stateMachineArn</code> parameter.</p> <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. 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> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateStateMachineAlias</a> </p> </li> <li> <p> <a>DescribeStateMachineAlias</a> </p> </li> <li> <p> <a>UpdateStateMachineAlias</a> </p> </li> <li> <p> <a>DeleteStateMachineAlias</a> </p> </li> </ul>'
< responses:
< '200':
< description: Success
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ListStateMachineAliasesOutput'
< '480':
< description: InvalidArn
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/InvalidArn'
< '481':
< description: InvalidToken
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/InvalidToken'
< '482':
< description: ResourceNotFound
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ResourceNotFound'
< '483':
< description: StateMachineDoesNotExist
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/StateMachineDoesNotExist'
< '484':
< description: StateMachineDeleting
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/StateMachineDeleting'
< requestBody:
< required: true
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ListStateMachineAliasesInput'
< parameters:
< - name: X-Amz-Target
< in: header
< required: true
< schema:
< type: string
< enum:
< - AWSStepFunctions.ListStateMachineAliases
< parameters:
< - $ref: '#/components/parameters/X-Amz-Content-Sha256'
< - $ref: '#/components/parameters/X-Amz-Date'
< - $ref: '#/components/parameters/X-Amz-Algorithm'
< - $ref: '#/components/parameters/X-Amz-Credential'
< - $ref: '#/components/parameters/X-Amz-Security-Token'
< - $ref: '#/components/parameters/X-Amz-Signature'
< - $ref: '#/components/parameters/X-Amz-SignedHeaders'
< /#X-Amz-Target=AWSStepFunctions.ListStateMachineVersions:
< post:
< operationId: ListStateMachineVersions
< description: '<p>Lists <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">versions</a> for the specified state machine Amazon Resource Name (ARN).</p> <p>The results are sorted in descending order of the version creation time.</p> <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. 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> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>PublishStateMachineVersion</a> </p> </li> <li> <p> <a>DeleteStateMachineVersion</a> </p> </li> </ul>'
< responses:
< '200':
< description: Success
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ListStateMachineVersionsOutput'
< '480':
< description: ValidationException
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ValidationException'
< '481':
< description: InvalidArn
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/InvalidArn'
< '482':
< description: InvalidToken
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/InvalidToken'
< requestBody:
< required: true
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ListStateMachineVersionsInput'
< parameters:
< - name: X-Amz-Target
< in: header
< required: true
< schema:
< type: string
< enum:
< - AWSStepFunctions.ListStateMachineVersions
< parameters:
< - $ref: '#/components/parameters/X-Amz-Content-Sha256'
< - $ref: '#/components/parameters/X-Amz-Date'
< - $ref: '#/components/parameters/X-Amz-Algorithm'
< - $ref: '#/components/parameters/X-Amz-Credential'
< - $ref: '#/components/parameters/X-Amz-Security-Token'
< - $ref: '#/components/parameters/X-Amz-Signature'
< - $ref: '#/components/parameters/X-Amz-SignedHeaders'
1335,1403d974
< /#X-Amz-Target=AWSStepFunctions.PublishStateMachineVersion:
< post:
< operationId: PublishStateMachineVersion
< description: '<p>Creates a <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a> 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 <a>CreateStateMachineAlias</a>.</p> <p>You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the <a>DeleteStateMachineVersion</a> API action.</p> <p> <code>PublishStateMachineVersion</code> is an idempotent API. It doesn''t create a duplicate state machine version if it already exists for the current revision. Step Functions bases <code>PublishStateMachineVersion</code>''s idempotency check on the <code>stateMachineArn</code>, <code>name</code>, and <code>revisionId</code> parameters. Requests with the same parameters return a successful idempotent response. If you don''t specify a <code>revisionId</code>, Step Functions checks for a previously published version of the state machine''s current revision.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>DeleteStateMachineVersion</a> </p> </li> <li> <p> <a>ListStateMachineVersions</a> </p> </li> </ul>'
< responses:
< '200':
< description: Success
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/PublishStateMachineVersionOutput'
< '480':
< description: ValidationException
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ValidationException'
< '481':
< description: StateMachineDeleting
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/StateMachineDeleting'
< '482':
< description: StateMachineDoesNotExist
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/StateMachineDoesNotExist'
< '483':
< description: ServiceQuotaExceededException
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ServiceQuotaExceededException'
< '484':
< description: ConflictException
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ConflictException'
< '485':
< description: InvalidArn
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/InvalidArn'
< requestBody:
< required: true
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/PublishStateMachineVersionInput'
< parameters:
< - name: X-Amz-Target
< in: header
< required: true
< schema:
< type: string
< enum:
< - AWSStepFunctions.PublishStateMachineVersion
< parameters:
< - $ref: '#/components/parameters/X-Amz-Content-Sha256'
< - $ref: '#/components/parameters/X-Amz-Date'
< - $ref: '#/components/parameters/X-Amz-Algorithm'
< - $ref: '#/components/parameters/X-Amz-Credential'
< - $ref: '#/components/parameters/X-Amz-Security-Token'
< - $ref: '#/components/parameters/X-Amz-Signature'
< - $ref: '#/components/parameters/X-Amz-SignedHeaders'
1566c1137
< description: '<p>Starts a state machine execution.</p> <p>A qualified state machine ARN can either refer to a <i>Distributed Map state</i> defined within a state machine, a version ARN, or an alias ARN.</p> <p>The following are some examples of qualified and unqualified state machine ARNs:</p> <ul> <li> <p>The following qualified state machine ARN refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in a state machine named <code>myStateMachine</code>.</p> <p> <code>arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel</code> </p> <note> <p>If you provide a qualified state machine ARN that refers to a <i>Distributed Map state</i>, the request fails with <code>ValidationException</code>.</p> </note> </li> <li> <p>The following qualified state machine ARN refers to an alias named <code>PROD</code>.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD></code> </p> <note> <p>If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.</p> </note> </li> <li> <p>The following unqualified state machine ARN refers to a state machine named <code>myStateMachine</code>.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine></code> </p> </li> </ul> <p>If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution.</p> <p>To start executions of a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>, call <code>StartExecution</code> and provide the version ARN or the ARN of an <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> that points to the version.</p> <note> <p> <code>StartExecution</code> is idempotent for <code>STANDARD</code> workflows. For a <code>STANDARD</code> workflow, if you call <code>StartExecution</code> 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 <code>400 ExecutionAlreadyExists</code> error. You can reuse names after 90 days. </p> <p> <code>StartExecution</code> isn''t idempotent for <code>EXPRESS</code> workflows. </p> </note>'
---
> description: '<p>Starts a state machine execution. If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.</p> <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> <note> <p> <code>StartExecution</code> is idempotent for <code>STANDARD</code> workflows. For a <code>STANDARD</code> workflow, if <code>StartExecution</code> is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a <code>400 ExecutionAlreadyExists</code> error. Names can be reused after 90 days. </p> <p> <code>StartExecution</code> is not idempotent for <code>EXPRESS</code> workflows. </p> </note>'
1914c1485
< description: '<p>Updates an existing state machine by modifying its <code>definition</code>, <code>roleArn</code>, or <code>loggingConfiguration</code>. Running executions will continue to use the previous <code>definition</code> and <code>roleArn</code>. You must include at least one of <code>definition</code> or <code>roleArn</code> or you will receive a <code>MissingRequiredParameter</code> error.</p> <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> <p>A qualified state machine ARN can either refer to a <i>Distributed Map state</i> defined within a state machine, a version ARN, or an alias ARN.</p> <p>The following are some examples of qualified and unqualified state machine ARNs:</p> <ul> <li> <p>The following qualified state machine ARN refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in a state machine named <code>myStateMachine</code>.</p> <p> <code>arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel</code> </p> <note> <p>If you provide a qualified state machine ARN that refers to a <i>Distributed Map state</i>, the request fails with <code>ValidationException</code>.</p> </note> </li> <li> <p>The following qualified state machine ARN refers to an alias named <code>PROD</code>.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD></code> </p> <note> <p>If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.</p> </note> </li> <li> <p>The following unqualified state machine ARN refers to a state machine named <code>myStateMachine</code>.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine></code> </p> </li> </ul> <p>After you update your state machine, you can set the <code>publish</code> parameter to <code>true</code> in the same action to publish a new <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>. This way, you can opt-in to strict versioning of your state machine.</p> <note> <p>Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.</p> </note> <note> <p>All <code>StartExecution</code> calls within a few seconds use the updated <code>definition</code> and <code>roleArn</code>. Executions started immediately after you call <code>UpdateStateMachine</code> may use the previous state machine <code>definition</code> and <code>roleArn</code>. </p> </note>'
---
> description: '<p>Updates an existing state machine by modifying its <code>definition</code>, <code>roleArn</code>, or <code>loggingConfiguration</code>. Running executions will continue to use the previous <code>definition</code> and <code>roleArn</code>. You must include at least one of <code>definition</code> or <code>roleArn</code> or you will receive a <code>MissingRequiredParameter</code> error.</p> <p>If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.</p> <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> <note> <p>All <code>StartExecution</code> calls within a few seconds will use the updated <code>definition</code> and <code>roleArn</code>. Executions started immediately after calling <code>UpdateStateMachine</code> may use the previous state machine <code>definition</code> and <code>roleArn</code>. </p> </note>'
1965,1976d1535
< description: ServiceQuotaExceededException
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ServiceQuotaExceededException'
< '488':
< description: ConflictException
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ConflictException'
< '489':
2004,2060d1562
< /#X-Amz-Target=AWSStepFunctions.UpdateStateMachineAlias:
< post:
< operationId: UpdateStateMachineAlias
< description: '<p>Updates the configuration of an existing state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> by modifying its <code>description</code> or <code>routingConfiguration</code>.</p> <p>You must specify at least one of the <code>description</code> or <code>routingConfiguration</code> parameters to update a state machine alias.</p> <note> <p> <code>UpdateStateMachineAlias</code> is an idempotent API. Step Functions bases the idempotency check on the <code>stateMachineAliasArn</code>, <code>description</code>, and <code>routingConfiguration</code> parameters. Requests with the same parameters return an idempotent response.</p> </note> <note> <p>This operation is eventually consistent. All <a>StartExecution</a> requests made within a few seconds use the latest alias configuration. Executions started immediately after calling <code>UpdateStateMachineAlias</code> may use the previous routing configuration.</p> </note> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateStateMachineAlias</a> </p> </li> <li> <p> <a>DescribeStateMachineAlias</a> </p> </li> <li> <p> <a>ListStateMachineAliases</a> </p> </li> <li> <p> <a>DeleteStateMachineAlias</a> </p> </li> </ul>'
< responses:
< '200':
< description: Success
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/UpdateStateMachineAliasOutput'
< '480':
< description: ValidationException
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ValidationException'
< '481':
< description: InvalidArn
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/InvalidArn'
< '482':
< description: ResourceNotFound
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ResourceNotFound'
< '483':
< description: ConflictException
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/ConflictException'
< requestBody:
< required: true
< content:
< application/json:
< schema:
< $ref: '#/components/schemas/UpdateStateMachineAliasInput'
< parameters:
< - name: X-Amz-Target
< in: header
< required: true
< schema:
< type: string
< enum:
< - AWSStepFunctions.UpdateStateMachineAlias
< parameters:
< - $ref: '#/components/parameters/X-Amz-Content-Sha256'
< - $ref: '#/components/parameters/X-Amz-Date'
< - $ref: '#/components/parameters/X-Amz-Algorithm'
< - $ref: '#/components/parameters/X-Amz-Credential'
< - $ref: '#/components/parameters/X-Amz-Security-Token'
< - $ref: '#/components/parameters/X-Amz-Signature'
< - $ref: '#/components/parameters/X-Amz-SignedHeaders'
2141,2143c1643,1662
< ActivityLimitExceeded: {}
< InvalidName: {}
< TooManyTags: {}
---
> ActivityLimitExceeded:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created.
> InvalidName:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: The provided name is not valid.
> TooManyTags:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> resourceName:
> $ref: '#/components/schemas/Arn'
> description: 'You''ve exceeded the number of tags allowed for a resource. See the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html"> Limits Topic</a> in the Step Functions Developer Guide.'
2158,2161d1676
< stateMachineVersionArn:
< allOf:
< - $ref: '#/components/schemas/Arn'
< - description: 'The Amazon Resource Name (ARN) that identifies the created state machine version. If you do not set the <code>publish</code> parameter to <code>true</code>, this field returns null value.'
2198,2216c1713
< publish:
< allOf:
< - $ref: '#/components/schemas/Publish'
< - description: Set to <code>true</code> to publish the first version of the state machine during creation. The default is <code>false</code>.
< versionDescription:
< allOf:
< - $ref: '#/components/schemas/VersionDescription'
< - description: 'Sets description about the state machine version. You can only set the description if the <code>publish</code> parameter is set to <code>true</code>. Otherwise, if you set <code>versionDescription</code>, but <code>publish</code> to <code>false</code>, this API action throws <code>ValidationException</code>.'
< InvalidArn: {}
< InvalidDefinition: {}
< InvalidLoggingConfiguration: {}
< InvalidTracingConfiguration: {}
< StateMachineAlreadyExists: {}
< StateMachineDeleting: {}
< StateMachineLimitExceeded: {}
< StateMachineTypeNotSupported: {}
< ValidationException: {}
< ConflictException: {}
< CreateStateMachineAliasOutput:
---
> InvalidArn:
2218,2220d1714
< required:
< - stateMachineAliasArn
< - creationDate
2222,2230c1716,1719
< stateMachineAliasArn:
< allOf:
< - $ref: '#/components/schemas/Arn'
< - description: The Amazon Resource Name (ARN) that identifies the created state machine alias.
< creationDate:
< allOf:
< - $ref: '#/components/schemas/Timestamp'
< - description: The date the state machine alias was created.
< CreateStateMachineAliasInput:
---
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: The provided Amazon Resource Name (ARN) is not valid.
> InvalidDefinition:
2232,2235d1720
< required:
< - name
< - routingConfiguration
< title: CreateStateMachineAliasInput
2237,2250c1722,1760
< description:
< allOf:
< - $ref: '#/components/schemas/AliasDescription'
< - description: A description for the state machine alias.
< name:
< allOf:
< - $ref: '#/components/schemas/CharacterRestrictedName'
< - description: '<p>The name of the state machine alias.</p> <p>To avoid conflict with version ARNs, don''t use an integer in the name of the alias.</p>'
< routingConfiguration:
< allOf:
< - $ref: '#/components/schemas/RoutingConfigurationList'
< - description: The routing configuration of a state machine alias. The routing configuration shifts execution traffic between two state machine versions. <code>routingConfiguration</code> contains an array of <code>RoutingConfig</code> 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 <code>RoutingConfig</code>.
< ResourceNotFound: {}
< ServiceQuotaExceededException: {}
---
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: The provided Amazon States Language definition is not valid.
> InvalidLoggingConfiguration:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: <p/>
> InvalidTracingConfiguration:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: 'Your <code>tracingConfiguration</code> key does not match, or <code>enabled</code> has not been set to <code>true</code> or <code>false</code>.'
> StateMachineAlreadyExists:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: A state machine with the same name but a different definition or role ARN already exists.
> StateMachineDeleting:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: The specified state machine is being deleted.
> StateMachineLimitExceeded:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: The maximum number of state machines has been reached. Existing state machines must be deleted before a new state machine can be created.
> StateMachineTypeNotSupported:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: <p/>
2277,2280c1787
< DeleteStateMachineAliasOutput:
< type: object
< properties: {}
< DeleteStateMachineAliasInput:
---
> ValidationException:
2282,2297d1788
< required:
< - stateMachineAliasArn
< title: DeleteStateMachineAliasInput
< properties:
< stateMachineAliasArn:
< allOf:
< - $ref: '#/components/schemas/Arn'
< - description: The Amazon Resource Name (ARN) of the state machine alias to delete.
< DeleteStateMachineVersionOutput:
< type: object
< properties: {}
< DeleteStateMachineVersionInput:
< type: object
< required:
< - stateMachineVersionArn
< title: DeleteStateMachineVersionInput
2299c1790,1792
< stateMachineVersionArn:
---
> message:
> $ref: '#/components/schemas/ErrorMessage'
> reason:
2301,2302c1794,1796
< - $ref: '#/components/schemas/LongArn'
< - description: The Amazon Resource Name (ARN) of the state machine version to delete.
---
> - $ref: '#/components/schemas/ValidationExceptionReason'
> - description: The input does not satisfy the constraints specified by an Amazon Web Services service.
> description: The input does not satisfy the constraints specified by an Amazon Web Services service.
2332c1826,1831
< ActivityDoesNotExist: {}
---
> ActivityDoesNotExist:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: The specified activity does not exist.
2364c1863
< - description: 'If the execution ended, the date the execution stopped.'
---
> - description: 'If the execution has already ended, the date the execution stopped.'
2393,2400d1891
< stateMachineVersionArn:
< allOf:
< - $ref: '#/components/schemas/Arn'
< - description: '<p>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, <code>stateMachineARN:1</code>.</p> <p>If you start an execution from a <code>StartExecution</code> request without specifying a state machine version or alias ARN, Step Functions returns a null value.</p>'
< stateMachineAliasArn:
< allOf:
< - $ref: '#/components/schemas/Arn'
< - description: '<p>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, <code>stateMachineARN:PROD</code>.</p> <p>If you start an execution from a <code>StartExecution</code> request with a state machine version ARN, this field will be null.</p>'
2411c1902,1907
< ExecutionDoesNotExist: {}
---
> ExecutionDoesNotExist:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: The specified execution does not exist.
2474a1971,1978
> ResourceNotFound:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> resourceName:
> $ref: '#/components/schemas/Arn'
> description: Could not find the referenced resource. Only state machine and activity ARNs are supported.
2488c1992
< - description: '<p>The Amazon Resource Name (ARN) that identifies the state machine.</p> <p>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, <code>stateMachineARN:1</code>.</p>'
---
> - description: The Amazon Resource Name (ARN) that identifies the state machine.
2512c2016
< - description: '<p>The date the state machine is created.</p> <p>For a state machine version, <code>creationDate</code> is the date the version was created.</p>'
---
> - description: The date the state machine is created.
2523,2530d2026
< revisionId:
< allOf:
< - $ref: '#/components/schemas/RevisionId'
< - description: '<p>The revision identifier for the state machine.</p> <p>Use the <code>revisionId</code> parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as <code>definition</code> and <code>roleArn</code>.</p>'
< description:
< allOf:
< - $ref: '#/components/schemas/VersionDescription'
< - description: The description of the state machine version.
2540,2542c2036,2037
< - description: '<p>The Amazon Resource Name (ARN) of the state machine for which you want the information.</p> <p>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, <code>stateMachineARN:1</code>.</p>'
< StateMachineDoesNotExist: {}
< DescribeStateMachineAliasOutput:
---
> - description: The Amazon Resource Name (ARN) of the state machine to describe.
> StateMachineDoesNotExist:
2545,2578c2040,2042
< stateMachineAliasArn:
< allOf:
< - $ref: '#/components/schemas/Arn'
< - description: The Amazon Resource Name (ARN) of the state machine alias.
< name:
< allOf:
< - $ref: '#/components/schemas/Name'
< - description: The name of the state machine alias.
< description:
< allOf:
< - $ref: '#/components/schemas/AliasDescription'
< - description: A description of the alias.
< routingConfiguration:
< allOf:
< - $ref: '#/components/schemas/RoutingConfigurationList'
< - description: The routing configuration of the alias.
< creationDate:
< allOf:
< - $ref: '#/components/schemas/Timestamp'
< - description: The date the state machine alias was created.
< updateDate:
< allOf:
< - $ref: '#/components/schemas/Timestamp'
< - description: '<p>The date the state machine alias was last updated.</p> <p>For a newly created state machine, this is the same as the creation date.</p>'
< DescribeStateMachineAliasInput:
< type: object
< required:
< - stateMachineAliasArn
< title: DescribeStateMachineAliasInput
< properties:
< stateMachineAliasArn:
< allOf:
< - $ref: '#/components/schemas/Arn'
< - description: The Amazon Resource Name (ARN) of the state machine alias.
---
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: The specified state machine does not exist.
2622,2625d2085
< revisionId:
< allOf:
< - $ref: '#/components/schemas/RevisionId'
< - description: '<p>The revision identifier for the state machine. The first revision ID when you create the state machine is null.</p> <p>Use the state machine <code>revisionId</code> 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 <code>definition</code> and <code>roleArn</code>.</p>'
2661c2121,2126
< ActivityWorkerLimitExceeded: {}
---
> ActivityWorkerLimitExceeded:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: The maximum number of workers concurrently polling for activity tasks has been reached.
2701c2166,2171
< InvalidToken: {}
---
> InvalidToken:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: The provided token is not valid.
2747c2217
< - description: '<p>The Amazon Resource Name (ARN) of the state machine whose executions is listed.</p> <p>You can specify either a <code>mapRunArn</code> or a <code>stateMachineArn</code>, but not both.</p> <p>You can also return a list of executions associated with a specific <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> or <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>, by specifying an alias ARN or a version ARN in the <code>stateMachineArn</code> parameter.</p>'
---
> - description: '<p>The Amazon Resource Name (ARN) of the state machine whose executions is listed.</p> <p>You can specify either a <code>mapRunArn</code> or a <code>stateMachineArn</code>, but not both.</p>'
2795,2856d2264
< ListStateMachineAliasesOutput:
< type: object
< required:
< - stateMachineAliases
< properties:
< stateMachineAliases:
< allOf:
< - $ref: '#/components/schemas/StateMachineAliasList'
< - description: Aliases for the state machine.
< nextToken:
< allOf:
< - $ref: '#/components/schemas/PageToken'
< - description: '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. 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.'
< ListStateMachineAliasesInput:
< type: object
< required:
< - stateMachineArn
< title: ListStateMachineAliasesInput
< properties:
< stateMachineArn:
< allOf:
< - $ref: '#/components/schemas/Arn'
< - description: '<p>The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.</p> <p>If you specify a state machine version ARN, this API returns a list of aliases for that version.</p>'
< nextToken:
< allOf:
< - $ref: '#/components/schemas/PageToken'
< - description: '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. 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.'
< maxResults:
< allOf:
< - $ref: '#/components/schemas/PageSize'
< - description: <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> 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.</p> <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
< ListStateMachineVersionsOutput:
< type: object
< required:
< - stateMachineVersions
< properties:
< stateMachineVersions:
< allOf:
< - $ref: '#/components/schemas/StateMachineVersionList'
< - description: Versions for the state machine.
< nextToken:
< allOf:
< - $ref: '#/components/schemas/PageToken'
< - description: '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. 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.'
< ListStateMachineVersionsInput:
< type: object
< required:
< - stateMachineArn
< title: ListStateMachineVersionsInput
< properties:
< stateMachineArn:
< allOf:
< - $ref: '#/components/schemas/Arn'
< - description: The Amazon Resource Name (ARN) of the state machine.
< nextToken:
< allOf:
< - $ref: '#/components/schemas/PageToken'
< - description: '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. 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.'
< maxResults:
< allOf:
< - $ref: '#/components/schemas/PageSize'
< - description: <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> 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.</p> <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
2897,2928d2304
< PublishStateMachineVersionOutput:
< type: object
< required:
< - creationDate
< - stateMachineVersionArn
< properties:
< creationDate:
< allOf:
< - $ref: '#/components/schemas/Timestamp'
< - description: The date the version was created.
< stateMachineVersionArn:
< allOf:
< - $ref: '#/components/schemas/Arn'
< - description: The Amazon Resource Name (ARN) (ARN) that identifies the state machine version.
< PublishStateMachineVersionInput:
< type: object
< required:
< - stateMachineArn
< title: PublishStateMachineVersionInput
< properties:
< stateMachineArn:
< allOf:
< - $ref: '#/components/schemas/Arn'
< - description: The Amazon Resource Name (ARN) of the state machine.
< revisionId:
< allOf:
< - $ref: '#/components/schemas/RevisionId'
< - description: '<p>Only publish the state machine version if the current state machine''s revision ID matches the specified ID.</p> <p>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 <code>ConflictException</code>.</p> <note> <p>To specify an initial revision ID for a state machine with no revision ID assigned, specify the string <code>INITIAL</code> for the <code>revisionId</code> parameter. For example, you can specify a <code>revisionID</code> of <code>INITIAL</code> when you create a state machine using the <a>CreateStateMachine</a> API action.</p> </note>'
< description:
< allOf:
< - $ref: '#/components/schemas/VersionDescription'
< - description: An optional description of the state machine version.
2950,2951c2326,2335
< TaskDoesNotExist: {}
< TaskTimedOut: {}
---
> TaskDoesNotExist:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> TaskTimedOut:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
2983c2367,2372
< InvalidOutput: {}
---
> InvalidOutput:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: The provided JSON output data is not valid.
3007c2396
< - description: '<p>The Amazon Resource Name (ARN) of the state machine to execute.</p> <p>The <code>stateMachineArn</code> parameter accepts one of the following inputs:</p> <ul> <li> <p> <b>An unqualified state machine ARN</b> – 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.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine></code> </p> <p>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.</p> </li> <li> <p> <b>A state machine version ARN</b> – 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. </p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10</code> </p> <p>Step Functions doesn''t associate executions that you start with a version ARN with any aliases that point to that version.</p> </li> <li> <p> <b>A state machine alias ARN</b> – 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 <code>PROD</code>.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD></code> </p> <p>Step Functions associates executions that you start with an alias ARN with that alias and the state machine version used for that execution.</p> </li> </ul>'
---
> - description: The Amazon Resource Name (ARN) of the state machine to execute.
3011c2400
< - description: '<p>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 <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions"> Limits Related to State Machine Executions</a> in the <i>Step Functions Developer Guide</i>.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>'
---
> - description: '<p>The 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 <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions"> Limits Related to State Machine Executions</a> in the <i>Step Functions Developer Guide</i>.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>'
3020,3022c2409,2426
< ExecutionLimitExceeded: {}
< ExecutionAlreadyExists: {}
< InvalidExecutionInput: {}
---
> ExecutionLimitExceeded:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.
> ExecutionAlreadyExists:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: <p>The execution has the same <code>name</code> as another execution (but a different <code>input</code>).</p> <note> <p>Executions with the same <code>name</code> and <code>input</code> are considered idempotent.</p> </note>
> InvalidExecutionInput:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: The provided JSON input data is not valid.
3202,3209d2605
< revisionId:
< allOf:
< - $ref: '#/components/schemas/RevisionId'
< - description: The revision identifier for the updated state machine.
< stateMachineVersionArn:
< allOf:
< - $ref: '#/components/schemas/Arn'
< - description: '<p>The Amazon Resource Name (ARN) of the published state machine version.</p> <p>If the <code>publish</code> parameter isn''t set to <code>true</code>, this field returns null.</p>'
3231c2627
< - description: Use the <code>LoggingConfiguration</code> data type to set CloudWatch Logs options.
---
> - description: The <code>LoggingConfiguration</code> data type is used to set CloudWatch Logs options.
3236,3245c2632
< publish:
< allOf:
< - $ref: '#/components/schemas/Publish'
< - description: 'Specifies whether the state machine version is published. The default is <code>false</code>. To publish a version after updating the state machine, set <code>publish</code> to <code>true</code>.'
< versionDescription:
< allOf:
< - $ref: '#/components/schemas/VersionDescription'
< - description: <p>An optional description of the state machine version to publish.</p> <p>You can only specify the <code>versionDescription</code> parameter if you've set <code>publish</code> to <code>true</code>.</p>
< MissingRequiredParameter: {}
< UpdateStateMachineAliasOutput:
---
> MissingRequiredParameter:
3247,3248d2633
< required:
< - updateDate
3250,3271c2635,2639
< updateDate:
< allOf:
< - $ref: '#/components/schemas/Timestamp'
< - description: The date and time the state machine alias was updated.
< UpdateStateMachineAliasInput:
< type: object
< required:
< - stateMachineAliasArn
< title: UpdateStateMachineAliasInput
< properties:
< stateMachineAliasArn:
< allOf:
< - $ref: '#/components/schemas/Arn'
< - description: The Amazon Resource Name (ARN) of the state machine alias.
< description:
< allOf:
< - $ref: '#/components/schemas/AliasDescription'
< - description: A description of the state machine alias.
< routingConfiguration:
< allOf:
< - $ref: '#/components/schemas/RoutingConfigurationList'
< - description: <p>The routing configuration of the state machine alias.</p> <p>An array of <code>RoutingConfig</code> objects that specifies up to two state machine versions that the alias starts executions for.</p>
---
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: Request is missing a required parameter. This error occurs if both <code>definition</code> and <code>roleArn</code> are not specified.
> ErrorMessage:
> type: string
3416,3419d2783
< AliasDescription:
< type: string
< maxLength: 256
< format: password
3438,3442d2801
< CharacterRestrictedName:
< type: string
< pattern: '^(?=.*[a-zA-Z_\-\.])[a-zA-Z0-9_\-\.]+$'
< minLength: 1
< maxLength: 80
3470,3475d2828
< RoutingConfigurationList:
< type: array
< items:
< $ref: '#/components/schemas/RoutingConfigurationListItem'
< minItems: 1
< maxItems: 2
3510,3519d2862
< Publish:
< type: boolean
< VersionDescription:
< type: string
< maxLength: 256
< format: password
< LongArn:
< type: string
< minLength: 1
< maxLength: 2000
3532a2876,2879
> LongArn:
> type: string
> minLength: 1
> maxLength: 2000
3643,3644d2989
< RevisionId:
< type: string
3694c3039
< - description: The Amazon Resource Name (ARN) of the state machine that ran the execution.
---
> - description: The Amazon Resource Name (ARN) of the executed state machine.
3719,3726d3063
< stateMachineVersionArn:
< allOf:
< - $ref: '#/components/schemas/Arn'
< - description: '<p>The Amazon Resource Name (ARN) of the state machine version associated with the execution.</p> <p>If the state machine execution was started with an unqualified ARN, it returns null.</p> <p>If the execution was started using a <code>stateMachineAliasArn</code>, both the <code>stateMachineAliasArn</code> and <code>stateMachineVersionArn</code> parameters contain the respective values.</p>'
< stateMachineAliasArn:
< allOf:
< - $ref: '#/components/schemas/Arn'
< - description: '<p>The Amazon Resource Name (ARN) of the state machine alias used to start an execution.</p> <p>If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.</p>'
3750,3757d3086
< stateMachineAliasArn:
< allOf:
< - $ref: '#/components/schemas/Arn'
< - description: The Amazon Resource Name (ARN) that identifies a state machine alias used for starting the state machine execution.
< stateMachineVersionArn:
< allOf:
< - $ref: '#/components/schemas/Arn'
< - description: The Amazon Resource Name (ARN) that identifies a state machine version used for starting the state machine execution.
4370,4377d3698
< StateMachineAliasList:
< type: array
< items:
< $ref: '#/components/schemas/StateMachineAliasListItem'
< StateMachineVersionList:
< type: array
< items:
< $ref: '#/components/schemas/StateMachineVersionListItem'
4433,4451d3753
< RoutingConfigurationListItem:
< type: object
< required:
< - stateMachineVersionArn
< - weight
< properties:
< stateMachineVersionArn:
< allOf:
< - $ref: '#/components/schemas/Arn'
< - description: '<p>The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.</p> <p>If you specify the ARN of a second version, it must belong to the same state machine as the first version.</p>'
< weight:
< allOf:
< - $ref: '#/components/schemas/VersionWeight'
< - description: 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.
< description: 'Contains details about the routing configuration of a state machine alias. In a routing configuration, you define an array of objects that specify up to two state machine versions. You also specify the percentage of traffic to be routed to each version.'
< VersionWeight:
< type: integer
< minimum: 0
< maximum: 100
4458,4472d3759
< StateMachineAliasListItem:
< type: object
< required:
< - stateMachineAliasArn
< - creationDate
< properties:
< stateMachineAliasArn:
< allOf:
< - $ref: '#/components/schemas/LongArn'
< - description: '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, <code>stateMachineARN:PROD</code>.'
< creationDate:
< allOf:
< - $ref: '#/components/schemas/Timestamp'
< - description: The creation date of a state machine alias.
< description: Contains details about a specific state machine alias.
4498,4512d3784
< StateMachineVersionListItem:
< type: object
< required:
< - stateMachineVersionArn
< - creationDate
< properties:
< stateMachineVersionArn:
< allOf:
< - $ref: '#/components/schemas/LongArn'
< - description: '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, <code>stateMachineARN:1</code>.'
< creationDate:
< allOf:
< - $ref: '#/components/schemas/Timestamp'
< - description: The creation date of a state machine version.
< description: Contains details about a specific state machine version.
4536a3809,3814
> ValidationExceptionReason:
> type: string
> enum:
> - API_DOES_NOT_SUPPORT_LABELED_ARNS
> - MISSING_REQUIRED_PARAMETER
> - CANNOT_UPDATE_COMPLETED_MAP_RUNfrom aws2openapi.
lmmx
commented on September 26, 2024
That does indeed seem to be the case: the latest release of botocore indeed has ConflictException. Perhaps we might expect the diff to be much smaller if we compare the latest release of the JS SDK to the latest release of the botocore SDK.
See: https://github.com/boto/botocore/blob/develop/botocore/data/stepfunctions/2016-11-23/service-2.json
cd boto-js/apis
wget https://raw.githubusercontent.com/boto/botocore/develop/botocore/data/stepfunctions/2016-11-23/service-2.json -O states-2016-11-23.normal.json
wget https://raw.githubusercontent.com/boto/botocore/develop/botocore/data/stepfunctions/2016-11-23/examples-1.json -O states-2016-11-23.examples.json
wget https://raw.githubusercontent.com/boto/botocore/develop/botocore/data/stepfunctions/2016-11-23/paginators-1.json -O states-2016-11-23.paginators.json(Then re-run the CI workflow)
This resulted in a file identical to the one before, indicating that there was no change reflected from the change in the source... we would expet for example that the boto-js/apis normal JSON edit to include ConflictException would have produced a definition of that name in the OpenAPI schema... Maybe something went wrong?
Oops forgot to comment out the CI workflow overwriting the files in boto-js/apis
On the plus side, this means that the git diff after running the CI workflow will indicate the exact changes that resulted from updating the boto3 definition from 1.29.90 to develop branch!
Fast-forward
schemas/botocore/states/2016-11-23/openapi.yaml | 956 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---------
1 file changed, 914 insertions(+), 42 deletions(-)
Click to show full diff:
171c171
< description: '<p>Creates a state machine. A state machine consists of a collection of states that can do work (<code>Task</code> states), determine to which states to transition next (<code>Choice</code> states), stop an execution with an error (<code>Fail</code> states), and so on. State machines are specified using a JSON-based, structured language. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a> in the Step Functions User Guide.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <note> <p> <code>CreateStateMachine</code> is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. <code>CreateStateMachine</code>''s idempotency check is based on the state machine <code>name</code>, <code>definition</code>, <code>type</code>, <code>LoggingConfiguration</code> and <code>TracingConfiguration</code>. If a following request has a different <code>roleArn</code> or <code>tags</code>, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, <code>roleArn</code> and <code>tags</code> will not be updated, even if they are different.</p> </note>'
---
> description: '<p>Creates a state machine. A state machine consists of a collection of states that can do work (<code>Task</code> states), determine to which states to transition next (<code>Choice</code> states), stop an execution with an error (<code>Fail</code> states), and so on. State machines are specified using a JSON-based, structured language. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a> in the Step Functions User Guide.</p> <p>If you set the <code>publish</code> parameter of this API action to <code>true</code>, it publishes version <code>1</code> as the first revision of the state machine.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <note> <p> <code>CreateStateMachine</code> is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. <code>CreateStateMachine</code>''s idempotency check is based on the state machine <code>name</code>, <code>definition</code>, <code>type</code>, <code>LoggingConfiguration</code>, and <code>TracingConfiguration</code>. The check is also based on the <code>publish</code> and <code>versionDescription</code> parameters. If a following request has a different <code>roleArn</code> or <code>tags</code>, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, <code>roleArn</code> and <code>tags</code> will not be updated, even if they are different.</p> </note>'
238a239,250
> '490':
> description: ValidationException
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ValidationException'
> '491':
> description: ConflictException
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ConflictException'
260a273,347
> /#X-Amz-Target=AWSStepFunctions.CreateStateMachineAlias:
> post:
> operationId: CreateStateMachineAlias
> description: '<p>Creates an <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> for a state machine that points to one or two <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">versions</a> of the same state machine. You can set your application to call <a>StartExecution</a> with an alias and update the version the alias uses without changing the client''s code.</p> <p>You can also map an alias to split <a>StartExecution</a> requests between two versions of a state machine. To do this, add a second <code>RoutingConfig</code> object in the <code>routingConfiguration</code> parameter. You must also specify the percentage of execution run requests each version should receive in both <code>RoutingConfig</code> objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify.</p> <p>To create an alias that points to a single version, specify a single <code>RoutingConfig</code> object with a <code>weight</code> set to 100.</p> <p>You can create up to 100 aliases for each state machine. You must delete unused aliases using the <a>DeleteStateMachineAlias</a> API action.</p> <p> <code>CreateStateMachineAlias</code> is an idempotent API. Step Functions bases the idempotency check on the <code>stateMachineArn</code>, <code>description</code>, <code>name</code>, and <code>routingConfiguration</code> parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>DescribeStateMachineAlias</a> </p> </li> <li> <p> <a>ListStateMachineAliases</a> </p> </li> <li> <p> <a>UpdateStateMachineAlias</a> </p> </li> <li> <p> <a>DeleteStateMachineAlias</a> </p> </li> </ul>'
> responses:
> '200':
> description: Success
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/CreateStateMachineAliasOutput'
> '480':
> description: InvalidArn
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/InvalidArn'
> '481':
> description: InvalidName
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/InvalidName'
> '482':
> description: ValidationException
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ValidationException'
> '483':
> description: StateMachineDeleting
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/StateMachineDeleting'
> '484':
> description: ResourceNotFound
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ResourceNotFound'
> '485':
> description: ConflictException
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ConflictException'
> '486':
> description: ServiceQuotaExceededException
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ServiceQuotaExceededException'
> requestBody:
> required: true
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/CreateStateMachineAliasInput'
> parameters:
> - name: X-Amz-Target
> in: header
> required: true
> schema:
> type: string
> enum:
> - AWSStepFunctions.CreateStateMachineAlias
> parameters:
> - $ref: '#/components/parameters/X-Amz-Content-Sha256'
> - $ref: '#/components/parameters/X-Amz-Date'
> - $ref: '#/components/parameters/X-Amz-Algorithm'
> - $ref: '#/components/parameters/X-Amz-Credential'
> - $ref: '#/components/parameters/X-Amz-Security-Token'
> - $ref: '#/components/parameters/X-Amz-Signature'
> - $ref: '#/components/parameters/X-Amz-SignedHeaders'
303c390
< description: '<p>Deletes a state machine. This is an asynchronous operation: It sets the state machine''s status to <code>DELETING</code> and begins the deletion process. </p> <p>If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.</p> <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> <note> <p>For <code>EXPRESS</code> state machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after <code>DeleteStateMachine</code> API is called.</p> </note>'
---
> description: '<p>Deletes a state machine. This is an asynchronous operation: It sets the state machine''s status to <code>DELETING</code> and begins the deletion process. </p> <p>A qualified state machine ARN can either refer to a <i>Distributed Map state</i> defined within a state machine, a version ARN, or an alias ARN.</p> <p>The following are some examples of qualified and unqualified state machine ARNs:</p> <ul> <li> <p>The following qualified state machine ARN refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in a state machine named <code>myStateMachine</code>.</p> <p> <code>arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel</code> </p> <note> <p>If you provide a qualified state machine ARN that refers to a <i>Distributed Map state</i>, the request fails with <code>ValidationException</code>.</p> </note> </li> <li> <p>The following unqualified state machine ARN refers to a state machine named <code>myStateMachine</code>.</p> <p> <code>arn:partition:states:region:account-id:stateMachine:myStateMachine</code> </p> </li> </ul> <p>This API action also deletes all <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">versions</a> and <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">aliases</a> associated with a state machine.</p> <note> <p>For <code>EXPRESS</code> state machines, the deletion happens eventually (usually in less than a minute). Running executions may emit logs after <code>DeleteStateMachine</code> API is called.</p> </note>'
344a432,539
> /#X-Amz-Target=AWSStepFunctions.DeleteStateMachineAlias:
> post:
> operationId: DeleteStateMachineAlias
> description: '<p>Deletes a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a>.</p> <p>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.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateStateMachineAlias</a> </p> </li> <li> <p> <a>DescribeStateMachineAlias</a> </p> </li> <li> <p> <a>ListStateMachineAliases</a> </p> </li> <li> <p> <a>UpdateStateMachineAlias</a> </p> </li> </ul>'
> responses:
> '200':
> description: Success
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/DeleteStateMachineAliasOutput'
> '480':
> description: ValidationException
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ValidationException'
> '481':
> description: InvalidArn
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/InvalidArn'
> '482':
> description: ResourceNotFound
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ResourceNotFound'
> '483':
> description: ConflictException
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ConflictException'
> requestBody:
> required: true
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/DeleteStateMachineAliasInput'
> parameters:
> - name: X-Amz-Target
> in: header
> required: true
> schema:
> type: string
> enum:
> - AWSStepFunctions.DeleteStateMachineAlias
> parameters:
> - $ref: '#/components/parameters/X-Amz-Content-Sha256'
> - $ref: '#/components/parameters/X-Amz-Date'
> - $ref: '#/components/parameters/X-Amz-Algorithm'
> - $ref: '#/components/parameters/X-Amz-Credential'
> - $ref: '#/components/parameters/X-Amz-Security-Token'
> - $ref: '#/components/parameters/X-Amz-Signature'
> - $ref: '#/components/parameters/X-Amz-SignedHeaders'
> /#X-Amz-Target=AWSStepFunctions.DeleteStateMachineVersion:
> post:
> operationId: DeleteStateMachineVersion
> description: '<p>Deletes a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>. After you delete a version, you can''t call <a>StartExecution</a> using that version''s ARN or use the version with a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a>.</p> <note> <p>Deleting a state machine version won''t terminate its in-progress executions.</p> </note> <note> <p>You can''t delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version.</p> </note> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>PublishStateMachineVersion</a> </p> </li> <li> <p> <a>ListStateMachineVersions</a> </p> </li> </ul>'
> responses:
> '200':
> description: Success
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/DeleteStateMachineVersionOutput'
> '480':
> description: ValidationException
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ValidationException'
> '481':
> description: InvalidArn
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/InvalidArn'
> '482':
> description: ConflictException
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ConflictException'
> requestBody:
> required: true
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/DeleteStateMachineVersionInput'
> parameters:
> - name: X-Amz-Target
> in: header
> required: true
> schema:
> type: string
> enum:
> - AWSStepFunctions.DeleteStateMachineVersion
> parameters:
> - $ref: '#/components/parameters/X-Amz-Content-Sha256'
> - $ref: '#/components/parameters/X-Amz-Date'
> - $ref: '#/components/parameters/X-Amz-Algorithm'
> - $ref: '#/components/parameters/X-Amz-Credential'
> - $ref: '#/components/parameters/X-Amz-Security-Token'
> - $ref: '#/components/parameters/X-Amz-Signature'
> - $ref: '#/components/parameters/X-Amz-SignedHeaders'
393c588
< description: '<p>Provides all 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 ARN if the execution was dispatched by a Map Run.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <p>This API action is not supported by <code>EXPRESS</code> state machine executions unless they were dispatched by a Map Run.</p>'
---
> description: '<p>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.</p> <p>If you specify a version or alias ARN when you call the <a>StartExecution</a> API action, <code>DescribeExecution</code> returns that ARN.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <p>Executions of an <code>EXPRESS</code> state machinearen''t supported by <code>DescribeExecution</code> unless a Map Run dispatched them.</p>'
483c678
< description: '<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> <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> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note>'
---
> description: '<p>Provides information about a state machine''s definition, its IAM role Amazon Resource Name (ARN), and configuration.</p> <p>A qualified state machine ARN can either refer to a <i>Distributed Map state</i> defined within a state machine, a version ARN, or an alias ARN.</p> <p>The following are some examples of qualified and unqualified state machine ARNs:</p> <ul> <li> <p>The following qualified state machine ARN refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in a state machine named <code>myStateMachine</code>.</p> <p> <code>arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel</code> </p> <note> <p>If you provide a qualified state machine ARN that refers to a <i>Distributed Map state</i>, the request fails with <code>ValidationException</code>.</p> </note> </li> <li> <p>The following qualified state machine ARN refers to an alias named <code>PROD</code>.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD></code> </p> <note> <p>If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.</p> </note> </li> <li> <p>The following unqualified state machine ARN refers to a state machine named <code>myStateMachine</code>.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine></code> </p> </li> </ul> <p>This API action returns the details for a state machine version if the <code>stateMachineArn</code> you specify is a state machine version ARN.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note>'
524a720,770
> /#X-Amz-Target=AWSStepFunctions.DescribeStateMachineAlias:
> post:
> operationId: DescribeStateMachineAlias
> description: '<p>Returns details about a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a>.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateStateMachineAlias</a> </p> </li> <li> <p> <a>ListStateMachineAliases</a> </p> </li> <li> <p> <a>UpdateStateMachineAlias</a> </p> </li> <li> <p> <a>DeleteStateMachineAlias</a> </p> </li> </ul>'
> responses:
> '200':
> description: Success
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/DescribeStateMachineAliasOutput'
> '480':
> description: ValidationException
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ValidationException'
> '481':
> description: InvalidArn
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/InvalidArn'
> '482':
> description: ResourceNotFound
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ResourceNotFound'
> requestBody:
> required: true
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/DescribeStateMachineAliasInput'
> parameters:
> - name: X-Amz-Target
> in: header
> required: true
> schema:
> type: string
> enum:
> - AWSStepFunctions.DescribeStateMachineAlias
> parameters:
> - $ref: '#/components/parameters/X-Amz-Content-Sha256'
> - $ref: '#/components/parameters/X-Amz-Date'
> - $ref: '#/components/parameters/X-Amz-Algorithm'
> - $ref: '#/components/parameters/X-Amz-Credential'
> - $ref: '#/components/parameters/X-Amz-Security-Token'
> - $ref: '#/components/parameters/X-Amz-Signature'
> - $ref: '#/components/parameters/X-Amz-SignedHeaders'
528c774
< description: '<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> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>'
---
> description: '<p>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.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>'
738c984
< description: '<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> <p>Results are sorted by time, with the most recent execution first.</p> <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. 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> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>'
---
> description: '<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> <p>You can also provide a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> ARN or <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a> ARN to list the executions associated with a specific alias or version.</p> <p>Results are sorted by time, with the most recent execution first.</p> <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. 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> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>'
878a1125,1238
> /#X-Amz-Target=AWSStepFunctions.ListStateMachineAliases:
> post:
> operationId: ListStateMachineAliases
> description: '<p>Lists <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">aliases</a> for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first. </p> <p>To list aliases that reference a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>, you can specify the version ARN in the <code>stateMachineArn</code> parameter.</p> <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. 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> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateStateMachineAlias</a> </p> </li> <li> <p> <a>DescribeStateMachineAlias</a> </p> </li> <li> <p> <a>UpdateStateMachineAlias</a> </p> </li> <li> <p> <a>DeleteStateMachineAlias</a> </p> </li> </ul>'
> responses:
> '200':
> description: Success
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ListStateMachineAliasesOutput'
> '480':
> description: InvalidArn
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/InvalidArn'
> '481':
> description: InvalidToken
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/InvalidToken'
> '482':
> description: ResourceNotFound
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ResourceNotFound'
> '483':
> description: StateMachineDoesNotExist
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/StateMachineDoesNotExist'
> '484':
> description: StateMachineDeleting
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/StateMachineDeleting'
> requestBody:
> required: true
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ListStateMachineAliasesInput'
> parameters:
> - name: X-Amz-Target
> in: header
> required: true
> schema:
> type: string
> enum:
> - AWSStepFunctions.ListStateMachineAliases
> parameters:
> - $ref: '#/components/parameters/X-Amz-Content-Sha256'
> - $ref: '#/components/parameters/X-Amz-Date'
> - $ref: '#/components/parameters/X-Amz-Algorithm'
> - $ref: '#/components/parameters/X-Amz-Credential'
> - $ref: '#/components/parameters/X-Amz-Security-Token'
> - $ref: '#/components/parameters/X-Amz-Signature'
> - $ref: '#/components/parameters/X-Amz-SignedHeaders'
> /#X-Amz-Target=AWSStepFunctions.ListStateMachineVersions:
> post:
> operationId: ListStateMachineVersions
> description: '<p>Lists <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">versions</a> for the specified state machine Amazon Resource Name (ARN).</p> <p>The results are sorted in descending order of the version creation time.</p> <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. 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> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>PublishStateMachineVersion</a> </p> </li> <li> <p> <a>DeleteStateMachineVersion</a> </p> </li> </ul>'
> responses:
> '200':
> description: Success
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ListStateMachineVersionsOutput'
> '480':
> description: ValidationException
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ValidationException'
> '481':
> description: InvalidArn
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/InvalidArn'
> '482':
> description: InvalidToken
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/InvalidToken'
> requestBody:
> required: true
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ListStateMachineVersionsInput'
> parameters:
> - name: X-Amz-Target
> in: header
> required: true
> schema:
> type: string
> enum:
> - AWSStepFunctions.ListStateMachineVersions
> parameters:
> - $ref: '#/components/parameters/X-Amz-Content-Sha256'
> - $ref: '#/components/parameters/X-Amz-Date'
> - $ref: '#/components/parameters/X-Amz-Algorithm'
> - $ref: '#/components/parameters/X-Amz-Credential'
> - $ref: '#/components/parameters/X-Amz-Security-Token'
> - $ref: '#/components/parameters/X-Amz-Signature'
> - $ref: '#/components/parameters/X-Amz-SignedHeaders'
974a1335,1403
> /#X-Amz-Target=AWSStepFunctions.PublishStateMachineVersion:
> post:
> operationId: PublishStateMachineVersion
> description: '<p>Creates a <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a> 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 <a>CreateStateMachineAlias</a>.</p> <p>You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the <a>DeleteStateMachineVersion</a> API action.</p> <p> <code>PublishStateMachineVersion</code> is an idempotent API. It doesn''t create a duplicate state machine version if it already exists for the current revision. Step Functions bases <code>PublishStateMachineVersion</code>''s idempotency check on the <code>stateMachineArn</code>, <code>name</code>, and <code>revisionId</code> parameters. Requests with the same parameters return a successful idempotent response. If you don''t specify a <code>revisionId</code>, Step Functions checks for a previously published version of the state machine''s current revision.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>DeleteStateMachineVersion</a> </p> </li> <li> <p> <a>ListStateMachineVersions</a> </p> </li> </ul>'
> responses:
> '200':
> description: Success
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/PublishStateMachineVersionOutput'
> '480':
> description: ValidationException
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ValidationException'
> '481':
> description: StateMachineDeleting
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/StateMachineDeleting'
> '482':
> description: StateMachineDoesNotExist
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/StateMachineDoesNotExist'
> '483':
> description: ServiceQuotaExceededException
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ServiceQuotaExceededException'
> '484':
> description: ConflictException
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ConflictException'
> '485':
> description: InvalidArn
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/InvalidArn'
> requestBody:
> required: true
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/PublishStateMachineVersionInput'
> parameters:
> - name: X-Amz-Target
> in: header
> required: true
> schema:
> type: string
> enum:
> - AWSStepFunctions.PublishStateMachineVersion
> parameters:
> - $ref: '#/components/parameters/X-Amz-Content-Sha256'
> - $ref: '#/components/parameters/X-Amz-Date'
> - $ref: '#/components/parameters/X-Amz-Algorithm'
> - $ref: '#/components/parameters/X-Amz-Credential'
> - $ref: '#/components/parameters/X-Amz-Security-Token'
> - $ref: '#/components/parameters/X-Amz-Signature'
> - $ref: '#/components/parameters/X-Amz-SignedHeaders'
1137c1566
< description: '<p>Starts a state machine execution. If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.</p> <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> <note> <p> <code>StartExecution</code> is idempotent for <code>STANDARD</code> workflows. For a <code>STANDARD</code> workflow, if <code>StartExecution</code> is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a <code>400 ExecutionAlreadyExists</code> error. Names can be reused after 90 days. </p> <p> <code>StartExecution</code> is not idempotent for <code>EXPRESS</code> workflows. </p> </note>'
---
> description: '<p>Starts a state machine execution.</p> <p>A qualified state machine ARN can either refer to a <i>Distributed Map state</i> defined within a state machine, a version ARN, or an alias ARN.</p> <p>The following are some examples of qualified and unqualified state machine ARNs:</p> <ul> <li> <p>The following qualified state machine ARN refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in a state machine named <code>myStateMachine</code>.</p> <p> <code>arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel</code> </p> <note> <p>If you provide a qualified state machine ARN that refers to a <i>Distributed Map state</i>, the request fails with <code>ValidationException</code>.</p> </note> </li> <li> <p>The following qualified state machine ARN refers to an alias named <code>PROD</code>.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD></code> </p> <note> <p>If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.</p> </note> </li> <li> <p>The following unqualified state machine ARN refers to a state machine named <code>myStateMachine</code>.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine></code> </p> </li> </ul> <p>If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution.</p> <p>To start executions of a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>, call <code>StartExecution</code> and provide the version ARN or the ARN of an <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> that points to the version.</p> <note> <p> <code>StartExecution</code> is idempotent for <code>STANDARD</code> workflows. For a <code>STANDARD</code> workflow, if you call <code>StartExecution</code> 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 <code>400 ExecutionAlreadyExists</code> error. You can reuse names after 90 days. </p> <p> <code>StartExecution</code> isn''t idempotent for <code>EXPRESS</code> workflows. </p> </note>'
1485c1914
< description: '<p>Updates an existing state machine by modifying its <code>definition</code>, <code>roleArn</code>, or <code>loggingConfiguration</code>. Running executions will continue to use the previous <code>definition</code> and <code>roleArn</code>. You must include at least one of <code>definition</code> or <code>roleArn</code> or you will receive a <code>MissingRequiredParameter</code> error.</p> <p>If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.</p> <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> <note> <p>All <code>StartExecution</code> calls within a few seconds will use the updated <code>definition</code> and <code>roleArn</code>. Executions started immediately after calling <code>UpdateStateMachine</code> may use the previous state machine <code>definition</code> and <code>roleArn</code>. </p> </note>'
---
> description: '<p>Updates an existing state machine by modifying its <code>definition</code>, <code>roleArn</code>, or <code>loggingConfiguration</code>. Running executions will continue to use the previous <code>definition</code> and <code>roleArn</code>. You must include at least one of <code>definition</code> or <code>roleArn</code> or you will receive a <code>MissingRequiredParameter</code> error.</p> <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> <p>A qualified state machine ARN can either refer to a <i>Distributed Map state</i> defined within a state machine, a version ARN, or an alias ARN.</p> <p>The following are some examples of qualified and unqualified state machine ARNs:</p> <ul> <li> <p>The following qualified state machine ARN refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in a state machine named <code>myStateMachine</code>.</p> <p> <code>arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel</code> </p> <note> <p>If you provide a qualified state machine ARN that refers to a <i>Distributed Map state</i>, the request fails with <code>ValidationException</code>.</p> </note> </li> <li> <p>The following qualified state machine ARN refers to an alias named <code>PROD</code>.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD></code> </p> <note> <p>If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.</p> </note> </li> <li> <p>The following unqualified state machine ARN refers to a state machine named <code>myStateMachine</code>.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine></code> </p> </li> </ul> <p>After you update your state machine, you can set the <code>publish</code> parameter to <code>true</code> in the same action to publish a new <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>. This way, you can opt-in to strict versioning of your state machine.</p> <note> <p>Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.</p> </note> <note> <p>All <code>StartExecution</code> calls within a few seconds use the updated <code>definition</code> and <code>roleArn</code>. Executions started immediately after you call <code>UpdateStateMachine</code> may use the previous state machine <code>definition</code> and <code>roleArn</code>. </p> </note>'
1535a1965,1976
> description: ServiceQuotaExceededException
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ServiceQuotaExceededException'
> '488':
> description: ConflictException
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ConflictException'
> '489':
1562a2004,2060
> /#X-Amz-Target=AWSStepFunctions.UpdateStateMachineAlias:
> post:
> operationId: UpdateStateMachineAlias
> description: '<p>Updates the configuration of an existing state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> by modifying its <code>description</code> or <code>routingConfiguration</code>.</p> <p>You must specify at least one of the <code>description</code> or <code>routingConfiguration</code> parameters to update a state machine alias.</p> <note> <p> <code>UpdateStateMachineAlias</code> is an idempotent API. Step Functions bases the idempotency check on the <code>stateMachineAliasArn</code>, <code>description</code>, and <code>routingConfiguration</code> parameters. Requests with the same parameters return an idempotent response.</p> </note> <note> <p>This operation is eventually consistent. All <a>StartExecution</a> requests made within a few seconds use the latest alias configuration. Executions started immediately after calling <code>UpdateStateMachineAlias</code> may use the previous routing configuration.</p> </note> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateStateMachineAlias</a> </p> </li> <li> <p> <a>DescribeStateMachineAlias</a> </p> </li> <li> <p> <a>ListStateMachineAliases</a> </p> </li> <li> <p> <a>DeleteStateMachineAlias</a> </p> </li> </ul>'
> responses:
> '200':
> description: Success
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/UpdateStateMachineAliasOutput'
> '480':
> description: ValidationException
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ValidationException'
> '481':
> description: InvalidArn
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/InvalidArn'
> '482':
> description: ResourceNotFound
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ResourceNotFound'
> '483':
> description: ConflictException
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/ConflictException'
> requestBody:
> required: true
> content:
> application/json:
> schema:
> $ref: '#/components/schemas/UpdateStateMachineAliasInput'
> parameters:
> - name: X-Amz-Target
> in: header
> required: true
> schema:
> type: string
> enum:
> - AWSStepFunctions.UpdateStateMachineAlias
> parameters:
> - $ref: '#/components/parameters/X-Amz-Content-Sha256'
> - $ref: '#/components/parameters/X-Amz-Date'
> - $ref: '#/components/parameters/X-Amz-Algorithm'
> - $ref: '#/components/parameters/X-Amz-Credential'
> - $ref: '#/components/parameters/X-Amz-Security-Token'
> - $ref: '#/components/parameters/X-Amz-Signature'
> - $ref: '#/components/parameters/X-Amz-SignedHeaders'
1676a2175,2178
> stateMachineVersionArn:
> allOf:
> - $ref: '#/components/schemas/Arn'
> - description: 'The Amazon Resource Name (ARN) that identifies the created state machine version. If you do not set the <code>publish</code> parameter to <code>true</code>, this field returns null value.'
1712a2215,2222
> publish:
> allOf:
> - $ref: '#/components/schemas/Publish'
> - description: Set to <code>true</code> to publish the first version of the state machine during creation. The default is <code>false</code>.
> versionDescription:
> allOf:
> - $ref: '#/components/schemas/VersionDescription'
> - description: 'Sets description about the state machine version. You can only set the description if the <code>publish</code> parameter is set to <code>true</code>. Otherwise, if you set <code>versionDescription</code>, but <code>publish</code> to <code>false</code>, this API action throws <code>ValidationException</code>.'
1760a2271,2333
> ValidationException:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> reason:
> allOf:
> - $ref: '#/components/schemas/ValidationExceptionReason'
> - description: The input does not satisfy the constraints specified by an Amazon Web Services service.
> description: The input does not satisfy the constraints specified by an Amazon Web Services service.
> ConflictException:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: '<p>Updating or deleting a resource can cause an inconsistent state. This error occurs when there''re concurrent requests for <a>DeleteStateMachineVersion</a>, <a>PublishStateMachineVersion</a>, or <a>UpdateStateMachine</a> with the <code>publish</code> parameter set to <code>true</code>.</p> <p>HTTP Status Code: 409</p>'
> CreateStateMachineAliasOutput:
> type: object
> required:
> - stateMachineAliasArn
> - creationDate
> properties:
> stateMachineAliasArn:
> allOf:
> - $ref: '#/components/schemas/Arn'
> - description: The Amazon Resource Name (ARN) that identifies the created state machine alias.
> creationDate:
> allOf:
> - $ref: '#/components/schemas/Timestamp'
> - description: The date the state machine alias was created.
> CreateStateMachineAliasInput:
> type: object
> required:
> - name
> - routingConfiguration
> title: CreateStateMachineAliasInput
> properties:
> description:
> allOf:
> - $ref: '#/components/schemas/AliasDescription'
> - description: A description for the state machine alias.
> name:
> allOf:
> - $ref: '#/components/schemas/CharacterRestrictedName'
> - description: '<p>The name of the state machine alias.</p> <p>To avoid conflict with version ARNs, don''t use an integer in the name of the alias.</p>'
> routingConfiguration:
> allOf:
> - $ref: '#/components/schemas/RoutingConfigurationList'
> - description: The routing configuration of a state machine alias. The routing configuration shifts execution traffic between two state machine versions. <code>routingConfiguration</code> contains an array of <code>RoutingConfig</code> 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 <code>RoutingConfig</code>.
> ResourceNotFound:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> resourceName:
> $ref: '#/components/schemas/Arn'
> description: Could not find the referenced resource.
> ServiceQuotaExceededException:
> type: object
> properties:
> message:
> $ref: '#/components/schemas/ErrorMessage'
> description: '<p>The request would cause a service quota to be exceeded.</p> <p>HTTP Status Code: 402</p>'
1787c2360
< ValidationException:
---
> DeleteStateMachineAliasOutput:
1788a2362,2367
> properties: {}
> DeleteStateMachineAliasInput:
> type: object
> required:
> - stateMachineAliasArn
> title: DeleteStateMachineAliasInput
1790,1792c2369
< message:
< $ref: '#/components/schemas/ErrorMessage'
< reason:
---
> stateMachineAliasArn:
1794,1796c2371,2385
< - $ref: '#/components/schemas/ValidationExceptionReason'
< - description: The input does not satisfy the constraints specified by an Amazon Web Services service.
< description: The input does not satisfy the constraints specified by an Amazon Web Services service.
---
> - $ref: '#/components/schemas/Arn'
> - description: The Amazon Resource Name (ARN) of the state machine alias to delete.
> DeleteStateMachineVersionOutput:
> type: object
> properties: {}
> DeleteStateMachineVersionInput:
> type: object
> required:
> - stateMachineVersionArn
> title: DeleteStateMachineVersionInput
> properties:
> stateMachineVersionArn:
> allOf:
> - $ref: '#/components/schemas/LongArn'
> - description: The Amazon Resource Name (ARN) of the state machine version to delete.
1863c2452
< - description: 'If the execution has already ended, the date the execution stopped.'
---
> - description: 'If the execution ended, the date the execution stopped.'
1891a2481,2488
> stateMachineVersionArn:
> allOf:
> - $ref: '#/components/schemas/Arn'
> - description: '<p>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, <code>stateMachineARN:1</code>.</p> <p>If you start an execution from a <code>StartExecution</code> request without specifying a state machine version or alias ARN, Step Functions returns a null value.</p>'
> stateMachineAliasArn:
> allOf:
> - $ref: '#/components/schemas/Arn'
> - description: '<p>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, <code>stateMachineARN:PROD</code>.</p> <p>If you start an execution from a <code>StartExecution</code> request with a state machine version ARN, this field will be null.</p>'
1971,1978d2567
< ResourceNotFound:
< type: object
< properties:
< message:
< $ref: '#/components/schemas/ErrorMessage'
< resourceName:
< $ref: '#/components/schemas/Arn'
< description: Could not find the referenced resource. Only state machine and activity ARNs are supported.
1992c2581
< - description: The Amazon Resource Name (ARN) that identifies the state machine.
---
> - description: '<p>The Amazon Resource Name (ARN) that identifies the state machine.</p> <p>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, <code>stateMachineARN:1</code>.</p>'
2016c2605
< - description: The date the state machine is created.
---
> - description: '<p>The date the state machine is created.</p> <p>For a state machine version, <code>creationDate</code> is the date the version was created.</p>'
2026a2616,2623
> revisionId:
> allOf:
> - $ref: '#/components/schemas/RevisionId'
> - description: '<p>The revision identifier for the state machine.</p> <p>Use the <code>revisionId</code> parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as <code>definition</code> and <code>roleArn</code>.</p>'
> description:
> allOf:
> - $ref: '#/components/schemas/VersionDescription'
> - description: The description of the state machine version.
2036c2633
< - description: The Amazon Resource Name (ARN) of the state machine to describe.
---
> - description: '<p>The Amazon Resource Name (ARN) of the state machine for which you want the information.</p> <p>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, <code>stateMachineARN:1</code>.</p>'
2042a2640,2676
> DescribeStateMachineAliasOutput:
> type: object
> properties:
> stateMachineAliasArn:
> allOf:
> - $ref: '#/components/schemas/Arn'
> - description: The Amazon Resource Name (ARN) of the state machine alias.
> name:
> allOf:
> - $ref: '#/components/schemas/Name'
> - description: The name of the state machine alias.
> description:
> allOf:
> - $ref: '#/components/schemas/AliasDescription'
> - description: A description of the alias.
> routingConfiguration:
> allOf:
> - $ref: '#/components/schemas/RoutingConfigurationList'
> - description: The routing configuration of the alias.
> creationDate:
> allOf:
> - $ref: '#/components/schemas/Timestamp'
> - description: The date the state machine alias was created.
> updateDate:
> allOf:
> - $ref: '#/components/schemas/Timestamp'
> - description: '<p>The date the state machine alias was last updated.</p> <p>For a newly created state machine, this is the same as the creation date.</p>'
> DescribeStateMachineAliasInput:
> type: object
> required:
> - stateMachineAliasArn
> title: DescribeStateMachineAliasInput
> properties:
> stateMachineAliasArn:
> allOf:
> - $ref: '#/components/schemas/Arn'
> - description: The Amazon Resource Name (ARN) of the state machine alias.
2085a2720,2723
> revisionId:
> allOf:
> - $ref: '#/components/schemas/RevisionId'
> - description: '<p>The revision identifier for the state machine. The first revision ID when you create the state machine is null.</p> <p>Use the state machine <code>revisionId</code> 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 <code>definition</code> and <code>roleArn</code>.</p>'
2217c2855
< - description: '<p>The Amazon Resource Name (ARN) of the state machine whose executions is listed.</p> <p>You can specify either a <code>mapRunArn</code> or a <code>stateMachineArn</code>, but not both.</p>'
---
> - description: '<p>The Amazon Resource Name (ARN) of the state machine whose executions is listed.</p> <p>You can specify either a <code>mapRunArn</code> or a <code>stateMachineArn</code>, but not both.</p> <p>You can also return a list of executions associated with a specific <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> or <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>, by specifying an alias ARN or a version ARN in the <code>stateMachineArn</code> parameter.</p>'
2264a2903,2964
> ListStateMachineAliasesOutput:
> type: object
> required:
> - stateMachineAliases
> properties:
> stateMachineAliases:
> allOf:
> - $ref: '#/components/schemas/StateMachineAliasList'
> - description: Aliases for the state machine.
> nextToken:
> allOf:
> - $ref: '#/components/schemas/PageToken'
> - description: '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. 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.'
> ListStateMachineAliasesInput:
> type: object
> required:
> - stateMachineArn
> title: ListStateMachineAliasesInput
> properties:
> stateMachineArn:
> allOf:
> - $ref: '#/components/schemas/Arn'
> - description: '<p>The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.</p> <p>If you specify a state machine version ARN, this API returns a list of aliases for that version.</p>'
> nextToken:
> allOf:
> - $ref: '#/components/schemas/PageToken'
> - description: '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. 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.'
> maxResults:
> allOf:
> - $ref: '#/components/schemas/PageSize'
> - description: <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> 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.</p> <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
> ListStateMachineVersionsOutput:
> type: object
> required:
> - stateMachineVersions
> properties:
> stateMachineVersions:
> allOf:
> - $ref: '#/components/schemas/StateMachineVersionList'
> - description: Versions for the state machine.
> nextToken:
> allOf:
> - $ref: '#/components/schemas/PageToken'
> - description: '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. 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.'
> ListStateMachineVersionsInput:
> type: object
> required:
> - stateMachineArn
> title: ListStateMachineVersionsInput
> properties:
> stateMachineArn:
> allOf:
> - $ref: '#/components/schemas/Arn'
> - description: The Amazon Resource Name (ARN) of the state machine.
> nextToken:
> allOf:
> - $ref: '#/components/schemas/PageToken'
> - description: '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. 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.'
> maxResults:
> allOf:
> - $ref: '#/components/schemas/PageSize'
> - description: <p>The maximum number of results that are returned per call. You can use <code>nextToken</code> 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.</p> <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>
2304a3005,3036
> PublishStateMachineVersionOutput:
> type: object
> required:
> - creationDate
> - stateMachineVersionArn
> properties:
> creationDate:
> allOf:
> - $ref: '#/components/schemas/Timestamp'
> - description: The date the version was created.
> stateMachineVersionArn:
> allOf:
> - $ref: '#/components/schemas/Arn'
> - description: The Amazon Resource Name (ARN) (ARN) that identifies the state machine version.
> PublishStateMachineVersionInput:
> type: object
> required:
> - stateMachineArn
> title: PublishStateMachineVersionInput
> properties:
> stateMachineArn:
> allOf:
> - $ref: '#/components/schemas/Arn'
> - description: The Amazon Resource Name (ARN) of the state machine.
> revisionId:
> allOf:
> - $ref: '#/components/schemas/RevisionId'
> - description: '<p>Only publish the state machine version if the current state machine''s revision ID matches the specified ID.</p> <p>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 <code>ConflictException</code>.</p> <note> <p>To specify an initial revision ID for a state machine with no revision ID assigned, specify the string <code>INITIAL</code> for the <code>revisionId</code> parameter. For example, you can specify a <code>revisionID</code> of <code>INITIAL</code> when you create a state machine using the <a>CreateStateMachine</a> API action.</p> </note>'
> description:
> allOf:
> - $ref: '#/components/schemas/VersionDescription'
> - description: An optional description of the state machine version.
2396c3128
< - description: The Amazon Resource Name (ARN) of the state machine to execute.
---
> - description: '<p>The Amazon Resource Name (ARN) of the state machine to execute.</p> <p>The <code>stateMachineArn</code> parameter accepts one of the following inputs:</p> <ul> <li> <p> <b>An unqualified state machine ARN</b> – 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.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine></code> </p> <p>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.</p> </li> <li> <p> <b>A state machine version ARN</b> – 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. </p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10</code> </p> <p>Step Functions doesn''t associate executions that you start with a version ARN with any aliases that point to that version.</p> </li> <li> <p> <b>A state machine alias ARN</b> – 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 <code>PROD</code>.</p> <p> <code>arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD></code> </p> <p>Step Functions associates executions that you start with an alias ARN with that alias and the state machine version used for that execution.</p> </li> </ul>'
2400c3132
< - description: '<p>The 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 <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions"> Limits Related to State Machine Executions</a> in the <i>Step Functions Developer Guide</i>.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>'
---
> - description: '<p>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 <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions"> Limits Related to State Machine Executions</a> in the <i>Step Functions Developer Guide</i>.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>" # % \ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>'
2605a3338,3345
> revisionId:
> allOf:
> - $ref: '#/components/schemas/RevisionId'
> - description: The revision identifier for the updated state machine.
> stateMachineVersionArn:
> allOf:
> - $ref: '#/components/schemas/Arn'
> - description: '<p>The Amazon Resource Name (ARN) of the published state machine version.</p> <p>If the <code>publish</code> parameter isn''t set to <code>true</code>, this field returns null.</p>'
2627c3367
< - description: The <code>LoggingConfiguration</code> data type is used to set CloudWatch Logs options.
---
> - description: Use the <code>LoggingConfiguration</code> data type to set CloudWatch Logs options.
2631a3372,3379
> publish:
> allOf:
> - $ref: '#/components/schemas/Publish'
> - description: 'Specifies whether the state machine version is published. The default is <code>false</code>. To publish a version after updating the state machine, set <code>publish</code> to <code>true</code>.'
> versionDescription:
> allOf:
> - $ref: '#/components/schemas/VersionDescription'
> - description: <p>An optional description of the state machine version to publish.</p> <p>You can only specify the <code>versionDescription</code> parameter if you've set <code>publish</code> to <code>true</code>.</p>
2637a3386,3412
> UpdateStateMachineAliasOutput:
> type: object
> required:
> - updateDate
> properties:
> updateDate:
> allOf:
> - $ref: '#/components/schemas/Timestamp'
> - description: The date and time the state machine alias was updated.
> UpdateStateMachineAliasInput:
> type: object
> required:
> - stateMachineAliasArn
> title: UpdateStateMachineAliasInput
> properties:
> stateMachineAliasArn:
> allOf:
> - $ref: '#/components/schemas/Arn'
> - description: The Amazon Resource Name (ARN) of the state machine alias.
> description:
> allOf:
> - $ref: '#/components/schemas/AliasDescription'
> - description: A description of the state machine alias.
> routingConfiguration:
> allOf:
> - $ref: '#/components/schemas/RoutingConfigurationList'
> - description: <p>The routing configuration of the state machine alias.</p> <p>An array of <code>RoutingConfig</code> objects that specifies up to two state machine versions that the alias starts executions for.</p>
2783a3559,3562
> AliasDescription:
> type: string
> maxLength: 256
> format: password
2801a3581,3585
> CharacterRestrictedName:
> type: string
> pattern: '^(?=.*[a-zA-Z_\-\.])[a-zA-Z0-9_\-\.]+$'
> minLength: 1
> maxLength: 80
2828a3613,3618
> RoutingConfigurationList:
> type: array
> items:
> $ref: '#/components/schemas/RoutingConfigurationListItem'
> minItems: 1
> maxItems: 2
2862a3653,3662
> Publish:
> type: boolean
> VersionDescription:
> type: string
> maxLength: 256
> format: password
> LongArn:
> type: string
> minLength: 1
> maxLength: 2000
2876,2879d3675
< LongArn:
< type: string
< minLength: 1
< maxLength: 2000
2989a3786,3787
> RevisionId:
> type: string
3039c3837
< - description: The Amazon Resource Name (ARN) of the executed state machine.
---
> - description: The Amazon Resource Name (ARN) of the state machine that ran the execution.
3063a3862,3869
> stateMachineVersionArn:
> allOf:
> - $ref: '#/components/schemas/Arn'
> - description: '<p>The Amazon Resource Name (ARN) of the state machine version associated with the execution.</p> <p>If the state machine execution was started with an unqualified ARN, it returns null.</p> <p>If the execution was started using a <code>stateMachineAliasArn</code>, both the <code>stateMachineAliasArn</code> and <code>stateMachineVersionArn</code> parameters contain the respective values.</p>'
> stateMachineAliasArn:
> allOf:
> - $ref: '#/components/schemas/Arn'
> - description: '<p>The Amazon Resource Name (ARN) of the state machine alias used to start an execution.</p> <p>If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.</p>'
3086a3893,3900
> stateMachineAliasArn:
> allOf:
> - $ref: '#/components/schemas/Arn'
> - description: The Amazon Resource Name (ARN) that identifies a state machine alias used for starting the state machine execution.
> stateMachineVersionArn:
> allOf:
> - $ref: '#/components/schemas/Arn'
> - description: The Amazon Resource Name (ARN) that identifies a state machine version used for starting the state machine execution.
3698a4513,4520
> StateMachineAliasList:
> type: array
> items:
> $ref: '#/components/schemas/StateMachineAliasListItem'
> StateMachineVersionList:
> type: array
> items:
> $ref: '#/components/schemas/StateMachineVersionListItem'
3753a4576,4594
> RoutingConfigurationListItem:
> type: object
> required:
> - stateMachineVersionArn
> - weight
> properties:
> stateMachineVersionArn:
> allOf:
> - $ref: '#/components/schemas/Arn'
> - description: '<p>The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.</p> <p>If you specify the ARN of a second version, it must belong to the same state machine as the first version.</p>'
> weight:
> allOf:
> - $ref: '#/components/schemas/VersionWeight'
> - description: 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.
> description: 'Contains details about the routing configuration of a state machine alias. In a routing configuration, you define an array of objects that specify up to two state machine versions. You also specify the percentage of traffic to be routed to each version.'
> VersionWeight:
> type: integer
> minimum: 0
> maximum: 100
3759a4601,4615
> StateMachineAliasListItem:
> type: object
> required:
> - stateMachineAliasArn
> - creationDate
> properties:
> stateMachineAliasArn:
> allOf:
> - $ref: '#/components/schemas/LongArn'
> - description: '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, <code>stateMachineARN:PROD</code>.'
> creationDate:
> allOf:
> - $ref: '#/components/schemas/Timestamp'
> - description: The creation date of a state machine alias.
> description: Contains details about a specific state machine alias.
3784a4641,4655
> StateMachineVersionListItem:
> type: object
> required:
> - stateMachineVersionArn
> - creationDate
> properties:
> stateMachineVersionArn:
> allOf:
> - $ref: '#/components/schemas/LongArn'
> - description: '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, <code>stateMachineARN:1</code>.'
> creationDate:
> allOf:
> - $ref: '#/components/schemas/Timestamp'
> - description: The creation date of a state machine version.
> description: Contains details about a specific state machine version.
3814a4686
> - INVALID_ROUTING_CONFIGURATIONfrom aws2openapi.
lmmx
commented on September 26, 2024
The proof of concept worked
The logical next steps are to cover:
- All versions (all tags, not just
1.29.90tag ordevelopbranch) - All services (not just
stepfunctions)
from aws2openapi.
Related Issues (1)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from aws2openapi.