paws.application.integration (version 0.1.11)

sfn_update_state_machine: Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration

Description

Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.

All start_execution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling update_state_machine may use the previous state machine definition and roleArn.

Usage

sfn_update_state_machine(stateMachineArn, definition, roleArn,
  loggingConfiguration, tracingConfiguration)

Arguments

stateMachineArn

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

definition

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

roleArn

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

loggingConfiguration

The LoggingConfiguration data type is used to set CloudWatch Logs options.

tracingConfiguration

Selects whether AWS X-Ray tracing is enabled.

Value

A list with the following syntax:

list(
  updateDate = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$update_state_machine(
  stateMachineArn = "string",
  definition = "string",
  roleArn = "string",
  loggingConfiguration = list(
    level = "ALL"|"ERROR"|"FATAL"|"OFF",
    includeExecutionData = TRUE|FALSE,
    destinations = list(
      list(
        cloudWatchLogsLogGroup = list(
          logGroupArn = "string"
        )
      )
    )
  ),
  tracingConfiguration = list(
    enabled = TRUE|FALSE
  )
)