Describe State Machine For Execution

sfn_describe_state_machine_for_execution

R Documentation

Provides information about a state machine's definition, its execution role ARN, and configuration¶

Description¶

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.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

This API action is not supported by EXPRESS state machines.

Usage¶

sfn_describe_state_machine_for_execution(executionArn, includedData)

Arguments¶

executionArn: [required] The Amazon Resource Name (ARN) of the execution you want state machine information for.
includedData: If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

Value¶

A list with the following syntax:

list(
  stateMachineArn = "string",
  name = "string",
  definition = "string",
  roleArn = "string",
  updateDate = as.POSIXct(
    "2015-01-01"
  ),
  loggingConfiguration = list(
    level = "ALL"|"ERROR"|"FATAL"|"OFF",
    includeExecutionData = TRUE|FALSE,
    destinations = list(
      list(
        cloudWatchLogsLogGroup = list(
          logGroupArn = "string"
        )
      )
    )
  ),
  tracingConfiguration = list(
    enabled = TRUE|FALSE
  ),
  mapRunArn = "string",
  label = "string",
  revisionId = "string",
  encryptionConfiguration = list(
    kmsKeyId = "string",
    kmsDataKeyReusePeriodSeconds = 123,
    type = "AWS_OWNED_KEY"|"CUSTOMER_MANAGED_KMS_KEY"
  )
)

Request syntax¶

svc$describe_state_machine_for_execution(
  executionArn = "string",
  includedData = "ALL_DATA"|"METADATA_ONLY"
)