AWS Step Functions

{'loggingConfiguration': {'destinations': [{'cloudWatchLogsLogGroup': {'logGroupArn': 'string'}}],
                          'includeExecutionData': 'boolean',
                          'level': 'ALL | ERROR | FATAL | OFF'}}

Describes the state machine associated with a specific execution.

This API action is not supported by EXPRESS state machines.

See also: AWS API Documentation

Request Syntax

client.describe_state_machine_for_execution(
    executionArn='string'
)

type executionArn

string

param executionArn

[REQUIRED]

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

rtype

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'
                }
            },
        ]
    }
}

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 AWS 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 :*