Skip to content

UpdateStateMachineInput

Source code in docs_src/capo_sfn/types/update_state_machine_input.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class UpdateStateMachineInput(TypedDict, closed=True):
    state_machine_arn: "capo_sfn.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the state machine.</p>"""
    definition: NotRequired["capo_sfn.types.definition.Definition"]
    """<p>The Amazon States Language definition of the state machine. See <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a>.</p>"""
    role_arn: NotRequired["capo_sfn.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the IAM role of the state machine.</p>"""
    logging_configuration: NotRequired[
        "capo_sfn.types.logging_configuration.LoggingConfiguration"
    ]
    """<p>Use the <code>LoggingConfiguration</code> data type to set CloudWatch Logs options.</p>"""
    tracing_configuration: NotRequired[
        "capo_sfn.types.tracing_configuration.TracingConfiguration"
    ]
    """<p>Selects whether X-Ray tracing is enabled.</p>"""
    publish: "capo_sfn.types.publish.Publish"
    """<p>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>.</p>"""
    version_description: NotRequired[
        "capo_sfn.types.version_description.VersionDescription"
    ]
    """<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>"""
    encryption_configuration: NotRequired[
        "capo_sfn.types.encryption_configuration.EncryptionConfiguration"
    ]
    """<p>Settings to configure server-side encryption. </p>"""

definition instance-attribute 

definition: NotRequired[Definition]

The Amazon States Language definition of the state machine. See Amazon States Language.

encryption_configuration instance-attribute 

encryption_configuration: NotRequired[EncryptionConfiguration]

Settings to configure server-side encryption.

logging_configuration instance-attribute 

logging_configuration: NotRequired[LoggingConfiguration]

Use the LoggingConfiguration data type to set CloudWatch Logs options.

publish instance-attribute 

publish: Publish

Specifies whether the state machine version is published. The default is false. To publish a version after updating the state machine, set publish to true.

role_arn instance-attribute 

role_arn: NotRequired[Arn]

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

state_machine_arn instance-attribute 

state_machine_arn: Arn

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

tracing_configuration instance-attribute 

tracing_configuration: NotRequired[TracingConfiguration]

Selects whether X-Ray tracing is enabled.

version_description instance-attribute 

version_description: NotRequired[VersionDescription]

An optional description of the state machine version to publish.

You can only specify the versionDescription parameter if you've set publish to true.