Skip to content

PublishStateMachineVersionInput

Source code in docs_src/capo_sfn/types/publish_state_machine_version_input.py 
15
16
17
18
19
20
21
class PublishStateMachineVersionInput(TypedDict, closed=True):
    state_machine_arn: "capo_sfn.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the state machine.</p>"""
    revision_id: NotRequired["capo_sfn.types.revision_id.RevisionId"]
    """<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: NotRequired["capo_sfn.types.version_description.VersionDescription"]
    """<p>An optional description of the state machine version.</p>"""

description instance-attribute 

description: NotRequired[VersionDescription]

An optional description of the state machine version.

revision_id instance-attribute 

revision_id: NotRequired[RevisionId]

Only publish the state machine version if the current state machine's revision ID matches the specified ID.

Use this option to avoid publishing a version if the state machine changed since you last updated it. If the specified revision ID doesn't match the state machine's current revision ID, the API returns ConflictException.

To specify an initial revision ID for a state machine with no revision ID assigned, specify the string INITIAL for the revisionId parameter. For example, you can specify a revisionID of INITIAL when you create a state machine using the CreateStateMachine API action.

state_machine_arn instance-attribute 

state_machine_arn: Arn

The Amazon Resource Name (ARN) of the state machine.