SFN / Client / describe_state_machine_for_execution

describe_state_machine_for_execution

SFN.Client.describe_state_machine_for_execution(**kwargs)

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.

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_state_machine_for_execution(
    executionArn='string',
    includedData='ALL_DATA'|'METADATA_ONLY'
)

Parameters:

• executionArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the execution you want state machine information for.

• includedData (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'stateMachineArn': 'string',
    'name': 'string',
    'definition': 'string',
    'roleArn': 'string',
    'updateDate': datetime(2015, 1, 1),
    'loggingConfiguration': {
        'level': 'ALL'|'ERROR'|'FATAL'|'OFF',
        'includeExecutionData': True|False,
        'destinations': [
            {
                'cloudWatchLogsLogGroup': {
                    'logGroupArn': 'string'
                }
            },
        ]
    },
    'tracingConfiguration': {
        'enabled': True|False
    },
    'mapRunArn': 'string',
    'label': 'string',
    'revisionId': 'string',
    'encryptionConfiguration': {
        'kmsKeyId': 'string',
        'kmsDataKeyReusePeriodSeconds': 123,
        'type': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KMS_KEY'
    }
}

Response Structure

• (dict) –

  • stateMachineArn (string) –

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

  • name (string) –

    The name of the state machine associated with the execution.

  • definition (string) –

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

  • roleArn (string) –

    The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.

  • updateDate (datetime) –

    The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.

  • loggingConfiguration (dict) –

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

    • level (string) –

      Defines which category of execution history events are logged.

    • includeExecutionData (boolean) –

      Determines whether execution data is included in your log. When set to false, data is excluded.

    • destinations (list) –

      An array of objects that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to OFF.

      • (dict) –

        • cloudWatchLogsLogGroup (dict) –

          An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the CloudFormation User Guide.

          • logGroupArn (string) –

            The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*

  • tracingConfiguration (dict) –

    Selects whether X-Ray tracing is enabled.

    • enabled (boolean) –

      When set to true, X-Ray tracing is enabled.

  • mapRunArn (string) –

    The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

  • label (string) –

    A user-defined or an auto-generated string that identifies a Map state. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

  • revisionId (string) –

    The revision identifier for the state machine. The first revision ID when you create the state machine is null.

    Use the state machine revisionId 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 definition and roleArn.

  • encryptionConfiguration (dict) –

    Settings to configure server-side encryption.

    • kmsKeyId (string) –

      An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

    • kmsDataKeyReusePeriodSeconds (integer) –

      Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys.

    • type (string) –

      Encryption type

Exceptions

• SFN.Client.exceptions.ExecutionDoesNotExist

• SFN.Client.exceptions.InvalidArn

• SFN.Client.exceptions.KmsAccessDeniedException

• SFN.Client.exceptions.KmsInvalidStateException

• SFN.Client.exceptions.KmsThrottlingException